Get listing time slots

GET /listings/{listingId}/time-slots
OAuth2

Get listing time slots for a listing by its ID

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

Query parameters

  • id array[string]

    ID(s) to be considered for filtering

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

  • from string(date-time)

    Start date and time to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • to string(date-time)

    End date and time to be considered for filtering (ISO 8601)

    Minimum length is 1.

  • employee-id array[string]

    Employee ID(s) to be considered for filtering

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

  • bookable boolean

    Bookable flag to be considered for filtering

  • 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

  • 200 application/json

    Successful operation

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

        Minimum length is 1.

      • listing object Required

        Additional properties are NOT allowed.

        Hide listing attribute Show listing attribute object
        • id string Required

          Minimum length is 1.

      • date string Required

        Minimum length is 1.

      • startTime string Required

        Minimum length is 1.

      • endTime string Required

        Minimum length is 1.

      • bookable boolean Required
      • assignments array[object] Required
        Hide assignments attributes Show assignments attributes object
        • employee object Required

          Additional properties are NOT allowed.

          Hide employee attribute Show employee attribute object
          • id string Required

            Minimum length is 1.

        • exclusive boolean Required
      • createdAt string(date-time) Required

        Minimum length is 1.

      • updatedAt string(date-time) Required

        Minimum length is 1.

    • meta object Required

      Additional properties are NOT allowed.

      Hide meta attributes Show meta attributes object
      • offset integer Required

        Minimum value is 0. Default value is 0.

      • limit integer Required

        Minimum value is 0. Default value is 25.

      • totalCount integer Required

        Minimum value is 0.
  • 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 /listings/{listingId}/time-slots 
curl \
 -X GET https://api.development.pexipengage.com/enterprises/acme/listings/123/time-slots \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
Response examples (200) 
{
  "data": [
    {
      "id": "123",
      "listing": {
        "id": "123"
      },
      "date": "2022-08-01",
      "startTime": "09:00",
      "endTime": "17:00",
      "bookable": true,
      "assignments": [
        {
          "employee": {
            "id": "123"
          },
          "exclusive": true
        }
      ],
      "createdAt": "2022-08-17T19:05:21.362Z",
      "updatedAt": "2022-08-17T19:05:21.362Z"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}
Response examples (404) 
{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}