Welcome to our API documentation. Our REST API provides unrestricted structured access to the worlds largest database of organizational charts. Currently the main entrypoint is though a company domain name.
The API uses API keys to authenticate requests. You can view and manage your API keys in your Subscription Center.
Authentication to the API is performed by passing the key in a header called X-API-KEY.
Your API keys carry many privileges, so be sure to keep them secure! Do not share your secret API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Get raw organizational data along with company level information that can be used for internal CRM enrichment, trend analysis, etc.
| domain required | string The domain name of the company. Example: theorg.com. This attribute is case-insensitive. |
object (Company) | |
object (ErrorResponse) |
{- "data": {
- "id": "6784cbe5-b023-4eeb-9200-232e405d8dfa",
- "name": "Starfleet",
- "domains": [
- "starfleet.com",
- "starfleet.org"
], - "positions": [
- {
- "id": 4300032,
- "slug": "james-t-kirk",
- "name": "James T. Kirk",
- "title": "Admiral, Fleet operations",
- "managerIds": [
- 4300033
], - "level": 2,
- "startDate": "2269-03-01"
}
]
}, - "error": {
- "code": 404,
- "reason": "Not Found"
}
}Embed org charts directly on your website or enrich your presentaions or CRM. This service searches companies by either name or a domain and returns embed urls wich can be added to iframes or shared. You must supply either "q", "domain" or "email".
| q | string A search query for a company name. Example: microsoft. This attribute is case-insensitive |
| domain | string A search parameter for a company website or email domain. Example: microsoft.com. This attribute is case-insensitive |
string A search parameter for a company email. Example: bill@microsoft.com. If provided the "embedUrl" might contain an additional pointer which highlights a position in the org chart. This attribute is case-insensitive |
Array of objects (CompanySearchResult) |
{- "companies": [
- {
- "id": "6784cbe5-b023-4eeb-9200-232e405d8dfa",
- "name": "Starfleet",
- "domains": [
- "starfleet.com",
- "starfleet.org"
],
}
]
}This service provides contact information for a list of position ids and can be used together with the Company Org Chart API.
| positionIds | Array of numbers <int32> [ items <int32 > ] List of position ids |
object (ContactsResult) | |
object (ErrorResponse) |
{- "positionIds": [
- 4300032
]
}{- "data": {
- "creditsUsed": 1,
- "results": [
- {
- "positionId": 4300032,
- "emails": [
- {
- "email": "kirk@starfleet.com",
- "emailType": "professional",
- "verification": "verified"
}
], - "phoneNumbers": [
- "+15555555555"
]
}
]
}, - "error": {
- "code": 404,
- "reason": "Not Found"
}
}