Developers
Developers
Authentication & Limits
Most end-points require authentication by an API Access Token that can be generated using Service Accounts under the Settings section in Planhat. Once a token is created, it will appear once and last forever. Make sure to copy and store it securely once generated.
To disable a token simply disable the Service Account, pause it, or remove the API Access Token from Service Account, the latter will permanently invalidate the token.
API Access Tokens (API keys) are static tokens that belong to a Service Account, meaning that whatever operation performed with this token, will appear as a Service Account action. It is possible to limit the access scope for an API Access Token by configuring permissions on the Service Account level.
The Token should be placed in the Authorization header in ONE of the following ways:
Authorization: Bearer {{apiAccessToken}}or
Please note the colon after your token when using basic authentication.
Most end-points require authentication by an API Access Token that can be generated using Service Accounts under the Settings section in Planhat. Once a token is created, it will appear once and last forever. Make sure to copy and store it securely once generated.
To disable a token simply disable the Service Account, pause it, or remove the API Access Token from Service Account, the latter will permanently invalidate the token.
API Access Tokens (API keys) are static tokens that belong to a Service Account, meaning that whatever operation performed with this token, will appear as a Service Account action. It is possible to limit the access scope for an API Access Token by configuring permissions on the Service Account level.
The Token should be placed in the Authorization header in ONE of the following ways:
Authorization: Bearer {{apiAccessToken}}or
Please note the colon after your token when using basic authentication.
Most end-points require authentication by an API Access Token that can be generated using Service Accounts under the Settings section in Planhat. Once a token is created, it will appear once and last forever. Make sure to copy and store it securely once generated.
To disable a token simply disable the Service Account, pause it, or remove the API Access Token from Service Account, the latter will permanently invalidate the token.
API Access Tokens (API keys) are static tokens that belong to a Service Account, meaning that whatever operation performed with this token, will appear as a Service Account action. It is possible to limit the access scope for an API Access Token by configuring permissions on the Service Account level.
The Token should be placed in the Authorization header in ONE of the following ways:
Authorization: Bearer {{apiAccessToken}}or
Please note the colon after your token when using basic authentication.
Analytics Endpoint
The user tracking and metrics endpoints at analytics.planhat.com are not affected by these limits and can handle very high volumes of requests.
However, there is a hard limit of 32MB on the body of each post to Planhat, which typically corresponds to about 150,000 items.
Analytics Endpoint
The user tracking and metrics endpoints at analytics.planhat.com are not affected by these limits and can handle very high volumes of requests.
However, there is a hard limit of 32MB on the body of each post to Planhat, which typically corresponds to about 150,000 items.
Analytics Endpoint
The user tracking and metrics endpoints at analytics.planhat.com are not affected by these limits and can handle very high volumes of requests.
However, there is a hard limit of 32MB on the body of each post to Planhat, which typically corresponds to about 150,000 items.
Main API Endpoint
Planhat comes with a quota (soft limit) of 200 API calls per minute to our main API. The hard limit is 150 requests per second with bursts of up to 50 parallel requests.
For all bulk upsert operations, regardless of the model, there is an upper limit of 5,000 items per request.
When modifying or creating multiple records in one request (large bulk operations), it is advised to execute the requests sequentially instead of in parallel. This will aid in maintaining data integrity.
Main API Endpoint
Planhat comes with a quota (soft limit) of 200 API calls per minute to our main API. The hard limit is 150 requests per second with bursts of up to 50 parallel requests.
For all bulk upsert operations, regardless of the model, there is an upper limit of 5,000 items per request.
When modifying or creating multiple records in one request (large bulk operations), it is advised to execute the requests sequentially instead of in parallel. This will aid in maintaining data integrity.
Main API Endpoint
Planhat comes with a quota (soft limit) of 200 API calls per minute to our main API. The hard limit is 150 requests per second with bursts of up to 50 parallel requests.
For all bulk upsert operations, regardless of the model, there is an upper limit of 5,000 items per request.
When modifying or creating multiple records in one request (large bulk operations), it is advised to execute the requests sequentially instead of in parallel. This will aid in maintaining data integrity.