Skip to main content
GET
/
clients
/
{clientId}
Retrieve a client
curl --request GET \
  --url https://api.guile.app/clients/{clientId} \
  --header 'Authorization: Bearer <token>'
{
  "givenName": "<string>",
  "allergies": [],
  "languages": [],
  "id": "<string>",
  "averageAppointmentCost": "456.78",
  "averageTipAmount": "456.78",
  "noShowCount": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "appointmentCount": 123,
  "lateCancelationCount": 123,
  "surname": "<string>",
  "nickname": "<string>",
  "phoneNumber": "<string>",
  "birthDate": "<string>",
  "emailAddress": "<string>",
  "profilePhoto_URL": "<string>",
  "hairType": "<string>",
  "lastAppointmentAt": "2023-11-07T05:31:56Z",
  "nextAppointmentAt": "2023-11-07T05:31:56Z",
  "review": {
    "rating": 123,
    "occurredAt": "2023-11-07T05:31:56Z",
    "review": "<string>"
  }
}

Path Parameters

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

Response

Ok. The operation succeeded.

​
givenName
string
required
​
allergies
string[]
required
​
languages
string[]
required
​
id
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.

​
averageAppointmentCost
string<decimal>
required

A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision. Values may be positive or negative.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
averageTipAmount
string<decimal>
required

A monetary amount in the lowest denomination for the given currency. The numeric value is represented as a string so that it can be exact with no loss of precision. Values may be positive or negative.

Pattern: ^-?(0|[1-9][0-9]*)\.[0-9][0-9]$
Example:

"456.78"

​
state
enum<string>
required
Available options:
invited,
accepted
​
noShowCount
integer<uint16>
required

The client's no-show appointment count.

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

​
appointmentCount
integer<uint16>
required
​
lateCancelationCount
integer<uint16>
required
​
surname
string
​
nickname
string
​
phoneNumber
string
​
birthDate
string

A date, expressed in YYYY-MM-DD RFC 3339 date format.

Pattern: ^\d{4}-\d{2}-\d{2}$
​
emailAddress
string
​
profilePhoto_URL
string
​
hairType
string
​
lastAppointmentAt
string<date-time>
​
nextAppointmentAt
string<date-time>
​
review
object