Get Category

Returns one category. A deleted category is not found.

Required permission: category:view

Request

GET /v2/admin/categories/{category_id}

Parameters

Name	Type	In	Description
category_id	string	path	Required. Category id (24-character hex)

Headers

Name	Description
Authorization	Required. Bearer <access_token>

Example

curl --request GET \
  --url '{{baseUrl}}/v2/admin/categories/677ed6e3cc111aea14a3dfb8' \
  --header 'Authorization: Bearer <access_token>'

Response

{
  "id": "677ed6e3cc111aea14a3dfb8",
  "parent_id": "677ed6e3cc111aea14a3dfb7",
  "name": {
    "en": "Fixed Deposit",
    "tr": "Vadeli Mevduat"
  },
  "path": "1.4.115.116",
  "int_id": 116,
  "image_svg": null,
  "image_url": null,
  "is_leaf": true,
  "show_on_dashboard": false,
  "tokenization_rules": {
    "lock_salable_percentage_at_100": true,
    "rental_income_as_percentage": true,
    "sync_max_supply_with_total_value": true,
    "rental_payment_period_days": 30,
    "disallow_min_purchase_quantity": true,
    "disallow_max_purchase_quantity": true,
    "disallow_min_tokens_required_for_rental_income": true
  },
  "created_at": "2023-09-05T19:26:16.294Z"
}

Response Fields

Field	Type	Description
id	string	Category id
parent_id	string | null	Parent category id. null only for the root
name	object	Display name per locale
name.en	string	English name
name.tr	string	Turkish name
path	string	Materialized path: the int_ids from the root down to this category, joined with . (e.g. 1.4.115.116)
int_id	integer	Sequential numeric id, assigned on create. The root is 1
image_svg	string | null	Inline SVG icon (seeded categories only; not writable through the API)
image_url	string | null	URL of the category image (uploaded or supplied on create / update)
is_leaf	boolean	true when the category holds tokenized assets instead of sub-categories. Nothing can be created under a leaf
show_on_dashboard	boolean	Whether the category is shown on the dashboard
tokenization_rules	object	Present only on categories that carry tokenization rules: constraints a token created or updated in this category must meet. Read-only through the API
tokenization_rules.lock_salable_percentage_at_100	boolean	The token's salable percentage must be exactly 100
tokenization_rules.rental_income_as_percentage	boolean	The rental income amount is read as a percentage of the total value and must be between 1 and 100
tokenization_rules.sync_max_supply_with_total_value	boolean	The token's max_supply must match its total value
tokenization_rules.rental_payment_period_days	integer	When greater than 0, the rental payment period (in days) must equal this value
tokenization_rules.disallow_min_purchase_quantity	boolean	The minimum purchase quantity must be 0
tokenization_rules.disallow_max_purchase_quantity	boolean	The maximum purchase quantity must be 0
tokenization_rules.disallow_min_tokens_required_for_rental_income	boolean	The minimum token count required for rental income must be 0
created_at	string	Creation time (ISO 8601)

Errors

Status	Code	Description
400	10016	category_id is not a valid 24-character hex id
400	10001	Category not found or deleted (domain 4)

See Errors for the error format and common codes.