CategoriasListar Categorias

Listar Categorias

Retorna as categorias disponíveis para a empresa. Cada item pode incluir estabelecimentos vinculados e metadados de tipo (por exemplo, categoria personalizada ou padrão).

curl -X GET "https://api-sandbox.contasimples.com/categories/v1/categories" \
  -H "Content-Type: application/json" \
  -H "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -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": "Eletrônicos",
      "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
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN
header
Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

header
Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Token Bearer obtido via OAuth 2.0 Client Credentials. Formato: Bearer TOKEN

Headers

Signature-Inputstring

O que foi assinado e os parâmetros da assinatura, no formato da RFC 9421. Uma credencial com chave pública precisa enviar este header em todas as chamadas, inclusive as de leitura, ou a requisição é recusada com 401. A assinatura cobre os componentes @method, @path e @query, e também content-digest quando houver corpo. created e alg são obrigatórios, e o created vale por 300 segundos. O formato completo, com exemplos, está em Assinatura de Requisições.

Signaturestring

A assinatura da base definida pela RFC 9421, em base64, entre : e com o mesmo rótulo usado no Signature-Input, por exemplo sig=:SGVsbG8gd29ybGQ=:. Vai sempre junto com o Signature-Input.

Responses

itemsarray
Required

Categorias disponíveis para a empresa.