Base URL
All endpoints of the API are served over HTTPS under the following base URL:Authentication
All API endpoints are authenticated using your API Key, sent as a Bearer token in theAuthorization header. See Authentication to learn how to get one.
Requests
- Request bodies are sent as JSON (
Content-Type: application/json), except for the endpoints that receive a file (POST /v1/apps/createandPOST /v1/apps/{appId}/upload), which usemultipart/form-data. - IDs (applications, teams, users) are 24 character hexadecimal strings.
- Some endpoints reject fields they do not know with a
400error, so only send the fields that are documented.
Responses
Successful responses are JSON, except forGET /v1/apps/{appId}/download, which returns a zip archive.
Errors
Every error is returned with the matching HTTP status and a JSON body with a singleerror field:
Error messages are meant for humans and can be in English or in Portuguese depending on the endpoint. Use the HTTP status, not the message, in your code.
Pagination
GET /v1/apps is paginated. It returns 10 applications per page by default and accepts the page and limit query parameters. The response includes a pagination object:
hasNextPage is true.