Get filtered working hours

Use this method to get a list of working hours with pagination and filtering options. Using filter is optional. The result can be filtered by one or many optional filters described in the parameters.

get/ccaas/1/working-hours

Request

Base URL
https://api.infobip.com (the document declares no server; this is the origin it was published from)
Auth
- OAuth 2
  Client credentials
  Token URL: https://api.infobip.com/auth/1/oauth2/token
- or API key in header Authorization
- or API key in header Authorization
- or HTTP basic

Query parameters

namestring

Optional. Working hours that contain a name case-insensitive.

enabledboolean

Optional. Working hours enable/disable toggle.

isDefaultboolean

Optional. Default working hours.

createdAfterstring date-time

Optional. Filter results created after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

createdBeforestring date-time

Optional. Filter results created before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

updatedAfterstring date-time

Optional. Filter results updated after specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

updatedBeforestring date-time

Optional. Filter results updated before specific date and time. Format: yyyy-MM-dd'T'HH:mm:ss.SSSZ

limitinteger

Size of the result page.

pageinteger

Number of the current page.

orderBystring

This parameter is used to order your results. If an order is not given, the default order id:asc will be applied. Possible ordering fields are properties. Ordering direction can be specified with modifiers asc for the ascending ordering or desc for the descending one.

Response

Example response

{
  "workingHours": [
    {
      "id": "07ad4193-4354-488c-b45f-293dfa4c90fb",
      "timezone": "Etc/UTC",
      "message": "We're out of office, come back another time, thank you!",
      "workWeek": {
        "MONDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "TUESDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "WEDNESDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "THURSDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "FRIDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "SATURDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        },
        "SUNDAY": {
          "startTime": 0,
          "endTime": 1440,
          "enabled": true
        }
      },
      "name": "My Working Hours",
      "enabled": true,
      "isDefault": true,
      "closeConversations": false,
      "holidays": [
        {
          "id": "aae9b06f-a323-4c9c-b807-7a9e4e015405",
          "workingHoursId": "07ad4193-4354-488c-b45f-293dfa4c90fb",
          "name": "New Year's Day",
          "startDate": "2021-01-01",
          "endDate": "2021-01-01",
          "enabled": true
        },
        {
          "id": "6bfb9b10-caec-4f53-85a9-b87da6afa88f",
          "workingHoursId": "07ad4193-4354-488c-b45f-293dfa4c90fb",
          "name": "My Holiday",
          "startDate": "2021-06-09",
          "endDate": "2021-06-09",
          "enabled": false
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.