Get schedulable meeting types

GET /schedulable/meeting-types

Get schedulable meeting types with filtering

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.

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 string
    • longitude string
  • 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 string
    • longitude string
  • 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[string] Required

      Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.
GET /schedulable/meeting-types 
curl \
 --request GET 'https://api.staging.pexipengage.com/enterprises/acme/schedulable/meeting-types' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    "OFFICE"
  ]
}