Skip to main content

This page is also available as plain markdown · OpenAPI spec

Get event

GET 
/events/:id

Get event

Request​

Path Parameters

    idstringrequired
    Example: 00000000-0000-0000-0000-000000000000

Query Parameters

    expandstring
    Example: bogusKey
    includestring
    Example: guestEmailMessage,bogusField

200

Returns the event
objectstringrequired
idstringrequired
slugstringrequired
namestringrequired
descriptionstringrequired
categorystringrequired
statusstringrequired
visibilitystringrequired
accessModestringrequired
timezonestringrequired
locationSettingstringrequired
hideAddressUntilPurchasebooleanrequired
featuredVideoUrlnullablerequired
bookTextstringrequired
collectInformationSettingstringrequired
refundsAllowedbooleanrequired
orderAnswersEditablebooleanrequired
doorTimeMinutesnullablerequired
showOccurrencesAsSeparateEventsbooleanrequired
tagsstring[]required
registrationLimitintegerrequired
currencystringrequired
featuredImageUrlnullablerequired
imagesstring[]required
themestringrequired
seatsEventKeystringnullablerequired
likeCountintegerrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
metaobjectrequired
requestIdstringrequired
scopeHintsobject[]
expandstring
missingScopestring
locationobject
objectstringrequired
idstringrequired
namestringrequired
addressstringrequired
citystringrequired
statestringrequired
stateCodenullablerequired
countrystringrequired
zipcodestringrequired
latnullablerequired
lngnullablerequired
googlePlaceIdnullablerequired
createdAtstringrequired
updatedAtstringrequired
urlstringrequired
occurrencesobject
objectstringrequired
urlstringrequired
dataobject[]required
objectstring
idstring
eventIdstring
startsAtstring
endsAtstring
canceledboolean
createdAtstring
updatedAtstring
recurringScheduleIdstringnullable
hasMorebooleanrequired
ticketsobject
objectstringrequired
urlstringrequired
dataobject[]required
objectstring
idstring
namestring
descriptionnullable
kindstring
attendanceTypestring
pricingModestring
pricenumber<float>
feenumber<float>
currencystring
quantitynullable
quantityPerOrdernullable
quantityPerMembernullable
quantityPerListnullable
secretCodenullable
salesStartAtnullable
salesEndHoursinteger
salesEndRulestring
transferAllowedboolean
showOnEventPageboolean
seatsCategoryKeysundefined[]
additionalEventIdsundefined[]
hiddenboolean
createdAtstring
updatedAtstring
occurrenceIdsnullable
hasMorebooleanrequired
collaboratorsobject
objectstringrequired
urlstringrequired
dataobject[]required
objectstring
idstring
namestring
typestring
avatarUrlstring
hasMorebooleanrequired
statsobject
objectstringrequired
availableCurrenciesundefined[]required
ticketsSoldintegerrequired
capacityintegerrequired
grossRevenuenumber<float>required
netRevenuenumber<float>required
netSalesOnlinenumber<float>required
netSalesTerminalnumber<float>required
netSalesCashnumber<float>required
netSalesTapToPaynumber<float>required
stripeFeesnumber<float>required
viewcyFeesnumber<float>required
refundedAmountnumber<float>required
freeTicketsintegerrequired
canceledTicketsintegerrequired
refundedTicketsintegerrequired
ticketsSoldOnlineintegerrequired
ticketsSoldTerminalintegerrequired
ticketsSoldCashintegerrequired
ticketsSoldTapToPayintegerrequired
donationsCountintegerrequired
donationsAmountnumber<float>required
ticketsStatsobjectrequired
ticketsobject[]required
namestring
kindstring
ticketsSoldinteger
ticketsAvailablenullable
revenueinteger
admissionTotalsobjectrequired
ticketsSoldintegerrequired
revenuenumber<float>required
addOnTotalsobjectrequired
ticketsSoldintegerrequired
revenueintegerrequired
promotersobject
objectstringrequired
dataobject[]required
objectstring
idstring
namestring
usernamenullable
viewCountinteger
revenuenumber<float>
ticketsSoldinteger
currencystring
hasMorebooleanrequired
guestEmailMessagestring
donorEmailMessagestring
Example: returns_the_event
{
  "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",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}
