Get favorite agents

GET /employees/{id}/favorite-agents
OAuth2

Get favorite agents for an employee 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 array[string]

    Office ID(s) to be considered for filtering

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

  • 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.

Responses

GET /employees/{id}/favorite-agents 
curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/employees/1234/favorite-agents \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    {
      "office": {
        "id": "123"
      },
      "employee": {
        "id": "123"
      }
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}