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 "Signature-Input: example_string" \
  -H "Signature: example_string" \
  -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
Base URLstring

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

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.

header
Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

header
Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

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.

Example:
1146

Headers

Signature-Inputstring

What was signed and the signature parameters, in the RFC 9421 format. A credential with a public key must send it on every call, reads included, or the request is refused with 401. The signature covers the @method, @path, and @query components, and also content-digest when there is a body. created and alg are required, and created is valid for 300 seconds. The full format, with examples, is in Request Signing.

Signaturestring

The signature of the base defined by RFC 9421, in base64, between : and under the same label used in Signature-Input, for example sig=:SGVsbG8gd29ybGQ=:. It always goes together with Signature-Input.

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).