# Attendee

## GET /public-api/v1/event/{eventId}/attendee

> List attendees for an event

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"qrCodeToken":{"type":["string","null"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"roleTags":{"type":"array","items":{"type":"string","enum":["organizer","host","speaker","exhibitor","booth-rep","visitor","system"]}},"status":{"type":"string","enum":["invited","registered","attended","magic-link"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"firstEnteredWebAppAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"registeredAt":{"type":["string","null"],"format":"date-time"},"attendedAt":{"type":["string","null"],"format":"date-time"},"checkInMethod":{"type":["string","null"],"enum":["walk_in","check_in","qr_code","search"]},"checkedInAt":{"type":["string","null"],"format":"date-time"},"approvalStatus":{"type":["string","null"],"enum":["waitlisted","approved","rejected"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedAt":{"type":["string","null"],"format":"date-time"},"magicLinkUrl":{"type":["string","null"]},"qrCodeLinkUrl":{"type":["string","null"]},"ticketClassId":{"type":["string","null"],"format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"additionalProperties":false}},"attendeeTagIdList":{"type":"array","items":{"type":"string","format":"uuid"}},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."},"rawData":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"rsvpStatus":{"type":["string","null"],"enum":["pending","invited","registered","rejected","not-applicable"]},"orderId":{"type":["string","null"],"format":"uuid"}},"additionalProperties":false}},"pagination":{"type":"object","properties":{"page":{"type":"number","format":"float","description":"Current page number"},"pageSize":{"type":"number","format":"float","description":"Number of items per page"},"pageCount":{"type":"number","format":"float","description":"Total number of pages"},"totalCount":{"type":"number","format":"float","description":"Total number of items"}},"required":["page","pageSize","pageCount","totalCount"],"additionalProperties":false}},"required":["dataList","pagination"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"number","format":"float","default":1,"minimum":1},"name":"page","in":"query"},{"schema":{"type":"number","format":"float","default":25,"maximum":100,"minimum":1},"name":"pageSize","in":"query"},{"schema":{"type":"string","default":"-id"},"description":"Multiple Sort syntax \"-\" DESC, Empty for ASC, Available sorts: id, name, firstName, lastName, createdAt, updatedAt, registeredAt, areaCode, contactNo, email, jobTitle, organization, city, country, suspendStatus, registrationStatus, attendedAt, approvalStatus, approvedAt, rejectedAt, attendee_tag_id","name":"sort","in":"query"},{"schema":{},"name":"attendeeIds","in":"query"},{"schema":{"type":"string","format":"date-time"},"name":"createdAt$gt","in":"query"},{"schema":{},"name":"customFields","in":"query"},{"schema":{"type":"string"},"name":"q","in":"query"},{"schema":{},"name":"customFieldSearch","in":"query"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"getPaginatedAttendeeByEventId","summary":"List attendees for an event"}}}}
```

## Bulk create or update attendees

> Accepts an array of attendee objects. Provide an \`id\` to update an existing attendee; omit it to create a new one. The deprecated \`status\` field maps to \`registrationStatus\`. Returns all upserted attendees in a flat list.

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/bulk-upsert":{"put":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"qrCodeToken":{"type":["string","null"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"roleTags":{"type":"array","items":{"type":"string","enum":["organizer","host","speaker","exhibitor","booth-rep","visitor","system"]}},"status":{"type":"string","enum":["invited","registered","attended","magic-link"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"firstEnteredWebAppAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"registeredAt":{"type":["string","null"],"format":"date-time"},"attendedAt":{"type":["string","null"],"format":"date-time"},"checkInMethod":{"type":["string","null"],"enum":["walk_in","check_in","qr_code","search"]},"checkedInAt":{"type":["string","null"],"format":"date-time"},"approvalStatus":{"type":["string","null"],"enum":["waitlisted","approved","rejected"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedAt":{"type":["string","null"],"format":"date-time"},"magicLinkUrl":{"type":["string","null"]},"qrCodeLinkUrl":{"type":["string","null"]},"ticketClassId":{"type":["string","null"],"format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"additionalProperties":false}},"attendeeTagIdList":{"type":"array","items":{"type":"string","format":"uuid"}},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."},"rawData":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"rsvpStatus":{"type":["string","null"],"enum":["pending","invited","registered","rejected","not-applicable"]},"orderId":{"type":["string","null"],"format":"uuid"}},"additionalProperties":false}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"bulkUpsertAttendeeByEventId","summary":"Bulk create or update attendees","description":"Accepts an array of attendee objects. Provide an `id` to update an existing attendee; omit it to create a new one. The deprecated `status` field maps to `registrationStatus`. Returns all upserted attendees in a flat list.","requestBody":{"content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","description":"When provide resource Id, it will update the resource, otherwise it will create a new resource"},"status":{"type":"string","enum":["registered","invited"],"description":"Deprecated. Will be removed at 2025 July, use `registrationStatus` instead. Can't be used together with `registrationStatus`"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"minItems":1}}}}}}}}
```

## Remove attendees from an event

