Custom field tabs

Users can add new tabs to organize the custom fields in their employee or contractor profiles. Use the custom fields API to retrieve any employee, contractor organization, and contractor member custom field tabs.

Learn more about custom fields in the OnLocation Help Center.

List all custom field tabs

Retrieves a list of custom field tabs filtered by the parameter provided: employees, contractor organizations, or contractor members.

A comma separated list of tag:value search parameters, a colon separator performs an exact match, a percent separator performs a starts-with search and greater/less than search number/date ranges.

The endpoint is limited to a maximum of 1000 records.

Request
path Parameters
tab_type
required
string <string>

Custom field element type to filter by. Options: 'staff', 'sp-org', 'sp-member'.

Example: tab/sp-member
query Parameters
order
string <string>

Specifies an element to order by. To order in reverse order, prepend the element with '-'.

Example: order=id
limit
integer <int32>

Limits the amount of records to return

Example: limit=10
page
integer <int32>

Specifies which page of results to return, most effective when used together with the 'limit' parameter

Responses
200

List of custom tab elements

403

Access denied to this resource

404

Resource not found.

get/customfield/tab/{tab_type}
Request samples
curl -i -X GET \
  'https://api.whosonlocation.com/v1/customfield/tab/:tab_type?order=string&limit=0&page=0'
Response samples
application/json
application/json
application/xml
[
  • {
    }
]