Read Bookable Event BETA
Required plan: EmergingDescription #
Read a Bookable Event for the application.
URL format #
{data_center_url}/v1/bookable_events/{bookable_event_id}
Example Request #
GET /v1/bookable_events/{bookable_event_id} HTTP/1.1
Host: {data_center_url}
Authorization: Bearer {API_KEY}
Example Response #
HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8
{
"bookable_event_id": "83hi8qhfiaif",
"start": "2024-12-20T15:30:00Z",
"end": "2024-12-20T17:00:00Z",
"status": "confirmed",
"registration": {
"capacity": 5,
"registered_count": 1,
"total_count": 2,
"registrations": [
{
"registration_id": "328746",
"status": "accepted",
"metadata": {
"name": "Lashmi Sundar"
}
},
{
"registration_id": "247629",
"status": "pending",
"metadata": {
"name": "Sarah Overly"
}
}
],
"pages": {
"current": 1,
"total": 2,
"next_page": "https://api.cronofy.com/v1/bookable_events/83hi8qhfiaif/registrations/pages/08a07b034306679e"
}
}
}
Request parameters #
data_center_url required
The URL for the data center you want to communicate with. Possible choices are:
api-au.cronofy.com
- π¦πΊ Australiaapi-ca.cronofy.com
- π¨π¦ Canadaapi-de.cronofy.com
- π©πͺ Germanyapi-sg.cronofy.com
- πΈπ¬ Singaporeapi-uk.cronofy.com
- π¬π§ United Kingdomapi.cronofy.com
- πΊπΈ United States
Find out more about Cronofy's data centers.
bookable_event_id required #
Your application’s unique identifier for the Bookable Event as a String
.
Response parameters #
bookable_event_id #
Your application’s unique identifier for the Bookable Event as a String
.
start #
The start
time as a ISO8601 UTC Time
.
end #
The end
time is as a ISO8601 UTC Time
.
status #
A String
status for the event. Will be one of
confirmed
cancelled
registration.capacity #
An Integer
describing the maximum number of registrations that can be accepted by the Bookable Event.
A null
value, the default, indicates that an unlimited number of registrations can be added to the Bookable Event.
registration.registered_count #
An Integer
describing the current number of registrations that for the Bookable Event that are do not have a status of declined
or removed
.
registration.total_count #
An Integer
describing the total number of registrations for the Bookable Event including removed
and declined
.
registration.registrations #
An Array
of Registration objects. See Upsert Registration endpoint docs for details.
registration.pages #
An object that will be present if the number of pages of registrations exceeds one.