Skip to main content

This page is also available as plain markdown · OpenAPI spec

Get registration

GET 
/registrations/:id

Get registration

Request​

Path Parameters

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

Query Parameters

    expandstring
    Example: answers

200

Returns the registration with expanded fields
objectstringrequired
idstringrequired
statusstringrequired
checkedInAtstringnullablerequired
attendeeobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
seatstringnullablerequired
relatedRegistrationIdsstring[]required
eventIdstringrequired
occurrenceIdstringrequired
ticketIdstringrequired
orderIdstringrequired
createdAtstringrequired
updatedAtstringrequired
metaobjectrequired
requestIdstringrequired
scopeHintsobject[]
expandstring
missingScopestring
eventobject
objectstringrequired
idstringrequired
slugstringrequired
namestringrequired
descriptionstringrequired
categorystringrequired
statusstringrequired
visibilitystringrequired
accessModestringrequired
timezonestringrequired
locationSettingstringrequired
hideAddressUntilPurchasebooleanrequired
featuredVideoUrlnullablerequired
bookTextstringrequired
collectInformationSettingstringrequired
refundsAllowedbooleanrequired
orderAnswersEditablebooleanrequired
doorTimeMinutesnullablerequired
showOccurrencesAsSeparateEventsbooleanrequired
tagsstring[]required
registrationLimitintegerrequired
currencystringrequired
featuredImageUrlnullablerequired
imagesundefined[]required
themestringrequired
seatsEventKeynullablerequired
likeCountintegerrequired
urlstringrequired
createdAtstringrequired
updatedAtstringrequired
occurrenceobject
objectstringrequired
idstringrequired
eventIdstringrequired
startsAtstringrequired
endsAtstringrequired
canceledbooleanrequired
createdAtstringrequired
updatedAtstringrequired
recurringScheduleIdnullablerequired
ticketobject
objectstringrequired
idstringrequired
namestringrequired
descriptionnullablerequired
kindstringrequired
attendanceTypestringrequired
pricingModestringrequired
pricenumber<float>required
feenumber<float>required
currencystringrequired
quantitynullablerequired
quantityPerOrdernullablerequired
quantityPerMembernullablerequired
quantityPerListnullablerequired
secretCodenullablerequired
salesStartAtnullablerequired
salesEndHoursintegerrequired
salesEndRulestringrequired
transferAllowedbooleanrequired
showOnEventPagebooleanrequired
seatsCategoryKeysundefined[]required
additionalEventIdsundefined[]required
hiddenbooleanrequired
createdAtstringrequired
updatedAtstringrequired
occurrenceIdsnullablerequired
orderobject
objectstringrequired
idstringrequired
datestringrequired
createdAtstringrequired
updatedAtstringrequired
amountnumber<float>required
currencystringrequired
paymentMethodstringrequired
statusstringrequired
customerobjectrequired
firstNamestringrequired
lastNamestringrequired
emailstringrequired
productobjectrequired
idstringrequired
namestringrequired
typestringrequired
datestringrequired
paymentDetailsobjectrequired
subtotalnumber<float>required
discountsnumber<float>required
donationnumber<float>required
totalnumber<float>required
viewcyFeenumber<float>required
stripeFeenumber<float>required
refundedAmountnumber<float>required
netAmountnumber<float>required
refundablenullablerequired
answersobject[]
questionIdstring
fieldTypestring
titlestring
contentstringnullable
Example: returns_the_registration
{
  "object": "registration",
  "id": "acfa16ec-1a09-4d67-85f6-b7db0afb4759",
  "status": "active",
  "checkedInAt": "2025-06-11T19:05:00Z",
  "attendee": {
    "firstName": "Alice",
    "lastName": "Patron",
    "email": "alice@example.com"
  },
  "seat": "A-12",
  "relatedRegistrationIds": [],
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T339434021",
  "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_registration_with_expanded_fields
{
  "object": "registration",
  "id": "acfa16ec-1a09-4d67-85f6-b7db0afb4759",
  "status": "active",
  "checkedInAt": "2025-06-11T19:05:00Z",
  "attendee": {
    "firstName": "Alice",
    "lastName": "Patron",
    "email": "alice@example.com"
  },
  "seat": "A-12",
  "relatedRegistrationIds": [],
  "eventId": "786ee9ff-b264-432d-a700-3b2c2530f918",
  "occurrenceId": "88552da2-eed1-4d2f-9a59-0bb9a816f0b8",
  "ticketId": "a402c255-ccc9-4229-b337-e88d4f0cce0a",
  "orderId": "T339434021",
  "createdAt": "2024-01-02T03:04:05+01:00",
  "updatedAt": "2024-01-02T03:04:05+01:00",
  "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"
  },
  "occurrence": {
    "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
  },
  "ticket": {
    "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
  },
  "order": {
    "object": "order",
    "id": "T339434021",
    "date": "2025-03-15T12:00:00Z",
    "createdAt": "2024-01-02T03:04:05+01:00",
    "updatedAt": "2024-01-02T03:04:05+01:00",
    "amount": 100,
    "currency": "usd",
    "paymentMethod": "stripe",
    "status": "completed",
    "customer": {
      "firstName": "Alice",
      "lastName": "Patron",
      "email": "alice@example.com"
    },
    "product": {
      "id": "jazz-workshop",
      "name": "Jazz Workshop",
      "type": "Course",
      "date": "2025-06-11T18:00:00Z"
    },
    "paymentDetails": {
      "subtotal": 100,
      "discounts": 0,
      "donation": 0,
      "total": 100,
      "viewcyFee": 10,
      "stripeFee": 5,
      "refundedAmount": 0,
      "netAmount": 85
    },
    "refundable": null
  },
  "answers": [
    {
      "questionId": "e1407e9e-0409-4013-9e5f-05e1448c8f0c",
      "fieldType": "short_text",
      "title": "What's your stage name?",
      "content": "Alice A."
    },
    {
      "questionId": "3c94ba56-7c32-4037-a27a-adc6a10e453f",
      "fieldType": "text",
      "title": "Tell us about your musical background",
      "content": null
    },
    {
      "questionId": "750f288a-9909-49ff-a455-f04dfa4bcc5d",
      "fieldType": "dropdown",
      "title": "Meal preference",
      "content": "Vegan"
    },
    {
      "questionId": "a17c5c97-e764-4916-8029-e7e54819b574",
      "fieldType": "terms",
      "title": "Terms and conditions",
      "content": "true"
    },
    {
      "questionId": "b3c2e3d2-f40d-45b4-b1a6-81e922e74cf8",
      "fieldType": "address",
      "title": "Mailing address",
      "content": "{\"line1\":\"123 Main St\",\"city\":\"Brooklyn\",\"state\":\"NY\",\"postalCode\":\"11201\",\"country\":\"US\"}"
    },
    {
      "questionId": "f63c4866-a7cb-4ff3-b9ce-139deb76774d",
      "fieldType": "phone",
      "title": "Phone number",
      "content": "+12125551234"
    }
  ],
  "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 registration
objectstringrequired
statusintegerrequired
messagestringrequired
metaobjectrequired
requestIdstringrequired
Example: returns_404_for_non-existent_registration
{
  "object": "error",
  "status": 404,
  "message": "Resource not found",
  "meta": {
    "requestId": "00000000-0000-0000-0000-000000000000"
  }
}