Sign in

v4

latestOpenAPI 3.1.02026-08-01139149645.9 KB
Custom Fields

List Custom Fields

List custom fields for the caller's organization.

get/api/v1/custom-fields

Query parameters

category'HRIS' | 'ATS' | 'LMS'

Filter by category, e.g. HRIS.

modelstring nullable

Filter by model slug, e.g. employee.

Example:employee

Filter by model slug, e.g. employee.

source'DASHBOARD' | 'API'

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

page_sizeinteger

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

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

cursorstring

The pagination cursor value.

The pagination cursor value.

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger required

Indicates the count of items in the response

Example response

{
  "cursor": "MDE4YjE4ZWYtYzk5Yy03YTg2LTk5NDYtN2I3YzlkNTQzM2U1",
  "page_size": 50,
  "items": [
    {
      "id": "018e586b-7d0b-7bc9-be65-a8fdbc82d734",
      "name": "guardian_mobile",
      "description": "Employee's guardian mobile number",
      "model": "employee"
    }
  ]
}