Skip to main content
GET
/
barbers
/
{id}
/
schedules
/
overrides
/
{overrideId}
Get a schedule override
curl --request GET \
  --url https://api.guile.app/barbers/{id}/schedules/overrides/{overrideId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "startsOn": "2023-12-25",
  "endsOn": "2023-12-25",
  "type": "timeOff",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "startsAt": "<string>",
  "endsAt": "<string>",
  "description": "<string>"
}

Path Parameters

​
id
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

​
overrideId
string<uuid>
required

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

Response

Ok. The operation succeeded.

A schedule override for time off or modified hours

​
id
string<uuid>
required

Unique identifier for the override

​
startsOn
string<date>
required

Start date of the override, in RFC 3339 date format (YYYY-MM-DD).

​
endsOn
string<date>
required

End date of the override (inclusive), in RFC 3339 date format (YYYY-MM-DD). Must be provided for multi-day overrides.

​
type
enum<string>
required

Type of override

Available options:
timeOff,
holiday,
other
​
createdAt
string<date-time>
required

The date-time when this resource was created, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
updatedAt
string<date-time>
required

The date-time when this resource was updated, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. This is derived and immutable.

​
startsAt
string<time>

Start time applied to each day of the override, in RFC 3339 time format (HH:MM). If omitted, the override applies to the full day.

​
endsAt
string<time>

End time applied to each day of the override, in RFC 3339 time format (HH:MM). If omitted, the override applies to the full day.

​
description
string

Reason or description for the override

Maximum string length: 255