v1

latestOpenAPI 3.0.12026-07-144840447.2 KB

Retrieve a category

This endpoint returns a specific category.

ℹ️ This endpoint requires the following scope: categories:readonly

get/api/external/firm/v1/companies/{company_id}/categories/{id}

Path parameters

company_idinteger required

Example:1

Existing company identifier (id)

idstring required

Response

Returns a category

idinteger required

labelstring required

created_atstring date-time required

updated_atstring date-time required

archived_atstring date-time nullable required

The time the Category has been archived

analytical_codestring nullable required

Example response

{
  "id": 42,
  "label": "Alimentaire",
  "created_at": "2023-08-30T10:08:08.146343Z",
  "updated_at": "2023-08-30T10:08:08.146343Z",
  "archived_at": "2023-08-30T10:08:08.146343Z",
  "category_group": {
    "id": 348
  },
  "analytical_code": "CODE123"
}