> Cancels attendee registrations and marks them as removed. This is a soft delete; attendee records are retained but hidden from normal queries.

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/bulk-remove":{"delete":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"bulkRemoveAttendeeByEventId","summary":"Remove attendees from an event","description":"Cancels attendee registrations and marks them as removed. This is a soft delete; attendee records are retained but hidden from normal queries.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```

## Permanently delete attendees

> Permanently deletes attendee records from the database. Unlike bulk remove, this is irreversible.

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/bulk-delete":{"delete":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{},"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"bulkDeleteAttendeeByEventId","summary":"Permanently delete attendees","description":"Permanently deletes attendee records from the database. Unlike bulk remove, this is irreversible.","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"attendeeIds":{"type":"array","items":{"type":"string","format":"uuid"}}},"required":["attendeeIds"],"additionalProperties":false}}}}}}}}
```

## GET /public-api/v1/event/{eventId}/attendee/{attendeeId}

> Get an attendee by ID

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/{attendeeId}":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"qrCodeToken":{"type":["string","null"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"roleTags":{"type":"array","items":{"type":"string","enum":["organizer","host","speaker","exhibitor","booth-rep","visitor","system"]}},"status":{"type":"string","enum":["invited","registered","attended","magic-link"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"firstEnteredWebAppAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"registeredAt":{"type":["string","null"],"format":"date-time"},"attendedAt":{"type":["string","null"],"format":"date-time"},"checkInMethod":{"type":["string","null"],"enum":["walk_in","check_in","qr_code","search"]},"checkedInAt":{"type":["string","null"],"format":"date-time"},"approvalStatus":{"type":["string","null"],"enum":["waitlisted","approved","rejected"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedAt":{"type":["string","null"],"format":"date-time"},"magicLinkUrl":{"type":["string","null"]},"qrCodeLinkUrl":{"type":["string","null"]},"ticketClassId":{"type":["string","null"],"format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"additionalProperties":false}},"attendeeTagIdList":{"type":"array","items":{"type":"string","format":"uuid"}},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."},"rawData":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"rsvpStatus":{"type":["string","null"],"enum":["pending","invited","registered","rejected","not-applicable"]},"orderId":{"type":["string","null"],"format":"uuid"}},"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"attendeeId","in":"path"}],"tags":["Attendee"],"operationId":"getAttendeeById","summary":"Get an attendee by ID"}}}}
```

## PATCH /public-api/v1/event/{eventId}/attendee/{attendeeId}

> Partially update an attendee

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/{attendeeId}":{"patch":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"qrCodeToken":{"type":["string","null"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"roleTags":{"type":"array","items":{"type":"string","enum":["organizer","host","speaker","exhibitor","booth-rep","visitor","system"]}},"status":{"type":"string","enum":["invited","registered","attended","magic-link"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"firstEnteredWebAppAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"registeredAt":{"type":["string","null"],"format":"date-time"},"attendedAt":{"type":["string","null"],"format":"date-time"},"checkInMethod":{"type":["string","null"],"enum":["walk_in","check_in","qr_code","search"]},"checkedInAt":{"type":["string","null"],"format":"date-time"},"approvalStatus":{"type":["string","null"],"enum":["waitlisted","approved","rejected"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedAt":{"type":["string","null"],"format":"date-time"},"magicLinkUrl":{"type":["string","null"]},"qrCodeLinkUrl":{"type":["string","null"]},"ticketClassId":{"type":["string","null"],"format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"additionalProperties":false}},"attendeeTagIdList":{"type":"array","items":{"type":"string","format":"uuid"}},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."},"rawData":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"rsvpStatus":{"type":["string","null"],"enum":["pending","invited","registered","rejected","not-applicable"]},"orderId":{"type":["string","null"],"format":"uuid"}},"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"attendeeId","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"patchAttendeeById","summary":"Partially update an attendee","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false}}}}}}}}
```

## PATCH /public-api/v1/event/{eventId}/attendee/{attendeeId}/attendee-ticket

