Skip to main content
GET
/
locations
/
{locationId}
/
appointments
List location appointments
curl --request GET \
  --url https://api.guile.app/locations/{locationId}/appointments \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "givenName": "<string>",
      "barber": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "givenName": "<string>",
        "surname": "<string>",
        "preferredName": "<string>"
      },
      "location": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "shopName": "<string>"
      },
      "services": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "cost": "456.78",
          "duration": "<string>"
        }
      ],
      "occursOn": "2023-11-07T05:31:56Z",
      "duration": "<string>",
      "cost": "456.78",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "surname": "<string>"
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 1
}

Path Parameters

​
locationId
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.

Query Parameters

​
paymentMethods
enum<string>[]

The method used to process the payment.

platform means Guile manages the payment through our payment provider.

external means the payment is managed externally. This is either cash or a peer-to-peer payment system, such as Venmo.

Available options:
platform,
external
​
paymentDirections
enum<string>[]

The direction of the payment flow.

payment means money flows from customer to business. refund means money flows from business to customer.

Available options:
payment,
refund
​
paymentStates
enum<string>[]

Valid payment states of the appointment.

Available options:
pending,
authorized,
paid,
failed
​
dates
string
required

A date range, supporting inclusive or exclusive endpoints. Dates ranges use dates expressed in YYYY-MM-DD RFC 3339 date format. The value may have the following forms:

  • YYYY-MM-DD match the date exactly; equivalent to matching dates in the range [YYYY-MM-DD,YYYY-MM-DD]
  • [YYYY-MM-DD,YYYY-MM-DD] between two dates, inclusive of the endpoints
  • (YYYY-MM-DD,YYYY-MM-DD) between two dates, exclusive of the endpoints
  • [YYYY-MM-DD,] on or after the date
  • (YYYY-MM-DD,) after the date
  • [,YYYY-MM-DD] before or on the date
  • (,YYYY-MM-DD) before the date

Examples:

  • '2022-05-19'
  • '[2022-05-01,2022-05-31]'
  • '[2022-05-01,2022-06-01)'
  • '[2022-05-19,]'
  • '(2022-05-19,)'
  • '[,2022-05-19]'
  • '(,2022-05-19)'
Maximum string length: 24
​
states
enum<string>[]

Valid states of the appointment.

Available options:
pending,
scheduled,
canceled,
completed

Response

Ok. The operation succeeded.

A list response for paginated resources.

​
items
object[]
required
​
count
integer<int16>
required
Required range: x >= 0
​
offset
integer<int16>
required

The offset of list results for the current page.

Required range: x >= 0
​
limit
integer<int16>
required

The maximum number of results included in items.

Required range: x >= 0