Get an employee

GET /employees/{id}

Get an employee by its ID

Headers

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Responses

GET /employees/{id}
curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/employees/1234 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -H "Accept-Language: en *"
Response examples (200)
{
  "data": {
    "id": "123",
    "function": {
      "language": "en",
      "value": "Lorem ipsum"
    },
    "communicationEmail": "john.doe@pexip.com",
    "externalId": "ABCD1234",
    "username": "ABCD1234",
    "firstName": "John",
    "lastName": "Doe",
    "staticVideoUrl": "https://wwww.example.net/abc123",
    "phoneNumber": "+32412345678",
    "profilePictureUrl": "https://wwww.example.net/abc123",
    "email": "john.doe@pexip.com",
    "language": "en",
    "timeZone": "Europe/Brussels",
    "availableRoles": [
      "ADMIN"
    ],
    "status": "ACTIVE",
    "onlinePlanning": true,
    "officeRelations": [
      {
        "role": "AGENT",
        "office": {
          "id": "123"
        }
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z",
    "translations": {
      "function": [
        {
          "language": "en",
          "value": "Lorem ipsum"
        }
      ]
    }
  }
}
Response examples (404)
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}