Skip to main content
GET
List Custom Fields

Authorizations

Authorization
string
header
default:<BINDBEE_API_KEY>
required

Your Bindbee API key, sent as Authorization: Bearer <BINDBEE_API_KEY>. Required on every request.

Query Parameters

category
enum<string> | null

Filter by category, e.g. HRIS.

Available options:
HRIS,
ATS,
LMS
Example:

"HRIS"

model
string | null

Filter by model slug, e.g. employee.

Maximum string length: 64
Pattern: ^[a-z][a-z0-9_-]*$
Example:

"employee"

source
enum<string> | null

Filter by origin: 'API' for fields created via the public API, 'DASHBOARD' for fields created from the Bindbee dashboard.

Available options:
DASHBOARD,
API
Example:

"API"

page_size
integer
default:50

Number of results to return per page. Maximum size is 200.

Required range: 1 <= x <= 200
cursor
string | null

The pagination cursor value.

Response

Successful Response

cursor
string | null
required

Cursor value to fetch next set of items

Example:

"MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1"

page_size
integer
required

The page size the request was served with (0 on an empty page). items can be shorter on the last page; cursor says whether another page exists.

Example:

50

items
CustomFieldExternal · object[]
required

List of items in the current response