logo
CategoriesList categories

List categories

Returns categories available to the company. Each item may include linked establishments and type metadata (e.g. custom or default).

curl -X GET "https://api-sandbox.contasimples.com/categories/v1/categories" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "items": [
    {
      "id": 1146,
      "createdAt": "2024-12-25T10:00:00Z",
      "updatedAt": "2024-12-25T10:00:00Z",
      "companyId": "7c61b3f6-7353-46aa-80ef-3e27d95150ab",
      "name": "Electronics",
      "establishments": [
        {
          "id": 16,
          "createdAt": "2024-12-25T10:00:00Z",
          "updatedAt": "2024-12-25T10:00:00Z",
          "name": "Amazon Prime Aluguel",
          "type": {
            "id": 1,
            "createdAt": "2024-12-25T10:00:00Z",
            "updatedAt": "2024-12-25T10:00:00Z",
            "type": "CUSTOM"
          },
          "establishmentCategoryId": 1039
        }
      ],
      "type": {
        "id": 1,
        "createdAt": "2024-12-25T10:00:00Z",
        "updatedAt": "2024-12-25T10:00:00Z",
        "type": "CUSTOM"
      }
    }
  ]
}
GET
/categories/v1/categories
GET
Bearer Token
Bearer Tokenstring
Required

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Bearer token from OAuth 2.0 client credentials. Format: Bearer {token}

Responses

itemsarray
Required

Categories available to the company.