v1

latestOpenAPI 3.0.02026-07-14800227.2 KB
Employees

Return a list of employee accounts.

This endpoint returns a list with the account sections of the existing employees. The account section contains information such as email, external Id, language and activation status.

get/employees/accounts

Query parameters

emailstring
Example:john.doe@acme.com

The Kenjo email of the employee.

language'en' | 'de' | 'es'
Example:es

The employee language.

externalIdstring
Example:USER-123456

The external id of the employee.

isActiveboolean

The employee activation status.

Headers

Authorizationstring required
Example:Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2FwaS5rZW5qby5pbyIsInN1YiI6IjYwZjBhOTE2MjE0OTg3MjU2YmU5YzhmZiIsImF1ZCI6Imh0dHBzOi8vYXBpLmtlbmpvLmlvIiwiaWF0IjoxNjI2Mzg1MTE1LCJuYmYiOjE2MjYzODUxMTUsImV4cCI6MTYyNjU1NzkxNSwiYWNjZXNzVHlwZSI6IkFwaUFjY2VzcyIsInNfb3JnSWQiOiI2MGYwNGVhN2RmN2JhMjFlY2U0YmYzYzIifQ.cxG_7dIS-VbmDXdJuLkekoyuyCIzQG2fMcgc0nkfbWE8cihhcb5FnALbQkjU9b5-qVcEoMHZlSuUA-jMEBMMVQ

A valid bearer token.

Response

OK

Example response

{
  "data": [
    {
      "_id": "80a2db290da29e126a18789a",
      "email": "john@acme.io",
      "externalId": "00001",
      "language": "en",
      "isActive": true
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "email": "anna@acme.io",
      "externalId": "00003",
      "language": "en",
      "isActive": false
    },
    {
      "_id": "80a2db290da29e126a18789a",
      "email": "joaquin@acme.io",
      "externalId": "00009",
      "language": "en",
      "isActive": true
    }
  ]
}