v1
latestOpenAPI 3.0.02026-07-24310185.2 KBCollaborator
List Collaborators 🌍
Returns the collaborators of the company. This list is paginated. The output can be filtered given some fields.
Required scopes: collaborators:read
get/companies/{companyId}/collaborators
Path parameters
companyIdstring required
The id of the company
Query parameters
nextPageTokenstring
The encoded pagination token
maxResultsstring
Allows to define the maximum number of items to fetch at once. (Max: 50, Default: 10)
emailstring email
Filter by email. Important note: only emails in the collaborator's contracts are used for the search, so you can't filter by the login email.
Response
The collaborators of the company. Some collaborators may not have a contract.
Example response
{
"collaborators": [
{
"birthDate": "2000-03-25",
"terminationDate": "2022-03-25",
"contracts": [
{
"startDate": "2022-03-25",
"endDate": "2022-08-25"
}
]
}
]
}