BIbindbee
Custom Fields

List Custom Fields

Changed on

List custom fields for the caller's organization.

get/api/v1/custom-fields

Request

  • Base URL
    https://api.bindbee.dev (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

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

Filter by category, e.g. HRIS.

modelstring nullable

Filter by model slug, e.g. employee.

Example: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.

cursorstring nullable

The pagination cursor value.

Response

Successful Response

cursorstring nullable required

Cursor value to fetch next set of items

page_sizeinteger 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 response

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

Changes

  • a606b0cf18c9Revision changes
    • info

      query request parameter cursor list-of-types was widened by adding types null

    • info

      for the query request parameter cursor, the type was generalized from string to no type

  • eb3486b88e55Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status