Example: returns_the_event_with_expanded_fields
{
  "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": 100,
  "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",
  "location": {
    "object": "location",
    "id": "7a032daf-0999-4e23-8ef5-dfd2fb0c5097",
    "name": "Main Studio",
    "address": "123 Main St",
    "city": "New York",
    "state": "New York",
    "stateCode": null,
    "country": "US",
    "zipcode": "10001",
    "lat": null,
    "lng": null,
    "googlePlaceId": null,
    "createdAt": "2024-01-02T03:04:05+01:00",
    "updatedAt": "2024-01-02T03:04:05+01:00",
    "url": "http://api.viewcy.com/2025_06/locations/7a032daf-0999-4e23-8ef5-dfd2fb0c5097"
  },
  "occurrences": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/786ee9ff-b264-432d-a700-3b2c2530f918/occurrences",
    "data": [
      {
        "object": "occurrence",
        "id": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
        "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
        "startsAt": "2025-06-11T18:00:00Z",
        "endsAt": "2025-06-11T20:00:00Z",
        "canceled": false,
        "createdAt": "2024-01-02T03:04:05+01:00",
        "updatedAt": "2024-01-02T03:04:05+01:00",
        "recurringScheduleId": null
      },
      {
        "object": "occurrence",
        "id": "4b34a47d-6204-4454-982e-79c0c0533646",
        "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
        "startsAt": "2025-06-12T18:00:00Z",
        "endsAt": "2025-06-12T20:00:00Z",
        "canceled": false,
        "createdAt": "2024-01-02T03:04:05+01:00",
        "updatedAt": "2024-01-02T03:04:05+01:00",
        "recurringScheduleId": "0c7e95d4-58b0-4a7e-9f3a-1f2b6f9f3a01"
      }
    ],
    "hasMore": false
  },
  "tickets": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/786ee9ff-b264-432d-a700-3b2c2530f918/tickets",
    "data": [
      {
        "object": "ticket",
        "id": "d44c2c29-67b7-4933-aa0d-536a469aa1fb",
        "name": "VIP Pass",
        "description": null,
        "kind": "paid_pass",
        "attendanceType": "in_person",
        "pricingMode": "fixed",
        "price": 29.99,
        "fee": 0,
        "currency": "usd",
        "quantity": null,
        "quantityPerOrder": null,
        "quantityPerMember": null,
        "quantityPerList": null,
        "secretCode": null,
        "salesStartAt": null,
        "salesEndHours": 0,
        "salesEndRule": "beforeEvent",
        "transferAllowed": true,
        "showOnEventPage": false,
        "seatsCategoryKeys": [],
        "additionalEventIds": [],
        "hidden": false,
        "createdAt": "2024-01-02T03:04:05+01:00",
        "updatedAt": "2024-01-02T03:04:05+01:00",
        "occurrenceIds": null
      },
      {
        "object": "ticket",
        "id": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
        "name": "General Admission",
        "description": null,
        "kind": "paid_pass",
        "attendanceType": "in_person",
        "pricingMode": "fixed",
        "price": 9.99,
        "fee": 0,
        "currency": "usd",
        "quantity": null,
        "quantityPerOrder": null,
        "quantityPerMember": null,
        "quantityPerList": null,
        "secretCode": null,
        "salesStartAt": null,
        "salesEndHours": 0,
        "salesEndRule": "beforeEvent",
        "transferAllowed": true,
        "showOnEventPage": false,
        "seatsCategoryKeys": [],
        "additionalEventIds": [],
        "hidden": false,
        "createdAt": "2024-01-02T03:04:05+01:00",
        "updatedAt": "2024-01-02T03:04:05+01:00",
        "occurrenceIds": null
      }
    ],
    "hasMore": false
  },
  "collaborators": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/786ee9ff-b264-432d-a700-3b2c2530f918/collaborators",
    "data": [
      {
        "object": "collaborator",
        "id": "005e8d2d-df26-4d5d-a3e0-8b3d346cc1e4",
        "name": "Jazz Collaborator",
        "type": "User",
        "avatarUrl": ""
      }
    ],
    "hasMore": false
  },
  "stats": {
    "object": "event_stats",
    "availableCurrencies": [],
    "ticketsSold": 0,
    "capacity": 100,
    "grossRevenue": 100,
    "netRevenue": 100,
    "netSalesOnline": 100,
    "netSalesTerminal": 0,
    "netSalesCash": 0,
    "netSalesTapToPay": 0,
    "stripeFees": 0,
    "viewcyFees": 0,
    "refundedAmount": 0,
    "freeTickets": 0,
    "canceledTickets": 0,
    "refundedTickets": 0,
    "ticketsSoldOnline": 0,
    "ticketsSoldTerminal": 0,
    "ticketsSoldCash": 0,
    "ticketsSoldTapToPay": 0,
    "donationsCount": 0,
    "donationsAmount": 0,
    "ticketsStats": {
      "tickets": [
        {
          "name": "General Admission",
          "kind": "admission",
          "ticketsSold": 0,
          "ticketsAvailable": null,
          "revenue": 0
        },
        {
          "name": "VIP Pass",
          "kind": "admission",
          "ticketsSold": 0,
          "ticketsAvailable": null,
          "revenue": 0
        }
      ],
      "admissionTotals": {
        "ticketsSold": 0,
        "revenue": 0
      },
      "addOnTotals": {
        "ticketsSold": 0,
        "revenue": 0
      }
    }
  },
  "promoters": {
    "object": "list",
    "data": [
      {
        "object": "event_promo_link",
        "id": "ea49141e-0a75-4a0b-b582-85c91adbbc59",
        "name": "Event Promoter",
        "username": null,
        "viewCount": 150,
        "revenue": 0,
        "ticketsSold": 0,
        "currency": "usd"
      }
    ],
    "hasMore": 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"
  }
}

404

Returns 404 for non-existent event
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_event
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}