Get office coverage regions

GET /employees/{id}/office-coverage-regions
OAuth2

Get office coverage regions for an agent 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

  • office-id string Required

    Office ID to be considered for filtering

    Minimum length is 1.

  • meeting-type array[string]

    Meeting type(s) to be considered for filtering

    At least 1 element. Values are OFFICE, ON_LOCATION, PHONE, or VIDEO.

  • region-id array[string]

    Region ID(s) to be considered for filtering

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

Responses

GET /employees/{id}/office-coverage-regions 
curl \
 -X GET https://api.pexipengage.com/enterprises/acme/employees/1234/office-coverage-regions?office-id=123 \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    {
      "meetingType": "OFFICE",
      "office": {
        "id": "123"
      },
      "regions": [
        {
          "id": "123"
        }
      ]
    }
  ]
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}