Skip to main content

Get a list of site access hours

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

Path Parameters
    contactId int64 required

    Possible values: >= 1

    The unique identifier of the contact

Query Parameters
    pageNumber int32

    Possible values: >= 1 and <= 2147483

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

    pageSize int32

    Possible values: >= 1 and <= 1000

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

Header Parameters
    Customer-Id int64 required

    The customer identifier

Responses

Success


Schema
    items object[]

    The items returned for the requested page

  • Array [
  • dayOfWeek DayOfWeek

    Possible values: [sunday, monday, tuesday, wednesday, thursday, friday, saturday]

    Possible values:

    • sunday
    • monday
    • tuesday
    • wednesday
    • thursday
    • friday
    • saturday
    start string

    The 24H format time of day that access to the contact site starts (hh:mm)

    stop string

    The 24H format time of day that access to the contact site stops (hh:mm)

  • ]
  • pageNumber int32

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

    pageSize int32

    The number of items requested for the current page

    pageItemCount int32

    The number of items returned in the current page

Loading...