Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Custom Field

customField.list

Lists all custom fields.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the hiringProcessMetadataRead permission.

post/customField.list

Request body

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

syncTokenstring nullable

A sync token to retrieve only custom fields updated since the last sync. Obtained from a previous list response.

limitinteger nullable

The maximum number of items to return. The maximum and default value is 100.

includeArchivedboolean nullable

If true, archived custom fields will be included in the response

Example request

{
  "cursor": "G8",
  "syncToken": "jYnEBmjzR",
  "limit": 25
}

Response

Responses from the customField.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "title": "Preferred Team",
      "description": "A description of the custom field",
      "objectType": "Application",
      "isArchived": false,
      "isPrivate": false,
      "fieldType": "String",
      "isRequired": false
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}