Skip to main content
POST
List Employees

Authorizations

Authorization
string
header
required

OAuth access token issued for the REST resource.

Body

application/json
cursor
object
limit
integer
default:100
Required range: 1 <= x <= 200
selectedCompanies
string[]

Exact Jointl company IDs; empty means every authorized company.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$
selectedEmployeeStatus
enum<string>[]

Defaults to active Employees. Pass an empty array to include every authorized Employee status.

Maximum array length: 100
Available options:
active,
left
selectedTags
string[]

Exact Jointl tag IDs; empty means every tag.

Maximum array length: 100
Required string length: 1 - 128
Pattern: ^[A-Za-z0-9_-]+$

Response

Operation completed.

data
object
required
requestId
string
required

Request correlation identifier.