Retrieve a list of employees

get

https://api.talent.performyard.com/v1/employees

Retrieves a list of all employees in your organization, with the option to return either basic profile data or complete employee records.

Query Params

limit

string

^[0-9]+$

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

offset

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.).

sort

string

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

employeeStatus

string

enum

Filter the returned employees by a specific status.

Allowed:

permissionLevel

string

enum

Filter the returned employees by a specific PerformYard user role.

Allowed:

includeAllDataFields

boolean

Used to determine whether all data fields should be returned for each employee in the list.

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Default Response

500Default Response