Skip to main content
GET
/
custom_attributes
/
{definition_id}
Get custom attribute definition
curl --request GET \
  --url https://api.zenskar.com/custom_attributes/{definition_id} \
  --header 'organisation: <api-key>' \
  --header 'x-api-key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "attribute_key_name": "<string>",
  "display_name": "<string>",
  "module": "customers",
  "data_type": "STRING",
  "business_entity_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_tag": true,
  "enum_choices": [
    "<string>"
  ],
  "default_value": "<unknown>",
  "is_required": true,
  "is_enabled": true,
  "sort_order": 123,
  "description": "<string>",
  "business_entity": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "is_default": true,
    "address": {
      "line1": "<string>",
      "line2": "<string>",
      "line3": "<string>",
      "city": "<string>",
      "state": "<string>",
      "zipCode": "<string>",
      "country": "<string>",
      "validation_status": "<string>"
    },
    "email": "<string>",
    "phone_number": "<string>",
    "tax_config": {},
    "logo_url": "<string>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs2.zenskar.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
default:<your-api-key>
required
​
organisation
string
header
default:<your-organisation-id>
required

Path Parameters

​
definition_id
string<uuid>
required

Response

Successful Response

​
id
string<uuid>
required
​
organisation_id
string<uuid>
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
attribute_key_name
string | null

A unique system identifier for the attribute (e.g., customer_tier, internal_notes).

Minimum string length: 1
​
display_name
string | null

A user-friendly label for the attribute shown in the UI.

Minimum string length: 1
​
module
enum<string> | null

The module this custom attribute belongs to (e.g., customer, products, contracts).

Available options:
customers,
products,
contracts,
plans,
invoices,
payments
​
data_type
enum<string> | null

The type of data the attribute will store.

Available options:
STRING,
INTEGER,
FLOAT,
BOOLEAN,
LIST_STRING,
ENUM,
JSON,
DATE
​
business_entity_id
string<uuid> | null

If populated, this definition is an entity-specific addition or override.

​
is_tag
boolean | null

If TRUE, this attribute is a Tag. Tags must have data_type = ENUM.

​
enum_choices
string[] | null

If data_type is ENUM, this stores the list of valid string choices.

​
default_value
any | null

An optional default value for the attribute. Must conform to data_type and be one of enum_choices if applicable.

​
is_required
boolean | null

Indicates if a value is mandatory for this attribute.

​
is_enabled
boolean | null

Whether the attribute definition is currently active.

​
sort_order
integer | null

Optional: for controlling display order in UIs.

​
description
string | null

Optional: further description or help text for the attribute.

​
business_entity
BusinessEntityResponseSchema · object

Business Entity Response Schema