Get a custom field by ID

GET/v2/custom_fields/{id}

Retrieves a single custom field by its unique identifier.

Returns the custom field object if found in your organization.

Response

Returns a custom field object with:

id - Unique field identifier
label - Field label displayed to users
type - Field type (text, number, select, multi-select, checkbox, date)
required - Whether the field is required
placeholder - Placeholder text (for text/number fields)
public - Whether the field value is publicly visible
internal - Whether the field is for internal use only
options - Array of options (for select/multi-select fields)

Errors

404 - Custom field not found in your organization

Path ParametersExpand Collapse

id: string

Custom field unique identifier

Header ParametersExpand Collapse

"Featurebase-Version": optional "2026-01-01.nova" or "2025-12-12.clover"

One of the following:

"2026-01-01.nova"

"2025-12-12.clover"

ReturnsExpand Collapse

CustomField object { id, label, object, 9 more }

id: string

Unique identifier

label: string

Field label displayed to users

object: "custom_field"

Object type identifier

type: "text" or "number" or "select" or 4 more

Field type

One of the following:

"text"

"number"

"select"

"multi-select"

"checkbox"

"date"

"file"

allowMultiple: optional boolean

Whether multiple files can be uploaded (file fields only)

createdAt: optional string

ISO timestamp when created

internal: optional boolean

Whether the field is for internal use only

options: optional array of object { id, label }

Options for select/multi-select fields

id: string

Option unique identifier

label: string

Option display label

placeholder: optional string

Placeholder text

public: optional boolean

Whether the field value is publicly visible

required: optional boolean

Whether the field is required

updatedAt: optional string

ISO timestamp when last updated

Get a custom field by ID

curl https://do.featurebase.app/v2/custom_fields/$ID \
    -H "Authorization: Bearer $FEATUREBASE_API_KEY"

{
  "id": "65d26304b2e65b1e1278170c",
  "label": "Your @username",
  "object": "custom_field",
  "type": "text",
  "allowMultiple": false,
  "createdAt": "2025-04-06T14:11:58.141Z",
  "internal": false,
  "options": [
    {
      "id": "65d26304b2e65b1e1278170d",
      "label": "High Priority"
    }
  ],
  "placeholder": "Enter your username",
  "public": false,
  "required": true,
  "updatedAt": "2025-04-06T14:11:58.141Z"
}

Returns Examples

{
  "id": "65d26304b2e65b1e1278170c",
  "label": "Your @username",
  "object": "custom_field",
  "type": "text",
  "allowMultiple": false,
  "createdAt": "2025-04-06T14:11:58.141Z",
  "internal": false,
  "options": [
    {
      "id": "65d26304b2e65b1e1278170d",
      "label": "High Priority"
    }
  ],
  "placeholder": "Enter your username",
  "public": false,
  "required": true,
  "updatedAt": "2025-04-06T14:11:58.141Z"
}