latestOpenAPI 3.0.12026-08-192092911.2 MB

916e669fc527

Contacts

Get a list of site access hours

Retrieve a collection of access hours (required scope contacts:read)

get/v1/contacts/{contactId}/accessHours

Path parameters

contactIdinteger required

The unique identifier of the contact

Query parameters

pageNumberinteger

The page number being requested (minimum: 1, maximum: 2147483)

pageSizeinteger

The page size being requested (minimum: 1, maximum: 1000)

Headers

Customer-Idinteger required

The customer identifier

Response

OK

pageNumberinteger

The page number of the response where 1 is the first page

pageSizeinteger

The number of items requested for the current page

pageItemCountinteger

The number of items returned in the current page

Example response

{
  "items": [
    {
      "dayOfWeek": "sunday",
      "start": "09:00",
      "stop": "17:00"
    }
  ],
  "pageNumber": 2,
  "pageSize": 100,
  "pageItemCount": 55
}