API reference: OAuth2 authentication, access tokens and a description of every endpoint, with a built-in testing tool.
Authentication
-
API — Authentication and OAuth2 tokens
Overview of the API and of the two OAuth2 authentication flows available to get an access token.
Projects
-
API — projects/list endpoint
Documentation of the GET /api/projects/list endpoint: required scope, response structure, example call and built-in tester.
-
API — project/{id}/data endpoint
Documentation of the GET /api/project/{project_id}/data endpoint: status and aggregated rental data of a single project, with its access rights.
-
API — project/{id}/state endpoint (write)
Documentation of the PATCH /api/project/{project_id}/state endpoint: change the status of a project through the OAuth2 API.
Rentals
-
API — rentals/summary endpoint
Documentation of the GET /api/rentals/summary endpoint: required scope, response structure, example call and built-in tester.
Troubleshooting
-
API — Common errors
Table of the error codes returned by the API (401, 403, 404, 422) and how to fix them.