List barber appointments

GET

barbers

{barberId}

appointments

curl --request GET \
  --url https://api.guile.app/barbers/{barberId}/appointments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.guile.app/barbers/{barberId}/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.guile.app/barbers/{barberId}/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.guile.app/barbers/{barberId}/appointments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.guile.app/barbers/{barberId}/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "givenName": "<string>",
      "services": [
        {
          "id": "<string>",
          "name": "<string>",
          "cost": "456.78",
          "duration": "<string>"
        }
      ],
      "occursOn": "2023-11-07T05:31:56Z",
      "duration": "<string>",
      "cost": "456.78",
      "barber": {
        "id": "<string>",
        "givenName": "<string>",
        "surname": "<string>",
        "preferredName": "<string>",
        "biography": "<string>",
        "spokenLanguages": [],
        "experience": 50,
        "instagram": "<string>",
        "urlSlug": "<string>",
        "profileImage_URL": "<string>",
        "phoneNumber": "<string>"
      },
      "location": {
        "id": "<string>",
        "name": "<string>",
        "shopName": "<string>",
        "address": {
          "address1": "<string>",
          "locality": "Atlanta",
          "regionCode": "VT",
          "postalCode": "20521-9000",
          "countryCode": "CA",
          "address2": "<string>"
        }
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "bookingRequest": {
        "value": {
          "serviceSubtotal": "456.78",
          "total": "456.78",
          "offHoursFee": "456.78",
          "tipAmount": "456.78"
        },
        "expiresAt": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "declineReason": "<string>",
        "expirationReason": "approvalTimedOut"
      },
      "offHoursFee": "456.78",
      "tipAmount": "456.78",
      "surname": "<string>",
      "displayName": "<string>",
      "timeZone": "<string>",
      "recurringAppointmentId": "<string>",
      "reviewed": true,
      "reviewPromptDismissed": true,
      "client": {
        "id": "<string>"
      },
      "cancellation": {
        "canceledAt": "2023-11-07T05:31:56Z",
        "note": "<string>",
        "policySnapshot": {
          "lateCancellationWindow": "<string>",
          "lateCancellationFee": {
            "fixed": "456.78",
            "currencyCode": "USD",
            "percentage": 50
          },
          "noShowFee": {
            "fixed": "456.78",
            "currencyCode": "USD",
            "percentage": 50
          }
        },
        "fee": {
          "amount": "456.78",
          "currencyCode": "USD",
          "applied": true
        }
      },
      "cancellationFeePreviews": {
        "lateCancellation": {
          "amount": "456.78",
          "currencyCode": "USD",
          "appliesNow": true,
          "freeUntil": "2023-11-07T05:31:56Z"
        },
        "noShow": {
          "amount": "456.78",
          "currencyCode": "USD"
        }
      },
      "totalAuthorized": "456.78",
      "totalCaptured": "456.78",
      "totalRefunded": "456.78",
      "paymentLinkSend": {
        "attemptsUsed": 1,
        "attemptsRemaining": 1,
        "maxAttempts": 1,
        "nextAvailableAt": "2023-11-07T05:31:56Z",
        "lastSentAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 1,
  "summary": {
    "appointments": {
      "confirmed": 1,
      "pending": 1
    },
    "payments": {
      "pending": 1,
      "processing": 1,
      "authorized": 1,
      "paid": 1,
      "failed": 1
    }
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

Path Parameters

barberId

string

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

paymentMethod

enum<string>[]

When included, filter to appointments with any of these payment methods. When excluded, appointments are not filtered by payment method.

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

paymentDirection

enum<string>[]

When included, filter to appointments with any of these payment directions. When excluded, appointments are not filtered by payment direction.

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

paymentState

enum<string>[]

When included, filter to appointments with any of these payment states. When excluded, appointments are not filtered by payment state.

The money position of an appointment's payment. pending means no funds have moved. processing means an authorization or capture attempt is in flight. authorized means funds are held but not captured, paid means captured and settled, and failed means the last authorization attempt failed.

Available options:

pending,

processing,

authorized,

paid,

failed

date

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

Pattern: ^(\d{4}-\d{2}-\d{2}|[\[(](\d{4}-\d{2}-\d{2},(\d{4}-\d{2}-\d{2})?|,\d{4}-\d{2}-\d{2})[)\]])$

state

enum<string>[]

When included, filter to appointments with any of these appointment states. When excluded, appointments are not filtered by appointment state.

Valid states of the appointment.

Available options:

pending,

scheduled,

canceled,

completed,

rejected,

expired

pendingType

enum<string>[]

When included, filter to appointments with any of these pending classifications. Use bookingApproval for the barber's booking request queue. When excluded, appointments are not filtered by pending classification.

Why an appointment is pending.

Available options:

bookingApproval,

cardConfirmation

cancellationFeeType

enum<string>

When included, filter to appointments with any of these cancellation fee types. When excluded, appointments are not filtered by cancellation fee type. Indicates the fee type for cancelations.

Available options:

lateCancelation,

noShow

offset

integer<int16>

default:0

The number of matching appointments to skip.

Required range: 0 <= x <= 32767

limit

integer<int16>

default:10

The maximum number of appointments to return.

Required range: 1 <= x <= 100

Response

Ok. The operation succeeded.

A paginated list of barber-facing appointment summaries.

items

object[]

required

Show child attributes

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

summary

object

Counts across all appointments matching the current filters, not only this page.

Show child attributes

List barber appointments

curl --request GET \
  --url https://api.guile.app/barbers/{barberId}/appointments \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.guile.app/barbers/{barberId}/appointments', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.guile.app/barbers/{barberId}/appointments",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.guile.app/barbers/{barberId}/appointments"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.guile.app/barbers/{barberId}/appointments")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "items": [
    {
      "givenName": "<string>",
      "services": [
        {
          "id": "<string>",
          "name": "<string>",
          "cost": "456.78",
          "duration": "<string>"
        }
      ],
      "occursOn": "2023-11-07T05:31:56Z",
      "duration": "<string>",
      "cost": "456.78",
      "barber": {
        "id": "<string>",
        "givenName": "<string>",
        "surname": "<string>",
        "preferredName": "<string>",
        "biography": "<string>",
        "spokenLanguages": [],
        "experience": 50,
        "instagram": "<string>",
        "urlSlug": "<string>",
        "profileImage_URL": "<string>",
        "phoneNumber": "<string>"
      },
      "location": {
        "id": "<string>",
        "name": "<string>",
        "shopName": "<string>",
        "address": {
          "address1": "<string>",
          "locality": "Atlanta",
          "regionCode": "VT",
          "postalCode": "20521-9000",
          "countryCode": "CA",
          "address2": "<string>"
        }
      },
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "bookingRequest": {
        "value": {
          "serviceSubtotal": "456.78",
          "total": "456.78",
          "offHoursFee": "456.78",
          "tipAmount": "456.78"
        },
        "expiresAt": "2023-11-07T05:31:56Z",
        "resolvedAt": "2023-11-07T05:31:56Z",
        "declineReason": "<string>",
        "expirationReason": "approvalTimedOut"
      },
      "offHoursFee": "456.78",
      "tipAmount": "456.78",
      "surname": "<string>",
      "displayName": "<string>",
      "timeZone": "<string>",
      "recurringAppointmentId": "<string>",
      "reviewed": true,
      "reviewPromptDismissed": true,
      "client": {
        "id": "<string>"
      },
      "cancellation": {
        "canceledAt": "2023-11-07T05:31:56Z",
        "note": "<string>",
        "policySnapshot": {
          "lateCancellationWindow": "<string>",
          "lateCancellationFee": {
            "fixed": "456.78",
            "currencyCode": "USD",
            "percentage": 50
          },
          "noShowFee": {
            "fixed": "456.78",
            "currencyCode": "USD",
            "percentage": 50
          }
        },
        "fee": {
          "amount": "456.78",
          "currencyCode": "USD",
          "applied": true
        }
      },
      "cancellationFeePreviews": {
        "lateCancellation": {
          "amount": "456.78",
          "currencyCode": "USD",
          "appliesNow": true,
          "freeUntil": "2023-11-07T05:31:56Z"
        },
        "noShow": {
          "amount": "456.78",
          "currencyCode": "USD"
        }
      },
      "totalAuthorized": "456.78",
      "totalCaptured": "456.78",
      "totalRefunded": "456.78",
      "paymentLinkSend": {
        "attemptsUsed": 1,
        "attemptsRemaining": 1,
        "maxAttempts": 1,
        "nextAvailableAt": "2023-11-07T05:31:56Z",
        "lastSentAt": "2023-11-07T05:31:56Z"
      }
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 1,
  "summary": {
    "appointments": {
      "confirmed": 1,
      "pending": 1
    },
    "payments": {
      "pending": 1,
      "processing": 1,
      "authorized": 1,
      "paid": 1,
      "failed": 1
    }
  }
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

{
  "type": "<string>",
  "title": "<string>",
  "occurredAt": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "status": 349,
  "detail": "<string>",
  "instance": "<string>",
  "attributes": {},
  "recovery": {
    "rateLimit": {
      "limit": 123,
      "remaining": 123,
      "resetsAt": "2023-11-07T05:31:56Z"
    }
  },
  "problems": [
    {
      "type": "<string>",
      "title": "<string>",
      "occurredAt": "2023-11-07T05:31:56Z",
      "id": "<string>",
      "status": 349,
      "detail": "<string>",
      "instance": "<string>",
      "attributes": {}
    }
  ]
}

Get started

Public APIs

API concepts

Metadata

Admin

Authentication

Appointments

Payments

Barbers

Businesses

Clients

Customers

Fees

Integrations

Invitations

Payouts

Photos

Refunds

Reviews

Services

Shops

List barber appointments

Path Parameters

Query Parameters

Response