People
List people
Returns the people on the organization's personnel list.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
Query Parameters
status?string
Value in
- "active"
- "offboarded"
search?string
Length
length <= 256limit?integer
Range
1 <= value <= 1000offset?integer
Range
0 <= value <= 9007199254740991Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/organizations/string/people"{ "items": [ { "id": "string", "organizationId": "string", "name": "string", "email": "string", "employmentType": "employee", "status": "active", "startDate": "string", "endDate": "string", "offboardedAt": null, "offboarding": { "accessRemovedOn": "string", "evidenceUrl": "string", "notRequiredReason": "string", "recordedByUserId": "string", "recordedAt": null }, "lastEmailedAt": null, "lastEmailFailedAt": null, "lastEmailFailure": "not_allowed", "policyCounts": { "owed": -9007199254740991, "acknowledged": -9007199254740991, "overdue": -9007199254740991 }, "groupIds": [ "string" ], "dateCreated": null, "dateUpdated": null } ], "total": 0}