Events - List by state
GET /events/v2/{bucket}/bookings/{state}
GET
/events/v2/{bucket}/bookings/{state}
All events by their status, note this is a summary packet, call individual events for full details
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” bucket
required
The bucket (client) name
string
Example
example state
required
string
The state or classification
Query Parameters
Section titled “Query Parameters ” page_size
integer
page
integer
Responses
Section titled “ Responses ”A list of events
object
bookings
Array
object
attendee_questions
Array<object>
object
question
string
auto_forms
boolean
balance
number format: float
bar_notes
string
bar_requested
boolean
bar_type
string
base_record_last_updated
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 billing_contact
string
bookable_refs
Array<string>
booking_contact
string
booking_organisation
string
booking_reference
string
booking_type
string
buyer_handling
string
cancelled
boolean
capacity
number
category
string
catering
boolean
catering_by
string
catering_notes
string
catering_support
boolean
checklist
Array<string>
conferencing_instructions
string
conferencing_url
string
connection_type_counter
object
key
additional properties
number
contacts
Array<string>
controller
string
created
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 date_range
string
dates_to_be_confirmed
boolean
delivered_by
string
delivered_by_background
string
delivered_by_photo
string
description
string
dietary_requirements
string
display_value
string
end_date
A date in the format YYYY-MM-DD
string
Example
2020-01-01 end_datetime
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 end_time
A date in the format HH:MM
string
Example
11:27 enquiry
boolean
enquiry_date
A date in the format YYYY-MM-DD
string
Example
2020-01-01 est_numbers
number
event_type
string
eventbrite_id
string
eventbrite_last_sync
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 external_boxoffice_link
A fully qualified URL including the protocol e.g. https
string
Example
https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg external_image
A fully qualified URL including the protocol e.g. https
string
Example
https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg external_web_link
A fully qualified URL including the protocol e.g. https
string
Example
https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg extras
string
featured
boolean
files
Array<string>
filming
boolean
formatted_connections
Array<string>
formatted_title
string
group
Array<object>
object
display_value
string
ref
URIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
string
Example
/example/person/6305f074683e800f3abe809e/ group_member_connections
Array<string>
guest_support
boolean
has_available_tickets
boolean
has_bar_requested
boolean
has_cancelled
boolean
has_catering
boolean
has_catering_support
boolean
has_enquiry
boolean
has_filming
boolean
has_guest_support
boolean
has_latecomers_allowed
boolean
has_media_support
boolean
has_music
boolean
has_photography
boolean
has_staffed_event
boolean
has_ticketed_event
boolean
hide_banners
boolean
hide_from_self_service
boolean
important_information_for_attendees
string
invoice_count
number
invoice_currency
string
invoice_items
number
invoice_status
string
invoice_total
number
invoice_total_inc_tax
number
invoices
Array<string>
is_sold_out
boolean
last_updated
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 last_venue_update
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 latecomers_allowed
boolean
latecomers_policy
string
layout_notes
string
layout_requirements
string
legacy_uid
string
length
string
length_display
string
length_hours
number
lifecycle_emails
boolean
linked_member_connections
Array<string>
location
string
location_address_string
string
location_attendee_notes
string
location_country
string
location_postal_code
string
map_zoom_level
number
maximum_ticket_price
number
media_notes
string
media_support
boolean
member_only_event
boolean
menu_notes
string
minimum_ticket_price
number
moodle_id
string
multi_day
boolean
music
boolean
next_activity_date
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 notes
string
order_questions
Array<object>
object
question
string
pay_later
boolean
photo
A fully qualified URL including the protocol e.g. https
string
Example
https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg photography
boolean
playlist
string
post_event_information
string
post_event_url
string
progress
number
proposed_dates
Array<string>
resource_type
string
secondary_photos
Array<string>
self_service_attendee_details
string
series_id
string
setup_notes
string
show_map
boolean
slug
string
staffed_event
boolean
start_date
A date in the format YYYY-MM-DD
string
Example
2020-01-01 start_datetime
A date in the format YYYY-MM-DDTHH:MM:SS.mmmmmm
string
Example
2023-09-05T11:27:06.437000 start_sales_date
A date in the format YYYY-MM-DD
string
Example
2020-01-01 start_time
A date in the format HH:MM
string
Example
11:27 status
string
subcategory
string
tags
Array<string>
takedown_notes
string
ticket_buyer_form_per_contact
Array<object>
object
ticket_buyer_form_per_order
Array<object>
object
ticket_choices
Array<object>
object
ticket_stock_control
boolean
ticket_type_income
object
key
additional properties
number
ticket_types
object
key
additional properties
object
ticketed_event
boolean
timing_notes
string
title
string
total_stock
number
total_stock_allocated
number
total_stock_available
number
uid
Usually the final element in the URI, an alphanumeric unique identifier
string
Example
6305f074683e800f3abe809e uri
URIs are unique identifiers for resources in the system,
they are structured as follows /bucket/resource_type/uid/
string
Example
/example/person/6305f074683e800f3abe809e/ use_access_code
boolean
user_interface
object
can_cancel_event
boolean
can_change_app_visibility
boolean
can_change_dates
boolean
can_control_stock
boolean
can_delete
boolean
can_disable_ticket_stock_control
boolean
can_duplicate
boolean
can_edit_booking_details
boolean
can_edit_booking_group
boolean
can_edit_images
boolean
can_edit_location
boolean
can_edit_questions
boolean
can_enable_ticket_stock_control
boolean
can_view_in_app
boolean
show_eventbrite_link
boolean
venue_handling
string
venue_refs
Array<string>
venues
Array<string>
waitlist_available
boolean
website
A fully qualified URL including the protocol e.g. https
string
Example
https://s3-eu-west-1.amazonaws.com/sheepcrm/example/vehicle/63ceaeacd403a64149a3de0c/photo/mycar.jpg xero_account_code
string
A standard error message
Authentication error