Skip to main content
GET
List workforce members

Authorizations

X-API-Key
string
header
required

API key for authentication

Query Parameters

includeDeactivated
string

Pass true to include deactivated members

onboardAfter
string

ISO date — only members onboarded on or after it

onboardBefore
string

ISO date — only members onboarded on or before it

offboardAfter
string

ISO date — only members offboarded on or after it

offboardBefore
string

ISO date — only members offboarded on or before it

Response

People retrieved successfully

data
object[]
count
number

Total number of people

Example:

25

authType
enum<string>

How the request was authenticated

Available options:
api-key,
session
authenticatedUser
object