Get a custom field

Get one custom field definition.

GET https://api.centerfy.ai/webhooks/inbound/custom-fields/:id

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	Authenticates the request; or use Authorization: Bearer `<key>`.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	The custom field definition id.

Example

curl -X GET "https://api.centerfy.ai/webhooks/inbound/custom-fields/{id}" \
  -H "x-api-key: $CENTERFY_API_KEY"

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.customFields.get("<customFieldId>");
console.log(result);

centerfy customFields get <customFieldId>

MCP tool: centerfy_custom_fields_get (see MCP server)

Response

{
  "status": "success",
  "custom_field": {
    "id": "4b5c6d7e-8f90-4a1b-9c2d-3e4f5a6b7c8d",
    "field_name": "Plan tier",
    "field_key": "plan_tier",
    "field_type": "select",
    "options": [
      "Basic",
      "Pro",
      "Enterprise"
    ],
    "is_required": false,
    "sort_order": 0,
    "source": "platform",
    "external_key": null,
    "archived_at": null,
    "created_at": "2026-10-01T10:00:00.000Z",
    "updated_at": "2026-10-01T10:00:00.000Z"
  }
}

Errors

400 — if the id is not a valid UUID; 404 if the field is not in this sub-account.