v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Custom Fields

Lists custom fields definitions

Returns custom fields definitions

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	-	Manage custom fields (custom_field:write)

get/v1/custom-fields

Query parameters

pageinteger

Starts fetching records after the given page

page_sizeinteger

Number of items per page

Response

Success

Example response

{
  "current_page": 1,
  "custom_fields": [
    {
      "data_entry_access": "company_admin_only",
      "id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
      "metadata": {},
      "name": "Internal ID",
      "required": true,
      "type": "string",
      "visibility_scope": "everyone"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}