Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Attendee

List attendees for an event

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Query parameters
pagenumber · float · min: 1OptionalDefault: 1
pageEndnumber · floatOptional

Optional inclusive ending page for requesting a range of pages. Maximum page range: 200.

pageSizenumber · float · min: 1 · max: 100OptionalDefault: 25
sortstringOptional

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

Default: -idExample: -sorterA,sorterB
attendeeIdsstringOptional

JSON array of attendee UUIDs to filter by

Example: ["550e8400-e29b-41d4-a716-446655440000"]
createdAt$gtstring · date-timeOptional

Filter attendees created after this ISO 8601 datetime

Example: 2024-01-01T00:00:00.000Z
customFieldsstringOptional

JSON object of custom field question IDs to values for exact-match filtering

Example: {"question-uuid": "value"}
qstringOptional

Free-text search across attendee name and email fields

Example: John
customFieldSearchstringOptional

JSON object of custom field question IDs to text search terms (only text/textarea type questions supported)

Example: {"question-uuid": "search term"}
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/attendee
GET /public-api/v1/event/{eventId}/attendee HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "dataList": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "name": "John Doe",
      "invitationEmail": "john@example.com",
      "jobTitle": "Engineer",
      "organization": "Acme Inc",
      "city": "Hong Kong",
      "country": "HK",
      "areaCode": "852",
      "contactNo": "98765432",
      "customFields": {},
      "registrationStatus": "REGISTERED"
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "pageCount": 1,
    "totalCount": 1
  }
}

Bulk create or update attendees

put

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.

Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Bodyobject[]

Array of attendee objects for bulk creation or update. Include an id to update an existing attendee; omit id to create a new one.

idstring · uuidOptional

When provide resource Id, it will update the resource, otherwise it will create a new resource

statusstring · enumOptional

Deprecated. Will be removed at 2025 July, use registrationStatus instead. Can't be used together with registrationStatus

Possible values:
namestring · nullableOptional
firstNamestring · nullableOptional
lastNamestring · nullableOptional
invitationEmailstring · nullableOptional
jobTitlestring · nullableOptional
organizationstring · nullableOptional
citystring · nullableOptional
countrystring · nullableOptional
areaCodestring · nullableOptional
contactNostring · nullableOptional
customCheckInTokenstring · nullableOptional
approvalStatusstring · enumOptionalPossible values:
qrCodeTokenstring · nullableOptional
registrationStatusstring · enumOptionalPossible values:
Responses
200

Success

application/json
put/public-api/v1/event/{eventId}/attendee/bulk-upsert
PUT /public-api/v1/event/{eventId}/attendee/bulk-upsert HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 262

[
  {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "firstName": "John",
    "lastName": "Doe",
    "invitationEmail": "john@example.com",
    "registrationStatus": "REGISTERED"
  },
  {
    "firstName": "Jane",
    "lastName": "Smith",
    "invitationEmail": "jane@example.com",
    "registrationStatus": "INVITED"
  }
]
{
  "dataList": [
    {
      "firstName": "John",
      "lastName": "Doe",
      "name": "John Doe",
      "invitationEmail": "john@example.com",
      "jobTitle": "Engineer",
      "organization": "Acme Inc",
      "city": "Hong Kong",
      "country": "HK",
      "areaCode": "852",
      "contactNo": "98765432",
      "customFields": {},
      "registrationStatus": "REGISTERED"
    }
  ]
}

Remove attendees from an event

delete

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

Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Body

Request body for bulk removing attendees

attendeeIdsstring · uuid[]Required
Responses
200

Success

application/json
objectOptional
delete/public-api/v1/event/{eventId}/attendee/bulk-remove
DELETE /public-api/v1/event/{eventId}/attendee/bulk-remove HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}
{}

Permanently delete attendees

delete

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

Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Body

Request body for permanently deleting attendees

attendeeIdsstring · uuid[]Required
Responses
200

Success

application/json
objectOptional
delete/public-api/v1/event/{eventId}/attendee/bulk-delete
DELETE /public-api/v1/event/{eventId}/attendee/bulk-delete HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "attendeeIds": [
    "550e8400-e29b-41d4-a716-446655440000"
  ]
}
{}

