v1

latestOpenAPI 3.0.02026-07-2688129326.6 KB
attendee resource

Get attendee resource

get/v1/organizers/{organizerId}/events/{eventId}/attendees/{attendeeId}

Path parameters

organizerIdstring objectId required

Resource identifier.

eventIdstring objectId required

Resource identifier.

attendeeIdstring objectId required

Resource identifier.

Response

Success

ticketUidstring nullable
emailstring email required
{"stackTrail":"components:schemas:attendee:properties:productId","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:attendee:properties:productKey","oasType":"schema","type":"unknown"}
productType'ticket' | 'good' required
status'enabled' | 'pending' | 'disabled' | 'used' | 'resold' | 'refunded' required
{"stackTrail":"components:schemas:attendee:properties:orderId","oasType":"schema","type":"unknown"}
{"stackTrail":"components:schemas:attendee:properties:shopId","oasType":"schema","type":"unknown","nullable":true}
messageReferencestring nullable
locale'fr' | 'en' | 'es' nullable
{"stackTrail":"components:schemas:attendee:properties:discountId","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:attendee:properties:sellingItemKey","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:attendee:properties:formResponseId","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:attendee:properties:sellingItemFormResponseId","oasType":"schema","type":"unknown","nullable":true}
{"stackTrail":"components:schemas:attendee:properties:orderFormResponseId","oasType":"schema","type":"unknown","nullable":true}
clientReferencestring nullable
pricenumber required
interactionCountnumber required
accessTokenstring nullable
{"stackTrail":"components:schemas:attendee:properties:linkedProductKey","oasType":"schema","type":"unknown","nullable":true}
_idstring objectId required
_createdAtstring date-time required
_updatedAtstring date-time nullable
_referencestring nullable

Example response

{
  "ticketUid": "string",
  "email": "user@example.com",
  "productType": "ticket",
  "status": "enabled",
  "seat": {
    "seatLabel": "string"
  },
  "messageReference": "string",
  "locale": "fr",
  "clientReference": "string",
  "accessToken": "string",
  "_id": "64b7f8b6f23a4a4f3d0a9b12",
  "_createdAt": "2024-01-01T00:00:00.000Z",
  "_updatedAt": "2024-01-01T00:00:00.000Z",
  "_reference": "string"
}