List my appointments

GET

appointments

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

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

fetch('https://api.guile.app/me/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/me/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/me/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/me/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
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 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": {}
    }
  ]
}

Query Parameters

state

enum<string>[]

When included, filter to appointments with any of these appointment states. Multiple values are pipe-delimited (for example scheduled|completed). When excluded, defaults to scheduled appointments. Ignored when reviewable is true.

Valid states of the appointment.

Available options:

pending,

scheduled,

canceled,

completed,

rejected,

expired

date

string

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})[)\]])$

barberId

string

When included, limit appointments to this specific barber. When excluded, appointments are not filtered by barber. 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.

reviewable

boolean

When true, return completed appointments the customer has not reviewed and has not dismissed from the review prompt. When excluded or false, appointments are not filtered by reviewability.

limit

integer<int16>

default:10

required

offset

integer<int16>

default:0

required

Response

Ok. The operation succeeded.

A list response for appointment resources. This response contains the full result set after any filters are applied.

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

List my appointments

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

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

fetch('https://api.guile.app/me/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/me/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/me/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/me/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
    }
  ],
  "count": 1,
  "offset": 1,
  "limit": 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": {}
    }
  ]
}

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

Query Parameters

Response