logo
CategoriesGet category by ID

Get category by ID

Returns a company category by numeric ID, including linked establishments and type metadata. Scope is always the company associated with the 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": "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/{id}
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}
path
idinteger
Required

Numeric category ID.

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}

Path Parameters

idinteger
Required

Numeric category ID.

Responses

idinteger
Required

Category numeric ID.

createdAtstring
Required

When the category was created (ISO 8601).

updatedAtstring
Required

When the category was updated (ISO 8601).

companyIdstring
Required

Owning company ID.

namestring
Required

Category display name or accounting code.

establishmentsarray
Required

Establishments linked to this category.

typestring
Required

Category type metadata (e.g. CUSTOM or DEFAULT).