Skip to navigation
API ReferenceCompany

List Custom Fields

Returns your company’s custom staff profile fields (extra fields such as “Shirt Size” or “Bus Route”) and each active staff member’s value for every one of them.

data has two keys:

  • fields: the names of all custom fields, oldest first. The full list is repeated on every page.
  • employees: one entry per staff member, ordered by salarybox_id, each with salarybox_id, name and values. values has one key for every name in fields; a field that was not filled in is null.

Pages and count are over employees, not fields. If your company has no custom fields, fields is empty and every values is {}.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

salarybox_idslist of stringsOptional

Repeatable. Limits the result to these staff members, for example salarybox_ids=SBK7Q2M9TX&salarybox_ids=SBK3H8D1LP.

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

messagestring
statusboolean
dataobject
countinteger
Total number of matching employees across all pages.
prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.