API Reference

List workers

get
https://api.everee.com/integration/v1/workers

Clients can retrieve a list of worker data structures on demand.

Query Params
string

[repeatable] The 'externalWorkerId' you assigned to the worker, or Everee's generated 'workerId' if you don't use your own IDs.

string
enum

The "lifecycle status" of a worker. Begins in "ONBOARDING", moves to "ACTIVE" once onboarding is complete, and becomes "SEPARATED" after a worker's "end date" has passed. [repeatable]

Allowed:
int32
Defaults to 0
int32
Defaults to 20
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 7 months ago

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
text/plain
application/json

Updated 7 months ago