List custom field definition rows

Módulo Platform

GET/custom-field-definitionscustomFieldDefinitions.list

A custom field on a built-in resource. Returns a cursor page of custom field definition rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

Requiere la capacidad org.settings.read.
Alcances de OAuth: org.
Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

customFieldDefinitions.list: Parámetros de ruta y de consulta
Campo	Tipo	Obligatorio	Descripción
limit	Limit	No	Page size. Default 50, maximum 200.Restricciones: range 1 to 200
cursor	Cursor	No	Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fields	Fields	No	Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_](,[a-z_][a-z0-9_])*$
sort	Sort	No	Sort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_](,-?[a-z_][a-z0-9_])*$
filter	Filter	No	Filter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de CustomFieldDefinition

customFieldDefinitions.list: CustomFieldDefinition
Campo	Tipo	Obligatorio	Descripción
id	string (uuid)	Sí	Identifier of the custom field definition.
org_id	string (uuid)	Sí	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Sí	When the row was created.
created_by	string (uuid) \| null	Sí	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Sí	When the row was last updated.
updated_by	string (uuid) \| null	Sí	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
target_table	string	Sí	Table the field extends.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
field_key	string	Sí	Field key.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
label	string	Sí	Label.Restricciones: length 1 to 300
data_type	string	Sí	Data type.Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
required	boolean	Sí	True when forms require a value.
filterable	boolean	Sí	True when views filter on the field; it adds a partial index.
sort_order	integer	Sí	Position in forms.Restricciones: range 0 to any

{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "target_table": "app.vendors",
      "field_key": "union_signatory",
      "label": "Union Signatory",
      "data_type": "boolean",
      "required": false,
      "filterable": false,
      "sort_order": 1
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/custom-field-definitions" \
  -H "Authorization: Bearer $XOS_API_KEY"

for await (const row of xos.customFieldDefinitions.listAll()) {
  console.log(row);
}

for row in xos.custom_field_definitions.list_all():
    print(row)

xos custom-field-definitions list --all