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

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data object Required

      Additional properties are NOT allowed.

      Hide data attributes Show data attributes object
      • id string Required

        Minimum length is 1.

      • function object | null Required

        Additional properties are NOT allowed.

        Hide function attributes Show function attributes object | null
        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required
      • communicationEmail string | null

        Minimum length is 1.

      • externalId string | null

        Minimum length is 1, maximum length is 255.

      • username string | null

        Minimum length is 1, maximum length is 255.

      • firstName string Required

        Minimum length is 1.

      • lastName string Required

        Minimum length is 1.

      • staticVideoUrl string(uri) | null

        Minimum length is 1.

      • phoneNumber string | null

        Minimum length is 1.

      • profilePictureUrl string(uri) | null

        Minimum length is 1.

      • email string Required

        Minimum length is 1.

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • timeZone string Required

        Minimum length is 1.

      • availableRoles array[string] Required

        Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.

      • status string Required

        Values are ACTIVE, PENDING, or SUSPENDED.

      • onlinePlanning boolean Required
      • officeRelations array[object] Required
        Hide officeRelations attributes Show officeRelations attributes object
        • role string Required

          Values are AGENT or OFFICE_MANAGER.

        • office object Required

          Additional properties are NOT allowed.

          Hide office attribute Show office attribute object
          • id string Required

            Minimum length is 1.

      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

      • deletedAt string(date-time) | null Required

        Minimum length is 1.

      • translations object Required

        Additional properties are NOT allowed.

        Hide translations attribute Show translations attribute object
        • function array[object]

          At least 0 elements.

          Hide function attributes Show function attributes object
          • language string Required

            Values are da, de, el, en, es, fr, ja, nl, no, or pl.

          • value string Required

            Minimum length is 1.

  • 404 application/json

    Resource not found

    Hide response attribute Show response attribute object
    • errors array[object] Required

      At least 1 element.

      Hide errors attributes Show errors attributes object
      • message string Required

        Minimum length is 1.

      • code string Required

        Minimum length is 1.

      • type string Required

        Minimum length is 1.

      • statusCode string Required

        Minimum length is 1.

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"
    }
  ]
}