v1

latestOpenAPI 3.0.02026-07-26392662.9 KB
Custom Fields

List custom field definitions

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

Path parameters

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

The UUID of the workspace

Response

A list of custom field definitions

successboolean

Example response

{
  "success": true,
  "data": [
    {
      "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"
    }
  ]
}