Skip to main content
GET
/
openings
List appointment openings
curl --request GET \
  --url https://api.guile.app/openings \
  --header 'Authorization: Bearer <token>'
{
  "openings": [
    "9:00"
  ],
  "count": 123,
  "location": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "shopName": "<string>"
  },
  "barber": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "givenName": "<string>",
    "surname": "<string>",
    "preferredName": "<string>"
  }
}

Query Parameters

​
locationId
string<uuid>

Limit openings to this specific location.

Either a locationId or barberId is 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.

​
barberId
string<uuid>

Limit openings to this specific barber.

Either a locationId or barberId is 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.

​
duration
string<duration>
required

Calculate openings to this specific appointment duration.

​
date
string
required

Limit openings to this specific calendar date. A date, expressed in YYYY-MM-DD RFC 3339 date format.

Response

Ok. The operation succeeded.

Available openings based on request parameters.

​
openings
string[]
required

A list of appointment openings. Each item represents the start time of an opening, in 24 hour time.

The starting time for an appointment opening time slot, in 24 hour time.

​
count
integer<int16>
required

The total number of appointment openings based on search criteria. This is derived and immutable.

​
location
object
required

The shop location for the appointment openings.

​
barber
object
required

The barber for the appointment openings.