Event Registrations

The Event Registrations API allows you to create, retrieve, update, and delete event registrations. Registrations represent users who have signed up to attend an event.

Authentication

All requests to the Event Registrations API must be authenticated using the ONLIVE.SITE authentication scheme. Please refer to the Authentication Guide for detailed instructions.

Base URL

https://openapi.onlive.site/api/v1/event-registrations

Create Registration

Creates a new event registration.

HTTP Request

POST /api/v1/event-registrations

Request Body

Field	Type	Required	Description
`occurrenceId`	string (uuid)	Yes	The occurrence identifier for the registration
`externalUserId`	string	Yes	The external user identifier for the registration
`fields`	object	No	JSON fields provided by the registrant

Example Request Body

{
  "occurrenceId": "123e4567-e89b-12d3-a456-426614174001",
  "externalUserId": "ext_user_12345",
  "fields": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "company": "Tech Corp",
    "role": "Developer"
  }
}

Response

201 Created

Returns the created EventRegistration object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "status": "CONFIRMED",
  "fields": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe"
  },
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "organizationId": "987e6543-e21a-34b5-c678-426614174000",
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "role": "attendee",
    "avatar": "https://example.com/avatars/user.jpg",
    "isActive": true
  },
  "occurrence": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "startDate": "2025-12-25T10:00:00.000Z",
    "endDate": "2025-12-25T18:00:00.000Z",
    "capacity": 100,
    "registrations": 50
  },
  "event": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "Annual Tech Conference 2025",
    "slug": "annual-tech-conference-2025",
    "description": "Join us for the biggest tech conference of the year featuring keynote speakers, workshops, and networking opportunities."
  }
}

Get Registration

Retrieves a specific event registration by its ID.

HTTP Request

GET /api/v1/event-registrations/{id}

Path Parameters

Parameter	Type	Required	Description
`id`	string (uuid)	Yes	The unique identifier of the registration

Query Parameters

Parameter	Type	Required	Description
`withTrashed`	boolean	No	Include trashed registrations

Response

200 OK

Returns the EventRegistration object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdAt": "2025-01-01T00:00:00.000Z",
  "updatedAt": "2025-01-01T00:00:00.000Z",
  "status": "CONFIRMED",
  "fields": {
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe"
  },
  "user": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "organizationId": "987e6543-e21a-34b5-c678-426614174000",
    "email": "[email protected]",
    "firstName": "John",
    "lastName": "Doe",
    "role": "attendee",
    "avatar": "https://example.com/avatars/user.jpg",
    "isActive": true
  },
  "occurrence": {
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "startDate": "2025-12-25T10:00:00.000Z",
    "endDate": "2025-12-25T18:00:00.000Z",
    "capacity": 100,
    "registrations": 50
  },
  "event": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "name": "Annual Tech Conference 2025",
    "slug": "annual-tech-conference-2025",
    "description": "Join us for the biggest tech conference of the year featuring keynote speakers, workshops, and networking opportunities."
  }
}

Update Registration

Updates an existing event registration.

HTTP Request

PUT /api/v1/event-registrations/{id}

Path Parameters

Parameter	Type	Required	Description
`id`	string (uuid)	Yes	The unique identifier of the registration

Request Body

All fields are optional. Only the fields you want to update need to be included.

Field	Type	Description
`status`	string	Registration status: `PENDING`, `CONFIRMED`, `CANCELLED`, `WAITING_LIST`, or `ATTENDED`
`fields`	object	JSON fields provided by the registrant

Example Request Body

{
  "status": "ATTENDED",
  "fields": {
    "ticketType": "VIP",
    "notes": "Arrived early"
  }
}

Response

200 OK

Returns the updated EventRegistration object.

Search Registrations

Retrieves a paginated list of event registrations based on query parameters.

HTTP Request

GET /api/v1/event-registrations

Query Parameters

