Event Users

The Event Users API allows you to create, retrieve, update, and delete users who can participate in events within your organization. These users can have different roles such as admin, organizer, or attendee.

Authentication

All requests to the Event Users 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-users

Endpoints

• Create Event User
• Get Event User
• Update Event User
• Search Event Users
• Delete Event User

---

Create Event User

Creates a new event user within your organization.

HTTP Request

POST /api/v1/event-users

Request Body

All fields are optional, but it's recommended to provide at least an email address or first/last name.

Field	Type	Required	Description
email	string (email)	No	The email address of the user (max 255 characters)
firstName	string	No	The first name of the user (max 255 characters)
lastName	string	No	The last name of the user (max 255 characters)
phone	string	No	The phone number of the user (max 50 characters)
externalId	string	No	External identifier for the user from external systems (max 255 characters)
extraFields	object	No	Additional fields for the user as a JSON object

Example Request Body

{
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "phone": "+1-555-123-4567",
  "externalId": "ext_user_12345",
  "extraFields": {
    "department": "Engineering",
    "role": "Developer",
    "employeeId": "EMP-001"
  }
}

Response

Returns the created EventUser object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "987e6543-e21a-34b5-c678-426614174000",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "role": "attendee",
  "avatar": null,
  "isActive": true,
  "createdAt": "2025-10-12T10:30:00.000Z",
  "updatedAt": "2025-10-12T10:30:00.000Z"
}

---

Get Event User

Retrieves a specific event user by their ID.

HTTP Request

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

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the event user

Query Parameters

Parameter	Type	Required	Description
withTrashed	boolean	No	Include trashed users

Response

Returns the EventUser object.

Example Response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "organizationId": "987e6543-e21a-34b5-c678-426614174000",
  "email": "[email protected]",
  "firstName": "John",
  "lastName": "Doe",
  "role": "attendee",
  "avatar": "https://example.com/avatars/user.jpg",
  "isActive": true,
  "createdAt": "2025-10-12T10:30:00.000Z",
  "updatedAt": "2025-10-12T10:30:00.000Z"
}

---

Update Event User

Updates an existing event user.

HTTP Request

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

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the event user

Request Body

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

Field	Type	Description
email	string (email)	The email address of the user (max 255 characters)
firstName	string	The first name of the user (max 255 characters)
lastName	string	The last name of the user (max 255 characters)
phone	string	The phone number of the user (max 50 characters)
externalId	string	External identifier for the user (max 255 characters)
extraFields	object	Additional fields for the user as a JSON object

Example Request Body

{
  "email": "[email protected]",
  "phone": "+1-555-987-6543",
  "extraFields": {
    "department": "Product",
    "role": "Senior Developer",
    "employeeId": "EMP-001"
  }
}

Response

Returns the updated EventUser object.

---

Search Event Users

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

HTTP Request

GET /api/v1/event-users

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")
search	string	No	Search term to filter users by name, ID, or external ID
withTrashed	boolean	No	Include soft-deleted users in the results

Example Request

GET /api/v1/event-users?search=John&role=attendee&isActive=true&page=1&limit=20

Response

Returns a paginated response with an array of EventUser objects.

Example Response

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "organizationId": "987e6543-e21a-34b5-c678-426614174000",
      "email": "[email protected]",
      "firstName": "John",
      "lastName": "Doe",
      "role": "attendee",
      "avatar": "https://example.com/avatars/user.jpg",
      "isActive": true,
      "createdAt": "2025-10-12T10:30:00.000Z",
      "updatedAt": "2025-10-12T10:30:00.000Z"
    }
  ],
  "meta": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

---

Delete Event User

Deletes an event user by their ID.

HTTP Request

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

Path Parameters

Parameter	Type	Required	Description
id	string (uuid)	Yes	The unique identifier of the event user

Query Parameters

Parameter	Type	Required	Description
withTrashed	boolean	No	Include trashed users

Response

Returns the deleted EventUser object.

---

EventUser Object

The EventUser object represents a user who can participate in events.

Properties

Property	Type	Description
id	string (uuid)	The unique identifier of the user
organizationId	string (uuid)	The organization identifier this user belongs to
email	string	The email address of the user
firstName	string	The first name of the user
lastName	string	The last name of the user
role	string	The role of the user. Possible values: admin, organizer, attendee
avatar	string | null	The avatar URL of the user
isActive	boolean	Whether the user is active (default: true)
organization	object	The organization associated with the event user
createdAt	string (ISO 8601)	The date and time when the user was created
updatedAt	string (ISO 8601)	The date and time when the user was last updated
deletedAt	string (ISO 8601)	The deletion date of the user (if deleted)

User Roles

Event users can have one of the following roles:

• admin: Full access to manage events, users, and organization settings
• organizer: Can create and manage events, view registrations
• attendee: Can register for events and view their own registrations

Notes

• Event users are scoped to your organization and cannot be shared across organizations
• The externalId field is useful for integrating with external systems and maintaining references to users in other platforms
• Use the extraFields object to store custom data that doesn't fit into the standard user fields