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

• employee-id array[string]

  Employee ID(s) to be considered for filtering

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

• employee-external-id array[string]

  Employee external ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• lead-segment-id string

  Lead segment ID to be considered for filtering

  Minimum length is 1.

• lead-segment-code string

  Lead segment code to be considered for filtering

  Minimum length is 1, maximum length is 255.

• listing-id string

  Listing ID to be considered for filtering

  Minimum length is 1.

• listing-external-id string

  Listing external ID to be considered for filtering

  Minimum length is 1, maximum length is 255.

• location object

  Additional properties are NOT allowed.

  Hide location attributes Show location attributes object

  • latitude number

    Minimum value is -90, maximum value is 90.

  • longitude number

    Minimum value is -180, maximum value is 180.

• meeting-type array[string]

  Meeting type(s) to be considered for filtering

  Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

• office-id array[string]

  Office ID(s) to be considered for filtering

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

• office-external-id array[string]

  Office external ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• order-by-distance-to object

  Additional properties are NOT allowed.

  Hide order-by-distance-to attributes Show order-by-distance-to attributes object

  • latitude number

    Minimum value is -90, maximum value is 90.

  • longitude number

    Minimum value is -180, maximum value is 180.

• subject-id array[string]

  Subject ID(s) to be considered for filtering

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

• subject-external-id array[string]

  Subject external ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

• subject-group-id array[string]

  Subject group ID(s) to be considered for filtering

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

• subject-group-external-id array[string]

  Subject group external ID(s) to be considered for filtering

  At least 1 element. Minimum length of each is 1, maximum length of each is 255.

Responses

• 200 application/json

  Default Response

  Hide response attribute Show response attribute object

  • data array[object] Required
    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.

    • firstName string | null

      Minimum length is 1.

    • lastName string | null

      Minimum length is 1.

    • language string Required

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

    • phoneNumber string | null

      Minimum length is 1.

    • profilePictureUrl string(uri) | null

      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.