Get a list of site access hours
Retrieve a collection of access hours (required scope contacts:read)
Path Parameters
Possible values: >= 1
The unique identifier of the contact
Query Parameters
Possible values: >= 1
and <= 2147483
The page number being requested (minimum: 1, maximum: 2147483)
Possible values: >= 1
and <= 1000
The page size being requested (minimum: 1, maximum: 1000)
Header Parameters
The customer identifier
- 200
- 400
- 403
- 404
- 500
Success
Schema
- Array [
- sunday
- monday
- tuesday
- wednesday
- thursday
- friday
- saturday
- ]
items object[]
The items returned for the requested page
Possible values: [sunday
, monday
, tuesday
, wednesday
, thursday
, friday
, saturday
]
Possible values:
The 24H format time of day that access to the contact site starts (hh:mm)
The 24H format time of day that access to the contact site stops (hh:mm)
The page number of the response where 1 is the first page
The number of items requested for the current page
The number of items returned in the current page
{
"items": [
{
"dayOfWeek": "sunday",
"start": "09:00",
"stop": "17:00"
}
],
"pageNumber": 2,
"pageSize": 100,
"pageItemCount": 55
}
Bad Request
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Forbidden
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Not Found
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}
Server Error
Schema
A URI reference [RFC3986] that identifies the problem type
A short, human-readable summary of the problem type
The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem
A human-readable explanation specific to this occurrence of the problem
A URI reference that identifies the specific occurrence of the problem
{
"type": "https://example.com/probs/out-of-credit",
"title": "You do not have enough credit",
"status": 403,
"detail": "Your current balance is 30, but that costs 50",
"instance": "/account/12345/msgs/abc"
}