We previously informed you about important updates to our API, initially set to take effect on October 1st. However, we want to ensure a smooth transition for all users, so we are delaying the implementation of these updates by one week. The new effective date will be October 5th.
This brief delay will give us additional time to optimize the changes and ensure that your experience remains seamless.
OAuth Application and Personal Access Token Limits to enhance security.
Pagination Enhancements for better consistency.
Unified Entity Data and Listings for simplified integrations.
Rate Limiting Headers to better manage API usage.
New Filters and Endpoints to enable more granular data retrieval.
We apologize for any inconvenience this delay may cause and appreciate your understanding. If you have any questions or need assistance in preparing for these changes, please don’t hesitate to reach out to our support team.
We’re excited to inform you about some important updates to our API that will take effect October 1st. These changes are designed to improve the efficiency, scalability, and usability of our services for all users.
1. Rate Limit Changes
We are implementing new rate limits to balance performance and scalability. The default limits will be as follows:
Read operations: (GET, HEAD, OPTION) Up to 60 requests per minute.
Write operations: (POST, PUT, PATH, DELETE) Up to 30 requests per minute.
For customers with greater throughput requirements, temporarily we offer enhanced rate limits:
Read operations: (GET, HEAD, OPTION) Up to 360 requests per minute for high-volume usage.
Write operations: (POST, PUT, PATH, DELETE Up to 180 requests per minute for larger workloads.
If your integration needs exceed the standard limits, please reach out to discuss a tailored solution.
2. OAuth Application and Personal Access Token Limits
To enhance security and streamline API usage:
A maximum of 3 OAuth applications can be created per account.
A maximum of 2 personal access tokens will be allowed per user.
3. Pagination Enhancements
We’re updating our pagination logic to improve consistency and performance:
Default page size: 20 items.
Maximum page size: 100 items.
4. Unified Entity Data and Listings
In API v2, we have optimized our data model so that all relevant information can now be retrieved consistently across both listing and single entity endpoints. This was not always the case in API v1, and we believe this will simplify integration efforts and reduce the number of API calls needed.
5. Rate Limiting Headers
To help you better manage your API usage, we are introducing the following headers:
X-RateLimit-Limit: Shows your allowed rate limit.
X-RateLimit-Remaining: Displays how many requests you have left in the current window.
When you exceed the rate limit and receive a 429 Too Many Requests response, we will also include a Retry-After header, indicating when you can retry the request.
6. New Filters and Endpoints
We are introducing updated_after filters to allow customers to only fetch entities that have been updated since a specified time. This will be especially useful for those syncing data to external systems, such as warehouses.
Additionally, a new endpoint will be available to retrieve deleted entities, helping you maintain more accurate data in your applications.
We hope these improvements will enhance your experience with our API. Please review these changes and update your integrations accordingly. If you have any questions or need assistance with transitioning, feel free to reach out to our support team.