Get an attendee by ID

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
attendeeIdstring · uuidRequired
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/attendee/{attendeeId}
GET /public-api/v1/event/{eventId}/attendee/{attendeeId} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "invitationEmail": "john@example.com",
    "jobTitle": "Engineer",
    "organization": "Acme Inc",
    "city": "Hong Kong",
    "country": "HK",
    "areaCode": "852",
    "contactNo": "98765432",
    "customFields": {},
    "registrationStatus": "REGISTERED"
  }
}

Partially update an attendee

patch
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
attendeeIdstring · uuidRequired
eventIdstring · uuidRequired
Body

Attendee profile fields that can be created or updated via the API

namestring · nullableOptional
firstNamestring · nullableOptional
lastNamestring · nullableOptional
invitationEmailstring · nullableOptional
jobTitlestring · nullableOptional
organizationstring · nullableOptional
citystring · nullableOptional
countrystring · nullableOptional
areaCodestring · nullableOptional
contactNostring · nullableOptional
customCheckInTokenstring · nullableOptional
approvalStatusstring · enumOptionalPossible values:
qrCodeTokenstring · nullableOptional
registrationStatusstring · enumOptionalPossible values:
Responses
200

Success

application/json
patch/public-api/v1/event/{eventId}/attendee/{attendeeId}
PATCH /public-api/v1/event/{eventId}/attendee/{attendeeId} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 266

{
  "firstName": "John",
  "lastName": "Doe",
  "name": "John Doe",
  "invitationEmail": "john@example.com",
  "jobTitle": "Engineer",
  "organization": "Acme Inc",
  "city": "Hong Kong",
  "country": "HK",
  "areaCode": "852",
  "contactNo": "98765432",
  "customFields": {},
  "registrationStatus": "REGISTERED"
}
{
  "data": {
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "invitationEmail": "john@example.com",
    "jobTitle": "Engineer",
    "organization": "Acme Inc",
    "city": "Hong Kong",
    "country": "HK",
    "areaCode": "852",
    "contactNo": "98765432",
    "customFields": {},
    "registrationStatus": "REGISTERED"
  }
}

Change an attendee ticket class and add-ons

patch
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
attendeeIdstring · uuidRequired
eventIdstring · uuidRequired
Body

Request body for changing an attendee ticket class and add-ons

ticketClassIdstring · uuidOptional
Responses
200

Success

application/json
patch/public-api/v1/event/{eventId}/attendee/{attendeeId}/attendee-ticket
PATCH /public-api/v1/event/{eventId}/attendee/{attendeeId}/attendee-ticket HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 137

{
  "ticketClassId": "550e8400-e29b-41d4-a716-446655440001",
  "addOns": [
    {
      "ticketClassAddOnId": "550e8400-e29b-41d4-a716-446655440002",
      "qty": 1
    }
  ]
}
{
  "data": {
    "firstName": "John",
    "lastName": "Doe",
    "name": "John Doe",
    "invitationEmail": "john@example.com",
    "jobTitle": "Engineer",
    "organization": "Acme Inc",
    "city": "Hong Kong",
    "country": "HK",
    "areaCode": "852",
    "contactNo": "98765432",
    "customFields": {},
    "registrationStatus": "REGISTERED"
  }
}

Look up an attendee by QR code token

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
qrCodeTokenstringRequired
eventIdstring · uuidRequired
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/attendee/qr-code-token/{qrCodeToken}
GET /public-api/v1/event/{eventId}/attendee/qr-code-token/{qrCodeToken} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "customFields": {}
  }
}

Look up an attendee by short code

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
shortCodestringRequired
eventIdstring · uuidRequired
Query parameters
isIgnoreCasebooleanOptional

When true, short code lookup is case-insensitive

Example: false
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/attendee/short-code/{shortCode}
GET /public-api/v1/event/{eventId}/attendee/short-code/{shortCode} HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "customFields": {}
  }
}

List all attendee tags for an event

get
Authorizations
AuthorizationstringRequired

Bearer Authorization with jwt token

Path parameters
eventIdstring · uuidRequired
Responses
200

Success

application/json
get/public-api/v1/event/{eventId}/attendee-tag/all
GET /public-api/v1/event/{eventId}/attendee-tag/all HTTP/1.1
Host: esaas-api.eventx.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "dataList": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "rawData": {
        "name": "text"
      }
    }
  ]
}
PreviousEventNextCustom Field

Last updated