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.

Query parameters

• id array[string]

  ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• email array[string]

  Email(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• external-id array[string]

  External ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• available-role array[string]

  Available role(s) to be considered for filtering

  At least 1 element. Values are ADMIN, AGENT, CENTRAL_PLANNER, or OFFICE_MANAGER.

• username array[string]

  Username(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1.

• status array[string]

  Status(es) to be considered for filtering

  At least 1 element. Values are ACTIVE, PENDING, or SUSPENDED.

• offset string(positive-integer)

  Offset for the results to be returned

  Default value is 0.

• limit string(positive-integer)

  Limitation for the number of results to be returned

  Default value is 25.

• with-deleted boolean

  Includes deleted resources in the results

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data array[object] Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • function object | null Required
      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
      • Additional properties are NOT allowed
    • 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 | null

      Minimum length is 1.

    • lastName string | null

      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
        Hide office attributes Show office attributes object

        • id string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
    • 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.

    • Additional properties are NOT allowed
  • meta object Required
    Hide meta attributes Show meta attributes object

    • offset integer Required

      Minimum value is 0. Default value is 0.

    • limit integer Required

      Minimum value is 0. Default value is 25.

    • totalCount integer Required

      Minimum value is 0.

    • Additional properties are NOT allowed
  • Additional properties are NOT allowed