Skip to content

List Staff Working Hours Schedules

GET

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

const url = 'https://api.upvio.com/v1/businesses/example/staff/example/working-hours-schedules';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.upvio.com/v1/businesses/example/staff/example/working-hours-schedules \
  --header 'Authorization: Bearer <token>'

Experimental Feature. Subject to change. Retrieve a list of Working Hours Schedules for a Staff.

Authorizations

apiKey

Parameters

Path Parameters

businessId

required

The ID of the Business.

string

staffId

required

The ID of the Staff.

string

Responses

200

A list of Working Hours Schedules

application/json

object

data

Array<object>

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>>

tuesday

A group of active hours for a single day.

Array<Array<number>>

wednesday

A group of active hours for a single day.

Array<Array<number>>

thursday

A group of active hours for a single day.

Array<Array<number>>

friday

A group of active hours for a single day.

Array<Array<number>>

saturday

A group of active hours for a single day.

Array<Array<number>>

sunday

A group of active hours for a single day.

Array<Array<number>>

timezone

The timezone for this schedule

string

dateStart

required

string format: date-time

dateEnd

string format: date-time

Example

{
  "data": [
    {
      "workingHours": {
        "monday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "tuesday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "wednesday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "thursday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "friday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "saturday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ],
        "sunday": [
          [
            900,
            1200
          ],
          [
            1300,
            1700
          ]
        ]
      },
      "timezone": "America/New_York",
      "dateStart": "2024-01-01T00:00:00Z",
      "dateEnd": "2024-01-08T00:00:00Z"
    }
  ]
}