Retrieve a list of employee data fields

Retrieves all of the defined employee data fields configured in your PerformYard account, including field types, visibility, and editing permissions.

Query Params
string
^[0-9]+$

The number of records to be returned in a single API Request.

string
^[0-9]+$

Used to paginate through a list of records. Can be combined with limit. Increment the value by one to fetch subsequent pages (1 for the second page, 2 for the third, etc.).

string

Order in which to return the records. Allowed Values: asc(FIELD_NAME), desc(FIELD_NAME).

array | string

Filter the returned employee data fields by a specific data field type such as numeric, email, department, etc.

array | string

Filter the returned employee data fields by which permission level can view the data field. Allowed Values: all, self, manager, admin

array | string

Filter the returned employee data fields by which permission level can edit the data field. Allowed Values: all, self, manager, admin

array | string

Filter the returned employee data fields by the tags that were added to the data fields. Case sensitive.

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json