HTTP methods and schema

Methods

Method	Action
GET	Retrieves a resource or a list of resources
POST	Creates a resource
PUT	Updates an existing resource
DELETE	Removes a resource

Data format

The body of requests and responses is JSON. Requests with a body must send Content-Type: application/json.

Dates are returned in ISO 8601 format, always in UTC: YYYY-MM-DDTHH:MM:SSZ (e.g. 2026-10-13T14:30:00Z).

Single resource

A resource is returned as an object:

{
  "id": "NTox",
  "name": "Manutenção corretiva",
  "archived": false
}

Identifiers (id) are opaque strings: use them as received, without trying to interpret their content.

List of resources

Lists are returned in items, with the total number of records that match the filters in totalCount:

{
  "items": [
    { "id": "NTox", "name": "Instalação", "archived": false },
    { "id": "NjAx", "name": "Reparo", "archived": false }
  ],
  "totalCount": 2
}

See how to go through the pages in Pagination.