BookingLinksResponse
Response schema for a list of booking links
data object[]required
client object
The pre-selected client for the link, if any.
- Client
- object
Time at which the object was created.
The client's email address. This field will be null unless include_sensitive is true.
fields objectnullable
Custom field values for this client as a map of field key to value. Sensitive field values will be null unless include_sensitive is true.
Custom field values for this client as a map of field key to value. Sensitive field values will be null unless include_sensitive is true.
The client's first name. This field will be null unless include_sensitive is true.
Unique identifier for the object.
Possible values: Value must match regular expression ^clnt_\w{12}$
The client's last name. This field will be null unless include_sensitive is true.
The locale of the client.
en-USmetadata object
Set of key-value pairs attached to this client. Maximum size is 16 KB.
Set of key-value pairs attached to this client. Maximum size is 16 KB.
String representing the object's type.
Possible values: [client]
The client's phone number (E.164 format). This field will be null unless include_sensitive is true.
External reference identifier for the client.
The client's time zone (IANA format).
America/ChicagoTime at which the object was last updated.
When the link stops accepting new bookings. null means it never expires.
Possible values: Value must match regular expression ^bl_\w{24}$
Fields that the public booker may not change on begotten booking intents.
Possible values: [service_id, provider_id, slot, client_data, submissions]
How many confirmed bookings the link may beget. null means unlimited.
Possible values: >= 1
metadata objectrequired
An optional label for the link.
Possible values: [booking_link]
providers object[]required
The provider subset the link is restricted to. An empty array means the full service rotation applies.
Time at which the object was created.
The provider's display name.
The provider's email address.
The provider's first name.
Unique identifier for the object.
Possible values: Value must match regular expression ^prov_\w{12}$
The provider's last name.
metadata object
Set of key-value pairs attached to this provider. Maximum size is 16 KB.
Set of key-value pairs attached to this provider. Maximum size is 16 KB.
String representing the object's type.
Possible values: [provider]
The provider's preferred IANA time zone, used as the default when authoring schedules.
Time at which the object was last updated.
The ID of the service the link belongs to.
Possible values: Value must match regular expression ^srv_\w{12}$
The current state of the link. paused when deactivated, expired once past expires_at, used_up once max_uses is reached, otherwise active.
Possible values: [active, paused, expired, used_up]
The fully-qualified URL at which the link can be booked. Resolves to the account's active custom domain when configured, otherwise the canonical app host.
The number of confirmed bookings begotten through this link.
The number of confirmed bookings still available. null when unlimited.
meta objectrequired
Metadata for paginated responses
Current page number
Number of records per page
Total number of records
Total number of pages
{
"data": [
{
"client": null,
"created_at": "2017-09-12T12:34:55Z",
"expires_at": "2017-10-01T00:00:00Z",
"id": "bl_d025a96ac0c6d025a96ac0c6",
"locked_fields": [
"provider_id"
],
"max_uses": 5,
"metadata": {
"campaign": "spring"
},
"name": "VIP onboarding",
"object": "booking_link",
"providers": [
{
"created_at": "2017-09-12T12:34:55Z",
"display_name": "John Smith",
"email": "john@example.com",
"first_name": "John",
"id": "prov_d025a96ac0c6",
"last_name": "Smith",
"metadata": {
"external_id": "123"
},
"object": "provider",
"time_zone": "America/New_York",
"updated_at": "2017-09-13T10:11:12Z"
}
],
"service_id": "srv_d025a96ac0c6",
"status": "active",
"updated_at": "2017-09-13T10:11:12Z",
"url": "https://example.savvycal.com/c/book/bl_d025a96ac0c6d025a96ac0c6",
"uses_count": 1,
"uses_remaining": 4
}
],
"meta": {
"current_page": 1,
"page_size": 10,
"total_count": 50,
"total_pages": 5
}
}