Skip to main content
GET
List Employees

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
number
default:10

Items per page

Example:

10

page
number
default:1

Page number

Example:

1

status
enum<string>

Employee status

Available options:
PENDING,
ACTIVE,
SUSPENDED,
REVOKED
Example:

"ACTIVE"

filter
string

Generic filter that matches against

  • employeeCode
  • name
  • jobTitle
  • department
  • user.name
  • user.email
Example:

"Maria"

sortBy
enum<string>
default:createdAt

Field to sort by

Available options:
createdAt,
activatedAt
Example:

"createdAt"

sortOrder
enum<string>
default:desc

Sort order

Available options:
asc,
desc
Example:

"desc"

fields
string

Comma-separated list of fields to include in the response. Supports dot notation for nested projection (e.g. id,name,user.email,trips.route.id). Unknown fields are silently dropped.

Response

OK

List employees

data
object[]
required
meta
object
required