Get lead segment scheduling settings

GET /lead-segments/{id}/scheduling-settings
O auth2

Get scheduling settings for a lead segment by its ID 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.

Path parameters

  • id string Required

    Primary identifier of the requested resource

    Minimum length is 1.

Query parameters

  • meeting-type array[string]

    Meeting type(s) to be considered for filtering

    Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

  • subject-id array[string]

    Subject ID(s) to be considered for filtering

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

Responses

  • 200 application/json

    Successful operation

    Hide response attribute Show response attribute object
    • data array[object] Required
      Hide data attributes Show data attributes object
      • meetingType string Required

        Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

      • subject object Required

        Additional properties are NOT allowed.

        Hide subject attribute Show subject attribute object
        • id 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 /lead-segments/{id}/scheduling-settings 
curl \
 --request GET 'https://api.staging.pexipengage.com/enterprises/acme/lead-segments/1234/scheduling-settings' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    {
      "meetingType": "OFFICE",
      "subject": {
        "id": "123"
      }
    }
  ]
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}