Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

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.

• 422 application/json

  Business validation failed

  • EMPLOYEE_ACTIVE_WITHOUT_FIRST_LAST_NAME
  • EMPLOYEE_EMAIL_ALREADY_IN_USE
  • EMPLOYEE_EXTERNAL_ID_ALREADY_IN_USE
  • EMPLOYEE_OFFICE_RELATION_ROLE_MISMATCH
  • EMPLOYEE_ONLINE_PLANNING_NON_AGENT
  • EMPLOYEE_USERNAME_ALREADY_IN_USE
  • EMPLOYEE_UPDATE_STATUS_PENDING
  • FILE_URL_INVALID

  See Error codes

  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.

    • arguments object | null

      Additional properties are allowed.