API
Articles in this collection
- Core concepts
Our application programming interface (API) provides a way for other systems to interact with our platform. It enables the exchange of data and commands in a secure, reliable, and efficient manner. What is an API? An API is a set of rules and protoco
- Versioning
API versioning is a vital practice that allows us to roll out new features and improvements without breaking the existing functionalities of our application programming interface (API). This article explains the versioning approach used by our API an
- Authentication for API access
Most of our API endpoints require you to authenticate so that you can perform a variety of tasks. This article explains how to authenticate to access our API functionality. Basic authentication Our API supports basic authentication, which requires pr
- Rate limits
Our API uses rate limiting to ensure a fair usage policy across all users of our platform. This article explains our rate limit rules and how to manage them. What is rate limiting? Rate limiting is a technique for limiting network traffic. It sets a
- Understanding HTTP error codes
Our API uses standard HTTP status codes to indicate the success or failure of an API request. In general, codes in the 2xx range indicate success, codes in the 4xx range indicate an error that failed given the information provided and codes in the 5x
- Objects structure and data
In our API, an object is a representation of a resource, like a user, a team, or a project. This article explains the common structure of object responses in our API. Basic object structure Each object in our API would typically contain an identifier
- Using webhooks
Our API supports webhooks which allow you to get real-time web notifications about events that happen within our system. This article explains how to work with webhooks. What is a webhook? A webhook is a way for an app to provide other applications w