logo
CategoriasObter Categoria por ID

Obter Categoria por ID

Retorna os dados de uma categoria da empresa pelo identificador numérico, incluindo estabelecimentos vinculados e metadados de tipo. O escopo é sempre a empresa associada ao token.

curl -X GET "https://api-sandbox.contasimples.com/categories/v1/categories/1146" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN"
{
  "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/{id}
GET
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}
path
idinteger
Required

Identificador numérico da categoria.

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}

Path Parameters

idinteger
Required

Identificador numérico da categoria.

Responses

idinteger
Required

Identificador numérico da categoria.

createdAtstring
Required

Data e hora de criação da categoria (ISO 8601).

updatedAtstring
Required

Data e hora da última atualização da categoria (ISO 8601).

companyIdstring
Required

Identificador da empresa proprietária da categoria.

namestring
Required

Nome completo ou código contábil exibido da categoria.

establishmentsarray
Required

Lista de estabelecimentos associados a esta categoria, com vínculo e tipo.

typestring
Required

Metadados do tipo da categoria (por exemplo, CUSTOM ou DEFAULT).