Custom Fields

Get a custom field by ID

Retrieves a single custom field by its unique identifier.

GET

/v2/custom_fields/{id}

curl --request GET \
  --url https://do.featurebase.app/v2/custom_fields/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Featurebase-Version: 2026-08-19.orbit'

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

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

Autorizaciones

Authorizationstringheaderobligatorio

API key as Bearer token. Use: Authorization: Bearer sk_...

Parámetros de ruta

idstringobligatorio

Custom field unique identifier

Ejemplo: 65d26304b2e65b1e1278170c

Encabezados

Featurebase-Versionenum<string>header

API version for this request. Defaults to your organization's configured API version if not specified.

Opciones disponibles: 2026-08-19.orbit, 2026-01-01.nova, 2025-12-12.clover

Ejemplo: 2026-08-19.orbit

Respuesta

Success

allowMultipleboolean

Whether multiple files can be uploaded (file fields only)

Ejemplo: false

createdAtstring

ISO timestamp when created

Ejemplo: 2025-04-06T14:11:58.141Z

idstringobligatorio

Unique identifier

Ejemplo: 65d26304b2e65b1e1278170c

internalboolean

Whether the field is for internal use only

Ejemplo: false

labelstringobligatorio

Field label displayed to users

Ejemplo: Your @username

objectenum<string>obligatorio

Object type identifier

Opciones disponibles: custom_field

Ejemplo: custom_field

optionsobject[]

Options for select/multi-select fields

Mostrar child attributes

placeholderstring

Placeholder text

Ejemplo: Enter your username

publicboolean

Whether the field value is publicly visible

Ejemplo: false

requiredboolean

Whether the field is required

Ejemplo: true

typeenum<string>obligatorio

Field type

Opciones disponibles: text, number, select, multi-select, checkbox, date, file

Ejemplo: text

updatedAtstring

ISO timestamp when last updated

Ejemplo: 2025-04-06T14:11:58.141Z

¿Aún necesitas ayuda? Pregunta al equipo