List events
GET/events
List events
Request
Query Parameters
pageinteger
Example:
1perPageinteger
Example:
1sortstring
Example:
-createdAtstatusstring
Example:
published200
Returns the owner's events
dataobject[]required
objectstring
idstring
slugstring
namestring
descriptionstring
categorystring
statusstring
visibilitystring
accessModestring
timezonestring
locationSettingstring
hideAddressUntilPurchaseboolean
featuredVideoUrlnullable
bookTextstring
collectInformationSettingstring
refundsAllowedboolean
orderAnswersEditableboolean
doorTimeMinutesnullable
showOccurrencesAsSeparateEventsboolean
tagsstring[]
registrationLimitinteger
currencystring
featuredImageUrlnullable
imagesundefined[]
themestring
seatsEventKeynullable
likeCountinteger
urlstring
createdAtstring
updatedAtstring
objectstringrequired
pageintegerrequired
totalPagesintegerrequired
perPageintegerrequired
totalCountintegerrequired
hasNextPagebooleanrequired
metaobjectrequired
requestIdstringrequired
Example: returns_the_owner's_events
{
"data": [
{
"object": "event",
"id": "786ee9ff-b264-432d-a700-3b2c2530f918",
"slug": "jazz-workshop",
"name": "Jazz Workshop",
"description": "A hands-on jazz workshop for all levels",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [
"jazz",
"contemporary"
],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 42,
"url": "http://www.viewcy.com/event/jazz-workshop",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "3782416a-630b-4116-8a7d-87583f90f2f4",
"slug": "piano-masterclass",
"name": "Piano Masterclass",
"description": "Advanced piano techniques and performance",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/piano-masterclass",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "ad21b3a1-2676-493e-9a3e-db57820a65fb",
"slug": "vocal-training",
"name": "Vocal Training",
"description": "Professional vocal training sessions",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/vocal-training",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "062a5e0a-bbea-4836-bfda-12407804b88f",
"slug": "draft-event",
"name": "Draft Event",
"description": "An unpublished draft event",
"category": "Events",
"status": "draft",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/draft-event",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "d7971452-a59e-4ec3-a0fa-5e1bb0aae340",
"slug": "activity-test-event",
"name": "Activity Test Event",
"description": "Event used for activity tracking tests",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/activity-test-event",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
}
],
"object": "list",
"page": 1,
"totalPages": 1,
"perPage": 25,
"totalCount": 5,
"hasNextPage": false,
"meta": {
"requestId": "00000000-0000-0000-0000-000000000000"
}
}Example: returns_filtered_and_sorted_events
{
"data": [
{
"object": "event",
"id": "786ee9ff-b264-432d-a700-3b2c2530f918",
"slug": "jazz-workshop",
"name": "Jazz Workshop",
"description": "A hands-on jazz workshop for all levels",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [
"jazz",
"contemporary"
],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 42,
"url": "http://www.viewcy.com/event/jazz-workshop",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "3782416a-630b-4116-8a7d-87583f90f2f4",
"slug": "piano-masterclass",
"name": "Piano Masterclass",
"description": "Advanced piano techniques and performance",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/piano-masterclass",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "ad21b3a1-2676-493e-9a3e-db57820a65fb",
"slug": "vocal-training",
"name": "Vocal Training",
"description": "Professional vocal training sessions",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/vocal-training",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
},
{
"object": "event",
"id": "d7971452-a59e-4ec3-a0fa-5e1bb0aae340",
"slug": "activity-test-event",
"name": "Activity Test Event",
"description": "Event used for activity tracking tests",
"category": "Events",
"status": "published",
"visibility": "listed",
"accessMode": "open",
"timezone": "America/New_York",
"locationSetting": "physical",
"hideAddressUntilPurchase": false,
"featuredVideoUrl": null,
"bookText": "Get tickets",
"collectInformationSetting": "only-buyer",
"refundsAllowed": false,
"orderAnswersEditable": false,
"doorTimeMinutes": null,
"showOccurrencesAsSeparateEvents": false,
"tags": [],
"registrationLimit": 0,
"currency": "usd",
"featuredImageUrl": null,
"images": [],
"theme": "dark",
"seatsEventKey": null,
"likeCount": 0,
"url": "http://www.viewcy.com/event/activity-test-event",
"createdAt": "2024-01-02T03:04:05+01:00",
"updatedAt": "2024-01-02T03:04:05+01:00"
}
],
"object": "list",
"page": 1,
"totalPages": 1,
"perPage": 25,
"totalCount": 4,
"hasNextPage": false,
"meta": {
"requestId": "00000000-0000-0000-0000-000000000000"
}
}401
Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_401
{
"object": "error",
"status": 401,
"message": "Authentication required",
"meta": {
"requestId": "00000000-0000-0000-0000-000000000000"
}
}