Parameter	Type	Required	Description
`limit`	number	No	Maximum number of items to return (default: 10, min: 1)
`page`	number	No	Page number (starts at 1, default: 1, min: 1)
`sort`	string	No	Field name and direction to sort results by. Use "ASC" or "DESC". (default: "createdAt DESC")
`eventId`	string (uuid)	No	Limits the results to registrations that belong to a specific event
`occurrenceId`	string (uuid)	No	Limits the results to registrations that belong to a specific occurrence
`status`	string	No	Filters registrations by their current status: `PENDING`, `CONFIRMED`, `CANCELLED`, `WAITING_LIST`, or `ATTENDED`
`search`	string (max 255)	No	Performs a case-insensitive search across event name, event ID, user ID, user email, phone, first or last name
`categories`	array of strings (uuid)	No	Array of category UUIDs to filter registrations. Returns registrations for events that belong to at least one of these categories.
`withTrashed`	boolean	No	Include soft-deleted registrations in the results

Example Request

GET /api/v1/event-registrations?eventId=4c4f93e6-38bb-4a1e-8286-e89f9853cf52&status=CONFIRMED&search=john

Response

200 OK

Returns an array of EventRegistration objects.

Example Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-01-01T00:00:00.000Z",
    "status": "CONFIRMED",
    "fields": {
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe"
    },
    "user": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2025-01-01T00:00:00.000Z",
      "updatedAt": "2025-01-01T00:00:00.000Z",
      "organizationId": "987e6543-e21a-34b5-c678-426614174000",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "role": "attendee",
      "avatar": "https://example.com/avatars/user.jpg",
      "isActive": true
    },
    "occurrence": {
      "id": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "startDate": "2025-12-25T10:00:00.000Z",
      "endDate": "2025-12-25T18:00:00.000Z",
      "capacity": 100,
      "registrations": 50
    },
    "event": {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdAt": "2019-08-24T14:15:22Z",
      "updatedAt": "2019-08-24T14:15:22Z",
      "name": "Annual Tech Conference 2025",
      "slug": "annual-tech-conference-2025",
      "description": "Join us for the biggest tech conference of the year featuring keynote speakers, workshops, and networking opportunities."
    }
  }
]

Delete Registration

Deletes an event registration by its ID.

HTTP Request

DELETE /api/v1/event-registrations/{id}

Path Parameters

Parameter	Type	Required	Description
`id`	string (uuid)	Yes	The unique identifier of the registration

Query Parameters

Parameter	Type	Required	Description
`withTrashed`	boolean	No	Include trashed registrations

Response

200 OK

Returns the deleted EventRegistration object.

EventRegistration Object

The EventRegistration object represents a user's registration for an event.

Properties

Property	Type	Description
`id`	string (uuid)	The unique identifier of the registration
`createdAt`	string (ISO 8601)	The date and time when the registration was created
`updatedAt`	string (ISO 8601)	The date and time when the registration was last updated
`status`	string	Registration status. Possible values: `PENDING`, `CONFIRMED`, `CANCELLED`, `WAITING_LIST`, `ATTENDED`
`fields`	object	JSON fields provided by the registrant
`user`	object	The user object associated with the registration
`occurrence`	object	The event occurrence object
`event`	object	The event object
`organization`	object	The organization associated with the event registration
`deletedAt`	string (ISO 8601)	The deletion date of the registration (if deleted)

Authentication​

Base URL​

Endpoints​

Create Registration​

HTTP Request​

Request Body​

Example Request Body​

Response​

Example Response​

Get Registration​

HTTP Request​

Path Parameters​

Query Parameters​

Response​

Example Response​

Update Registration​

HTTP Request​

Path Parameters​

Request Body​

Example Request Body​

Response​

Search Registrations​

HTTP Request​

Query Parameters​

Example Request​

Response​

Example Response​

Delete Registration​

HTTP Request​

Path Parameters​

Query Parameters​

Response​

EventRegistration Object​

Properties​

Authentication

Base URL

Endpoints

Create Registration

HTTP Request

Request Body

Example Request Body

Response

Example Response

Get Registration

HTTP Request

Path Parameters

Query Parameters

Response

Example Response

Update Registration

HTTP Request

Path Parameters

Request Body

Example Request Body

Response

Search Registrations

HTTP Request

Query Parameters

Example Request

Response

Example Response

Delete Registration

HTTP Request

Path Parameters

Query Parameters

Response

EventRegistration Object

Properties