airfocus API
Welcome to the airfocus developer docs, where you’ll find technical information about our API.
If you have any questions or feedback about the API, please hollow guides in the Help section.
If you’re looking for general information about airfocus and its features, please visit our Help Center or ask the community.
API overview
API Schema
Our API schema is defined based on the OpenAPI 3.1 standard.
This website provides a Swagger UI interface (see Endpoints) where you can explore the API and try out the requests. Also, you can use another OpenAPI viewer (e.g. Postman or Intellij IDEA) to explore the API, by providing a URL to the JSON schema.
The raw JSON schema can be found here: https://developer.airfocus.com/openapi.json, and it always corresponds to the current server capabilities.
API Versioning
Each published version of OpenAPI schema corresponds to a specific version of the server. The server version can be found by requesting the GET /api/version endpoint. The schema version can be found:
- in the
info.versionfield of the openapi.json - in the top-left corner of the Swagger UI interface
It’s also possible to access schema in its older versions via https://raw.githubusercontent.com/airfocusio/airfocus-api/refs/tags/{version}/docs/openapi.json by replacing {version} with the desired version number.
In the Changelog section you can find the history of all schema versions with the list of changes and release dates.
Rate limits
Server reserves the right to limit the number of requests per minute for each authenticated client (with default 600 requests/minute). To identify whether there is a rate limit applied to the current client and what’s the limit - look for the next headers in the response:
X-RateLimit-Limit- the maximum number of requests that the client is permitted to make in a minuteX-RateLimit-Remaining- the number of requests remaining in the current rate limit windowX-RateLimit-Reset- the time (in UTC epoch seconds) at which the current rate limit window will reset