Skip to main content
GET
List Custom Fields

Authorizations

Authorization
string
header
required

Authentication: You can generate a Personal Access Token from your settings.

Query Parameters

organization_id

Return only records matching organization ID. Identifier of the organization.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

query
string | null

Return only records matching custom field name or slug.

type

Return only records matching custom field type.

Available options:
text,
number,
date,
checkbox,
select
page
integer
default:1

Results page to return. The first page is used by default.

limit
integer
default:10

Records returned per page. Defaults to 10 and accepts up to 100.

sorting
enum<string>[] | null

Sort rules applied from left to right. Prefix any rule with - to reverse it into descending order.

Available options:
created_at,
-created_at,
slug,
-slug,
name,
-name,
type,
-type

Response

Request completed successfully

items
(CustomFieldText · object | CustomFieldNumber · object | CustomFieldDate · object | CustomFieldCheckbox · object | CustomFieldSelect · object)[]
required

Schema for a custom field of type text.

pagination
Pagination · object
required