Retrieve Staff Working Hours Schedule

GET

/businesses/{businessId}/staff/{staffId}/working-hours-schedules/{workingHoursScheduleId}

• production

Experimental Feature. Subject to change. Retrieve a Working Hours Schedule for a Staff.

Authorizations

• apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

staffId

required

The ID of the Staff.

string

workingHoursScheduleId

required

The ID of the Working Hours Schedule.

string

Responses

200

A Working Hours Schedules

Working Hours Schedule

A schedule to use with Staff to plan availability.

object

id

required

Unique identifier across the platform.

string format: uuid

createdAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

updatedAt

required

Time when the resource was created (ISO 8601 format).

string format: date-time

staffId

required

The ID of the Staff this resource belongs to.

string format: uuid

workingHours

required

A configuration to define active hours.

object

monday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

tuesday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

wednesday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

thursday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

friday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

saturday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

sunday

A group of active hours for a single day.

Array<Array<number>>

Example

[
  [
    900,
    1200
  ],
  [
    1300,
    1700
  ]
]

timezone

The timezone for this schedule

string

Example

America/New_York

dateStart

required

string format: date-time

Example

2024-01-01T00:00:00Z

dateEnd

string format: date-time

Example

2024-01-08T00:00:00Z