Key Concepts

Endpoint

The API is accessed via:


https://api.theorg.com/v1

Authentication

The API uses API keys to authenticate requests. You can view and manage your API keys via Settings → API .

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.

Rate Limiting

You can make 15 requests per second to a single endpoint of our API across API keys within an account. Accounts exceeding the rate will encounter 429 ("Too Many Requests") responses.

Credits and Usage

The API uses a universal credit system where API credits can be used accross endpoints.

All accounts have 100 API credits pr. month.

💡

Enterprise customers may have a custom monthly credit allowance or even unlimited credits subject to the rate limits and fair usage policy. Talk to sales for more info.

Various endpoints have different credit costs below is an overview of how credits apply:

API Endpoint	Description	Credit cost
/companies/chart	Returning full org charts for companies	10 pr. successful request
/companies/chart/managers	Returns the manager of a given report	1 pr. successful find
/positions	Returns rich information about positions	1 pr. returned row

💡

Requests can be replayed any ammount of times within 24 hours of the initial request at no additional cost.

Buying Extra Credits

Extra credits can be bought via Settings → API , by clicking Buy credits. All monthly credits are used before these extra credits are applied.

Credit costs are based on subscription level:

Subscription Tier	Pr. credit cost	Monthly Limit
Free	$0.05	10,000
Basic	$0.04	10,000
Premium	$0.03	10,000
Enterprise	$0.02	Unlimited

💡

Once purchased, extra credits never expire.