Sign in
latestOpenAPI 3.0.02026-08-1535120202.6 KB

f59881dadecd

Designations

Get a designation

Use this request to retrieve a single designation by its unique identifier. Returns designation details including account, name, code, and default status.

get/v1/designations/{id}

Path parameters

idstring required
Example:EXXXXXXX

Unique identifier of the designation, formatted as E[A-Z\d]{7}.

Query parameters

livemodeboolean
Example:true

Specifies whether the request is executed in live or test mode. Required for API keys created after 30th January 2026. Designations only exist in live mode — set this to true.

Response

On success, the API returns the designation object.

codestring nullable required

Designation code.

created_atstring required

Timestamp in ISO 8601 format, indicating when the designation was created in UTC.

idstring required

Unique designation identifier.

is_defaultboolean required

Indicates whether this is the default designation for the account.

namestring nullable required

Designation name.

updated_atstring required

Timestamp in ISO 8601 format, indicating when the designation was last updated in UTC.

Example response

{
  "account": {
    "code": "Code-1",
    "id": "AXXXXXXX",
    "name": "Example Account"
  },
  "code": "Code-1",
  "created_at": "2024-01-01T00:00:00.000Z",
  "id": "EXXXXXXX",
  "is_default": true,
  "name": "My Designation",
  "updated_at": "2024-01-31T00:00:00.000Z"
}