Customer properties overview

Customer properties are the workspace-level custom field catalog for customers.

The customer property object

Attributes

• created_at string (date-time)

  When the record was created.

• created_by_id string (uuid)

  The user who created the record.

• default_value array of string

  The default value.

• description string

  Free-form description.

• display_name string

  The display name.

• external_id string

  Your system's identifier for this record, for sync and import correlation.

• external_source string

  The system external_id came from, for example github or jira.

• id string (uuid)

  Unique identifier.

• is_active boolean

  Whether the record is active.

• is_multi boolean

  Whether is multi.

• is_required boolean

  Whether is required.

• logo_props string

  Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

• name string

  Display name.

• options array of string

  The options.

• property_type string

  The property type.

• relation_type string

  The relation type.

• settings string

  The settings.

• sort_order number

  Manual ordering weight. Lower sorts first.

• validation_rules string

  The validation rules.

Response200

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "default_value": ["example"],
  "description": "What this is for.",
  "display_name": "example",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_active": true,
  "is_multi": false,
  "is_required": false,
  "logo_props": null,
  "name": "Example name",
  "options": [null],
  "property_type": "TEXT",
  "relation_type": null,
  "settings": null,
  "sort_order": 65535,
  "validation_rules": null
}

Endpoints

Method	Path	Description
GET	/api/v2/workspaces/{slug}/customer-properties/	List customer properties
GET	/api/v2/workspaces/{slug}/customer-properties/{pk}/	Get a customer property
POST	/api/v2/workspaces/{slug}/customer-properties/	Create a customer property
PATCH	/api/v2/workspaces/{slug}/customer-properties/{pk}/	Update a customer property
DELETE	/api/v2/workspaces/{slug}/customer-properties/{pk}/	Delete a customer property

Response shaping

Every customer property read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.