The Official Board REST API provides a powerful and versatile suite of endpoints, offering seamless access to organizational and executive data for medium and large companies.
With our API, you can effortlessly integrate organizational charts, track executive movements, and retrieve detailed professional profiles, ensuring your applications remain efficient, reliable, and scalable.
By automating the insertion of up-to-date records into your data lake, our API ensures you always have access to the latest insights, keeping your information accurate and actionable, even as it evolves.
Overview
Below is an overview of our key endpoints, categorized into Companies, Movements, and Executives, to help you maximize the potential of our data and streamline your workflows.
Companies
Get the company org chart unique identifier - /company/search
Retrieve the unique identifier for a company's organizational chart, simplifying access to company-specific data.
Get the company org chart in text - /company/orgchart
Access the complete organizational chart of a company in a structured text format ready for seamless integration into your tools.
Get the company org chart in PDF - /export/orgchart-pdf (New!)
Download the company organizational chart in a PDF format, ideal for documentation or sharing with stakeholders.
Get the company org chart in Excel - /export/orgchart-media (New!)
Export the organizational chart in Excel format, enabling flexible data manipulation and analysis.
Movements
List Main Changes in Org Chart - /orgchart/recent-news (New!)Stay informed by extracting key changes within a company’s organizational chart over the past 12 months.
Report Modified Org Charts from Watchlist - /orgchart/watch
Track updates to companies on your watchlist that have undergone organizational changes in the last 6 months, allowing you to upload their latest charts with ease.
Executives
Search Executive by Name - /executive/search (New!)
Identify executives by name and retrieve their unique identifier along with their associated company details.
Find Executive by Email or LinkedIn - /executive/exact-search (New!)
Locate executives using their email or LinkedIn URL and access their unique identifier and company affiliation.
Retrieve Executive Biography Details - /executive/biography
Access detailed professional biographies of executives, including their career highlights, roles,and achievements.
List Executive’s Direct Colleagues - /executive/direct-colleagues (New!)
Gain insights into an executive’s direct colleagues, providing a clearer understanding of team structures and reporting lines.
Getting started with The Official Board REST API is simple.
Follow these steps to activate and test the API:
-
Register or Login
Sign up as a member or log in if you already have an account. -
Generate Your Security Token
Navigate to Rest API Preferences in your account to generate your security token. -
Select an API
Visit the REST API Specification and choose the API endpoint you wish to test. -
Test the API
Click Try Out, input your security token and request parameters. -
Execute and Review
Press Execute to send your request. The response code and data will be displayed, which you can view in a Json viewer.
• Our REST APIs are available with all membership plans, each offering a set number of credits:
- Starter Membership: Includes 100 credits.
- Premium Membership: Includes 500 credits.
- VIP Membership: Includes 5,000 credits.
• Each API request consumes 1 credit, and your remaining credits can be tracked under My Account >>> My Preferences.
• Please note that our APIs are designed for individual usage only.
For additional credits (starting at US $99 per 1,000 credits), personalized API solutions, or if you have any questions, feel free to contact us at [email protected].