v1

latestOpenAPI 3.1.02026-07-242735131.1 MB

Custom Fields

List custom field value for an employment

Returns a list of custom field values for a given employment

Scopes

Category	Read only Scope	Write only Scope (read access implicit)
Manage employments (employments)	View custom field values (custom_field_value:read)	Manage custom field values (custom_field_value:write)

get/v1/employments/{employment_id}/custom-fields

Path parameters

employment_idstring required

Employment ID

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_field_values": [
    {
      "custom_field_id": "01c0e4d2-f41b-11ed-9d3f-cb3ecccebb58",
      "name": "Custom field",
      "type": "string",
      "value": "UXH34HG"
    }
  ],
  "total_count": 1,
  "total_pages": 1
}