List of Entity Categories

Returns the list of supported entity categories available in BitOK KYT.

HTTP Request

GET /v1/basics/entity-categories/

Query Parameters

Parameter	Type	Required	Description
page	integer	No	Page number within the paginated result set.
page_size	integer	No	Number of results to return per page.

If no parameters are provided, default pagination settings are used.

Response

A successful response returns HTTP 200 OK with a JSON body.

The result is an array of ENTITY_CATEGORY_INFO objects with the following fields:

Field	Type	Description
id	string	Unique identifier of the category (UUID).
code	String	The code of the category.
name	String	The name of the category.
description	string	Text description of the category.
color	string	Category color (HEX), used in user interfaces.
is_custom	boolean	true if the category was created by the user.
created_at	string	Creation timestamp in ISO 8601 format.

Example Response

{
  "page": 1,
  "page_size": 20,
  "total_pages": 3,
  "total_items": 43,
  "items": [
    {
      "id": "fb87bb12-4202-4a5d-af9a-fc8e4b110386",
      "name": "Child Abuse Material",
      "code": "child_abuse_material",
      "description": "Transactions linked to distribution of illegal materials. Highest risk.",
      "color": "#880E4F",
      "created_at": "2025-04-14T15:52:34.712080+03:00"
    }
  ]
}

Try It

GET/v1/basics/entity-categories/

API KEY ID

API KEY SECRET

Query params (JSON)

{ "page": 1, "page_size": 10 }

HTTP Request

Press "Send Request" to generate HTTP request.

HTTP …
{
  // Response will be shown here after the request.
}