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: 4331323f-633e-48be-a2ef-7960285bcc9f

Query Parameters

    expandstring
    Example: stats

200

Returns the event with expanded fields
objectstringrequired
idstringrequired
slugstringrequired
namestringrequired
descriptionstringrequired
statusstringrequired
visibilitystringrequired
accessModestringrequired
timezonestringrequired
locationSettingstringrequired
featuredVideoUrlnullablerequired
bookTextstringrequired
tagsstring[]required
registrationLimitintegerrequired
currencystringrequired
featuredImageUrlnullablerequired
imagesstring[]required
themestringrequired
seatsEventKeystringnullablerequired
likeCountintegerrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
locationobject
objectstringrequired
idstringrequired
namestringrequired
addressstringrequired
citystringrequired
statestringrequired
stateCodestringrequired
countrystringrequired
zipcodestringrequired
latnullablerequired
lngnullablerequired
googlePlaceIdnullablerequired
createdAtstringrequired
updatedAtstringrequired
urlstringrequired
occurrencesobject
objectstringrequired
urlstringrequired
dataobject[]required
objectstring
idstring
eventIdstring
startsAtstringnullable
endsAtstringnullable
canceledboolean
createdAtstring
updatedAtstring
hasMorebooleanrequired
ticketsobject
objectstringrequired
urlstringrequired
dataobject[]required
objectstring
idstring
namestring
descriptionnullable
kindstring
attendanceTypestring
visibilityScopestring
pricingModestring
pricenumber<float>
feenumber<float>
currencystring
quantitynullable
quantityPerOrdernullable
startsAtstring
archivedboolean
createdAtstring
updatedAtstring
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
revenueinteger<float>required
addOnTotalsobjectrequired
ticketsSoldintegerrequired
revenueintegerrequired
promotersobject
objectstringrequired
dataobject[]required
objectstring
idstring
namestring
usernamestring
viewCountinteger
revenuenumber<float>
ticketsSoldinteger
currencystring
hasMorebooleanrequired
Example: returns_the_event
{
  "object": "event",
  "id": "9c00d932-9818-435e-89f9-0f92b1f18bdc",
  "slug": "jazz-workshop",
  "name": "Jazz Workshop",
  "description": "Learn the basics of this 3 part tutorial",
  "status": "published",
  "visibility": "listed",
  "accessMode": "open",
  "timezone": "Eastern Time (US & Canada)",
  "locationSetting": "physical",
  "featuredVideoUrl": null,
  "bookText": "Get tickets",
  "tags": [],
  "registrationLimit": 0,
  "currency": "usd",
  "featuredImageUrl": null,
  "images": [],
  "theme": "dark",
  "seatsEventKey": null,
  "likeCount": 42,
  "url": "http://www.viewcy.com/event/jazz-workshop",
  "createdAt": "2026-03-24T16:09:56Z",
  "updatedAt": "2026-03-24T16:09:56Z"
}
Example: returns_the_event_with_expanded_fields
{
  "object": "event",
  "id": "4b8f4216-a34c-43c2-a0f0-7f2326bff432",
  "slug": "my_event",
  "name": "My Event",
  "description": "Learn the basics of this 3 part tutorial",
  "status": "published",
  "visibility": "listed",
  "accessMode": "open",
  "timezone": "Eastern Time (US & Canada)",
  "locationSetting": "physical",
  "featuredVideoUrl": null,
  "bookText": "Get tickets",
  "tags": [
    "music",
    "workshop"
  ],
  "registrationLimit": 100,
  "currency": "usd",
  "featuredImageUrl": null,
  "images": [],
  "theme": "light",
  "seatsEventKey": null,
  "likeCount": 0,
  "url": "http://www.viewcy.com/event/my_event",
  "createdAt": "2026-03-24T16:09:57Z",
  "updatedAt": "2026-03-24T16:09:57Z",
  "location": {
    "object": "location",
    "id": "e0fdfbea-6601-4e22-9864-238049da605f",
    "name": "Test Location",
    "address": "Address 5",
    "city": "Kingston",
    "state": "New York",
    "stateCode": "NY",
    "country": "US",
    "zipcode": "12401",
    "lat": null,
    "lng": null,
    "googlePlaceId": null,
    "createdAt": "2026-03-24T16:09:57Z",
    "updatedAt": "2026-03-24T16:09:57Z",
    "url": "http://api.viewcy.com/2025_06/locations/e0fdfbea-6601-4e22-9864-238049da605f"
  },
  "occurrences": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/4b8f4216-a34c-43c2-a0f0-7f2326bff432/occurrences",
    "data": [
      {
        "object": "occurrence",
        "id": "7f855eb2-40ca-4477-b55d-616c773bdfdf",
        "eventId": "4b8f4216-a34c-43c2-a0f0-7f2326bff432",
        "startsAt": "2025-06-11T18:00:00Z",
        "endsAt": "2025-06-11T20:00:00Z",
        "canceled": false,
        "createdAt": "2026-03-24T16:09:57Z",
        "updatedAt": "2026-03-24T16:09:57Z"
      },
      {
        "object": "occurrence",
        "id": "5f8ff99c-a515-4e9e-9c2a-78c7a1135cde",
        "eventId": "4b8f4216-a34c-43c2-a0f0-7f2326bff432",
        "startsAt": "2025-06-12T18:00:00Z",
        "endsAt": "2025-06-12T20:00:00Z",
        "canceled": false,
        "createdAt": "2026-03-24T16:09:57Z",
        "updatedAt": "2026-03-24T16:09:57Z"
      }
    ],
    "hasMore": false
  },
  "tickets": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/4b8f4216-a34c-43c2-a0f0-7f2326bff432/tickets",
    "data": [
      {
        "object": "ticket",
        "id": "afd0709e-9473-4c7a-bf20-9c8678565eeb",
        "name": "General Admission",
        "description": null,
        "kind": "paid_pass",
        "attendanceType": "in-person",
        "visibilityScope": "standard",
        "pricingMode": "fixed",
        "price": 10,
        "fee": 1,
        "currency": "usd",
        "quantity": null,
        "quantityPerOrder": null,
        "startsAt": "2021-01-01T00:00:00Z",
        "archived": false,
        "createdAt": "2026-03-24T16:09:57Z",
        "updatedAt": "2026-03-24T16:09:57Z"
      },
      {
        "object": "ticket",
        "id": "bbf735f1-f8ef-4331-9eed-92ad9bb362e0",
        "name": "Free Pass",
        "description": null,
        "kind": "free_pass",
        "attendanceType": "in-person",
        "visibilityScope": "standard",
        "pricingMode": "fixed",
        "price": 0,
        "fee": 0,
        "currency": "usd",
        "quantity": null,
        "quantityPerOrder": null,
        "startsAt": "2021-01-01T00:00:00Z",
        "archived": false,
        "createdAt": "2026-03-24T16:09:57Z",
        "updatedAt": "2026-03-24T16:09:57Z"
      }
    ],
    "hasMore": false
  },
  "collaborators": {
    "object": "list",
    "url": "http://api.viewcy.com/2025_06/events/4b8f4216-a34c-43c2-a0f0-7f2326bff432/collaborators",
    "data": [
      {
        "object": "collaborator",
        "id": "20553b74-500a-4dbb-bc06-5649614aa24a",
        "name": "John Smith",
        "type": "User",
        "avatarUrl": ""
      }
    ],
    "hasMore": false
  },
  "stats": {
    "object": "event_stats",
    "availableCurrencies": [],
    "ticketsSold": 0,
    "capacity": 100,
    "grossRevenue": 0,
    "netRevenue": 0,
    "netSalesOnline": 0,
    "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": "Free 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_promoter",
        "id": "bf4ed1dd-73fb-4b11-8b6d-4c3af09e842a",
        "name": "John Smith",
        "username": "johnsmith2",
        "viewCount": 5,
        "revenue": 0,
        "ticketsSold": 0,
        "currency": "usd"
      }
    ],
    "hasMore": false
  }
}

401

Returns 401
objectstringrequired
statusintegerrequired
messagestringrequired
Example: returns_401
{
  "object": "error",
  "status": 401,
  "message": "Authentication required"
}

404

Returns 404 for non-existent event
objectstringrequired
statusintegerrequired
messagestringrequired
Example: returns_404_for_non-existent_event
{
  "object": "error",
  "status": 404,
  "message": "Resource not found"
}