Skip to main content
GET
/
barbers
/
{barberId}
/
recurringAppointments
/
{recurringAppointmentId}
Get a recurring appointment
curl --request GET \
  --url https://api.guile.app/barbers/{barberId}/recurringAppointments/{recurringAppointmentId} \
  --header 'Authorization: Bearer <token>'
{
  "frequency": "daily",
  "startDate": "2023-12-25",
  "active": true,
  "customerReference": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "givenName": "<string>",
    "surname": "<string>"
  },
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "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>"
    }
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "endDate": "2023-12-25"
}

Path Parameters

ā€‹
barberId
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.

ā€‹
recurringAppointmentId
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 representation of a recurring appointment.

ā€‹
frequency
enum<string>
required

The frequency at which appointments recur. Appointments are created in the background by the system based on this frequency.

Available options:
daily,
weekly,
biweekly,
semimonthly,
monthly,
quarterly,
annually
ā€‹
startDate
string<date>
required

The start date for the recurring appointment series. Appointments will be created starting from this date.

ā€‹
active
boolean
required

Whether the recurring appointment is active. When inactive, no new appointments will be created for this series.

ā€‹
customerReference
object
required

A reference to the customer for this recurring appointment.

ā€‹
id
string<uuid>
required

The unique identifier for this recurring appointment.

ā€‹
barber
object
required

A reference to the barber for this recurring appointment.

ā€‹
location
object
required

The location for appointments in this series.

ā€‹
services
object[]
required

The services for appointments in this series.

ā€‹
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.

ā€‹
endDate
string<date>

The end date for the recurring appointment series, if specified. If not specified, appointments are created up to one year from the start date or current date, whichever is later.