Get Employees
Retrieves the list of active employees. The fields retrieved depend on the employee scopes that you have access to for your access token or API key. The only guarenteeed fields include id, personalEmail, and roleState.
Parameters
Parameter | Description |
---|---|
Limit | Sets a limit on the returned values. |
Offset | Offsets the returned values. |
Example Output
{
"value": [
{
"customFields": {
"Id": "string",
"required": true,
"title": "string",
"type": "TEXT"
},
"department": "string",
"employmentType": "CONTRACTOR",
"endDate": "string",
"firstName": "string",
"gender": "MALE",
"id": "string",
"identifiedGender": "MALE",
"lastName": "string",
"manager": "string",
"name": "string",
"roleState": "INIT",
"spokeId": "string",
"title": "string",
"workEmail": "string",
"workLocation": {
"city": "string",
"country": "string",
"state": "string",
"streetLine1": "string",
"streetLine2": "string",
"zip": "string"
}
}
]
}
Workflow Library Example
Get Employees with Rippling and Send Results Via Email