Sign in

v1

latestOpenAPI 3.0.02026-07-26392662.9 KB
Custom Fields

Get a custom field definition

get/v1/workspaces/{workspaceUuid}/custom-fields/{key}

Path parameters

workspaceUuidstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

The UUID of the workspace

keystring required
Example:industry

The key of the custom field

Response

The custom field definition

identifierstring

The unique identifier of the field

keystring

The machine-readable key of the field

namestring

The human-readable name of the field

entity_typestring

The entity type the field belongs to

typestring

The data type of the field

descriptionstring nullable
groupstring

The group the field belongs to

is_visibleboolean
sourcestring

The source of the field

rulesobject[]
is_systemboolean
optionsobject[]

Example response

{
  "identifier": "industry",
  "key": "industry",
  "name": "Industry",
  "entity_type": "organisation",
  "type": "text",
  "description": "The primary industry of the company.",
  "group": "custom",
  "is_visible": true,
  "source": "manual"
}