> Change an attendee ticket class and add-ons

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/{attendeeId}/attendee-ticket":{"patch":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"qrCodeToken":{"type":["string","null"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false},"roleTags":{"type":"array","items":{"type":"string","enum":["organizer","host","speaker","exhibitor","booth-rep","visitor","system"]}},"status":{"type":"string","enum":["invited","registered","attended","magic-link"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"firstEnteredWebAppAt":{"type":["string","null"],"format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"registeredAt":{"type":["string","null"],"format":"date-time"},"attendedAt":{"type":["string","null"],"format":"date-time"},"checkInMethod":{"type":["string","null"],"enum":["walk_in","check_in","qr_code","search"]},"checkedInAt":{"type":["string","null"],"format":"date-time"},"approvalStatus":{"type":["string","null"],"enum":["waitlisted","approved","rejected"]},"approvedAt":{"type":["string","null"],"format":"date-time"},"rejectedAt":{"type":["string","null"],"format":"date-time"},"magicLinkUrl":{"type":["string","null"]},"qrCodeLinkUrl":{"type":["string","null"]},"ticketClassId":{"type":["string","null"],"format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"additionalProperties":false}},"attendeeTagIdList":{"type":"array","items":{"type":"string","format":"uuid"}},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."},"rawData":{"type":"object","properties":{"name":{"type":["string","null"]},"firstName":{"type":["string","null"]},"lastName":{"type":["string","null"]},"invitationEmail":{"type":["string","null"]},"jobTitle":{"type":["string","null"]},"organization":{"type":["string","null"]},"city":{"type":["string","null"]},"country":{"type":["string","null"]},"areaCode":{"type":["string","null"]},"contactNo":{"type":["string","null"]},"customCheckInToken":{"type":["string","null"]},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"type":"string","format":"uuid"}}},"additionalProperties":false},"description":"Only support update with exist (active / archived) custom questions in question library"},"approvalStatus":{"type":"string","enum":["waitlisted","approved","rejected"]},"qrCodeToken":{"type":["string","null"]},"registrationStatus":{"type":"string","enum":["pending","registered","not-applicable"]},"registerUtmParams":{"type":"object","properties":{"utm_source":{"type":"string"},"utm_medium":{"type":"string"},"utm_campaign":{"type":"string"},"utm_term":{"type":"string"},"utm_content":{"type":"string"}},"additionalProperties":false}},"additionalProperties":false},"rsvpStatus":{"type":["string","null"],"enum":["pending","invited","registered","rejected","not-applicable"]},"orderId":{"type":["string","null"],"format":"uuid"}},"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"attendeeId","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"patchAttendeeTicketByAttendeeId","summary":"Change an attendee ticket class and add-ons","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"ticketClassId":{"type":"string","format":"uuid"},"addOns":{"type":"array","items":{"type":"object","properties":{"ticketClassAddOnId":{"type":"string","format":"uuid"},"qty":{"type":"integer"}},"required":["ticketClassAddOnId","qty"],"additionalProperties":false}}},"additionalProperties":false}}}}}}}}
```

## GET /public-api/v1/event/{eventId}/attendee/qr-code-token/{qrCodeToken}

> Look up an attendee by QR code token

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/qr-code-token/{qrCodeToken}":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."}},"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string"},"name":"qrCodeToken","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"getAttendeeByCheckInQRCodeToken","summary":"Look up an attendee by QR code token"}}}}
```

## GET /public-api/v1/event/{eventId}/attendee/short-code/{shortCode}

> Look up an attendee by short code

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee/short-code/{shortCode}":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"createdAt":{"type":"string","format":"date-time"},"customFields":{"type":"object","properties":{},"additionalProperties":{"type":"object","properties":{"value":{"anyOf":[{"type":["string","null"]},{"type":"array","items":{"type":["string","null"]}},{"type":"boolean"}]},"mediaValues":{"type":"array","items":{"anyOf":[{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"originalFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"cloudflarePlaybackUrl":{"type":["string","null"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","originalFilepath","mimeType","size"],"additionalProperties":false},{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"originalFilename":{"type":"string"},"previewFilename":{"type":"string"},"originalFilepath":{"type":"string"},"previewFilepath":{"type":"string"},"mimeType":{"type":"string"},"type":{"type":"string","enum":["image","video","file"]},"size":{"type":"number","format":"float"}},"required":["id","originalFilename","previewFilename","originalFilepath","previewFilepath","mimeType","size"],"additionalProperties":false}]}}},"additionalProperties":false},"description":"Map of custom question IDs to their values. Each key is the custom question ID. The `value` field type depends on the question type: a string for text questions, an array of choice IDs for multiple-choice questions, or a boolean for yes/no questions. The `mediaValues` array contains full media response objects (image, file, or video) when media is attached to the field, or an empty array otherwise."}},"additionalProperties":false}},"required":["data"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"boolean"},"name":"isIgnoreCase","in":"query"},{"schema":{"type":"string"},"name":"shortCode","in":"path"},{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"getAttendeeByShortCode","summary":"Look up an attendee by short code"}}}}
```

## GET /public-api/v1/event/{eventId}/attendee-tag/all

> List all attendee tags for an event

```json
{"openapi":"3.1.1","info":{"title":"Public Api","version":"beta"},"servers":[{"url":"/"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"name":"Authorization","type":"apiKey","in":"header","description":"Bearer Authorization with jwt token"}}},"paths":{"/public-api/v1/event/{eventId}/attendee-tag/all":{"get":{"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"dataList":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid"},"name":{"type":"string"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"rawData":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"],"additionalProperties":false}},"required":["id","name","createdAt","updatedAt","rawData"],"additionalProperties":false}}},"required":["dataList"],"additionalProperties":false}}}},"500":{"description":"ERROR"}},"parameters":[{"schema":{"type":"string","format":"uuid"},"name":"eventId","in":"path"}],"tags":["Attendee"],"operationId":"getAllAttendeeTagByEventId","summary":"List all attendee tags for an event"}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://eventx-hq.gitbook.io/knowledge-base/api-doc/attendee.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.