Events

Event CRUD — organizer_api_token org/event scoped, rich examples

List events

get

List events accessible to the organizer_api_token. Token scoped at Org (all events in org) or Event (single). Pure token-level, not user. Supports pagination and filtering. Requires Bearer evtx_live_... with read permission.

Authorizations

AuthorizationstringRequired

Organizer API token — Authorization: Bearer evtx_live_… (Org/Event scoped, read/write).

Query parameters

limitinteger · min: 1 · max: 100OptionalDefault: 50Example: 50

offsetinteger · nullableOptionalDefault: 0Example: 0

nameContainsstringOptionalExample: Tech

isPublishedboolean · nullableOptionalExample: true

Responses

200

Paginated events

application/json

totalnumberRequiredExample: 100

limitnumberRequiredExample: 50

offsetnumberRequiredExample: 0

401

Unauthorized

application/json

403

Forbidden — wrong org/event scope

application/json

get/v2/events

GET /v2/events HTTP/1.1
Host: api.eventx.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": [
    {
      "id": "e63be3e1-7b4c-42b1-9369-aa390032f0ee",
      "organizationId": "org_123",
      "name": "Tech Summit 2026",
      "descriptionHtml": "<p>Welcome</p>",
      "timezone": "Asia/Hong_Kong",
      "startsAt": "2026-03-01T09:00:00+08:00",
      "endsAt": "2026-03-02T18:00:00+08:00",
      "isPublished": true,
      "createdAt": "2026-01-15T02:00:00.000Z",
      "updatedAt": "2026-01-15T02:00:00.000Z"
    }
  ],
  "total": 100,
  "limit": 50,
  "offset": 0
}

Create event

post

Create event — requires organizer_api_token with scope org and write permission. Pure token-level, not user.

Authorizations

AuthorizationstringRequired

Organizer API token — Authorization: Bearer evtx_live_… (Org/Event scoped, read/write).

Body

Create event — requires organizer_api_token with scope org (any event in org) or event (this event only). Pure token-level, not user.

namestring · min: 1 · max: 200Required

Event name, required

Example: Tech Summit 2026

timezonestring · min: 1Required

IANA timezone, required

Example: Asia/Hong_Kong

startsAtstringRequired

ISO start, required

Example: 2026-03-01T09:00:00+08:00

endsAtstringRequired

ISO end, required

Example: 2026-03-02T18:00:00+08:00

descriptionHtmlstringOptionalExample: <p>Welcome</p>

isPublishedbooleanOptionalExample: true

Responses

201

Created

application/json

Event row — organizer_api_token scoped at Org or Event, not user. See info.description for full token scope explanation.

idstring · uuidRequired

Event ID, UUID

Example: e63be3e1-7b4c-42b1-9369-aa390032f0ee

organizationIdstring · nullableRequired

Organization ID, derived from token scope

Example: org_123

namestring · nullableRequired

Event name

Example: Tech Summit 2026

descriptionHtmlstring · nullableRequired

Description HTML

Example: <p>Welcome</p>

timezonestring · nullableRequired

IANA timezone

Example: Asia/Hong_Kong

startsAtstring · nullableRequired

Start time ISO with timezone

Example: 2026-03-01T09:00:00+08:00

endsAtstring · nullableRequired

End time ISO

Example: 2026-03-02T18:00:00+08:00

isPublishedboolean · nullableRequiredExample: true

createdAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

updatedAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

400

Validation error

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

post/v2/events

POST /v2/events HTTP/1.1
Host: api.eventx.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "name": "Tech Summit 2026",
  "timezone": "Asia/Hong_Kong",
  "startsAt": "2026-03-01T09:00:00+08:00",
  "endsAt": "2026-03-02T18:00:00+08:00",
  "descriptionHtml": "<p>Welcome</p>",
  "isPublished": true
}

{
  "id": "e63be3e1-7b4c-42b1-9369-aa390032f0ee",
  "organizationId": "org_123",
  "name": "Tech Summit 2026",
  "descriptionHtml": "<p>Welcome</p>",
  "timezone": "Asia/Hong_Kong",
  "startsAt": "2026-03-01T09:00:00+08:00",
  "endsAt": "2026-03-02T18:00:00+08:00",
  "isPublished": true,
  "createdAt": "2026-01-15T02:00:00.000Z",
  "updatedAt": "2026-01-15T02:00:00.000Z"
}

Get event

get

Get single event — token must be scoped to its org or that exact event.

Authorizations

AuthorizationstringRequired

Organizer API token — Authorization: Bearer evtx_live_… (Org/Event scoped, read/write).

Path parameters

eventIdstring · uuidRequiredExample: e63be3e1-7b4c-42b1-9369-aa390032f0ee

Responses

200

Event

application/json

Event row — organizer_api_token scoped at Org or Event, not user. See info.description for full token scope explanation.

idstring · uuidRequired

Event ID, UUID

Example: e63be3e1-7b4c-42b1-9369-aa390032f0ee

organizationIdstring · nullableRequired

Organization ID, derived from token scope

Example: org_123

namestring · nullableRequired

Event name

Example: Tech Summit 2026

descriptionHtmlstring · nullableRequired

Description HTML

Example: <p>Welcome</p>

timezonestring · nullableRequired

IANA timezone

Example: Asia/Hong_Kong

startsAtstring · nullableRequired

Start time ISO with timezone

Example: 2026-03-01T09:00:00+08:00

endsAtstring · nullableRequired

End time ISO

Example: 2026-03-02T18:00:00+08:00

isPublishedboolean · nullableRequiredExample: true

createdAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

updatedAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

get/v2/events/{eventId}

GET /v2/events/{eventId} HTTP/1.1
Host: api.eventx.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "e63be3e1-7b4c-42b1-9369-aa390032f0ee",
  "organizationId": "org_123",
  "name": "Tech Summit 2026",
  "descriptionHtml": "<p>Welcome</p>",
  "timezone": "Asia/Hong_Kong",
  "startsAt": "2026-03-01T09:00:00+08:00",
  "endsAt": "2026-03-02T18:00:00+08:00",
  "isPublished": true,
  "createdAt": "2026-01-15T02:00:00.000Z",
  "updatedAt": "2026-01-15T02:00:00.000Z"
}

Delete event

delete

Soft delete — requires write and org scope.

Authorizations

AuthorizationstringRequired

Organizer API token — Authorization: Bearer evtx_live_… (Org/Event scoped, read/write).

Path parameters

eventIdstring · uuidRequiredExample: e63be3e1-7b4c-42b1-9369-aa390032f0ee

Responses

204

Deleted

No content

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

delete/v2/events/{eventId}

DELETE /v2/events/{eventId} HTTP/1.1
Host: api.eventx.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update event

patch

Partial update — requires write permission and matching org/event scope.

Authorizations

AuthorizationstringRequired

Organizer API token — Authorization: Bearer evtx_live_… (Org/Event scoped, read/write).

Path parameters

eventIdstring · uuidRequiredExample: e63be3e1-7b4c-42b1-9369-aa390032f0ee

Body

Partial update — at least one field required

namestring · min: 1 · max: 200OptionalExample: Tech Summit 2026 — Updated

timezonestringOptionalExample: Asia/Hong_Kong

startsAtstringOptionalExample: 2026-03-01T09:00:00+08:00

endsAtstringOptionalExample: 2026-03-02T18:00:00+08:00

descriptionHtmlstringOptionalExample: <p>Updated</p>

isPublishedbooleanOptionalExample: true

Responses

200

Updated

application/json

Event row — organizer_api_token scoped at Org or Event, not user. See info.description for full token scope explanation.

idstring · uuidRequired

Event ID, UUID

Example: e63be3e1-7b4c-42b1-9369-aa390032f0ee

organizationIdstring · nullableRequired

Organization ID, derived from token scope

Example: org_123

namestring · nullableRequired

Event name

Example: Tech Summit 2026

descriptionHtmlstring · nullableRequired

Description HTML

Example: <p>Welcome</p>

timezonestring · nullableRequired

IANA timezone

Example: Asia/Hong_Kong

startsAtstring · nullableRequired

Start time ISO with timezone

Example: 2026-03-01T09:00:00+08:00

endsAtstring · nullableRequired

End time ISO

Example: 2026-03-02T18:00:00+08:00

isPublishedboolean · nullableRequiredExample: true

createdAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

updatedAtstring · nullableRequiredExample: 2026-01-15T02:00:00.000Z

400

Validation

application/json

401

Unauthorized

application/json

403

Forbidden

application/json

404

Not found

application/json

patch/v2/events/{eventId}

PATCH /v2/events/{eventId} HTTP/1.1
Host: api.eventx.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 197

{
  "name": "Tech Summit 2026 — Updated",
  "timezone": "Asia/Hong_Kong",
  "startsAt": "2026-03-01T09:00:00+08:00",
  "endsAt": "2026-03-02T18:00:00+08:00",
  "descriptionHtml": "<p>Updated</p>",
  "isPublished": true
}

{
  "id": "e63be3e1-7b4c-42b1-9369-aa390032f0ee",
  "organizationId": "org_123",
  "name": "Tech Summit 2026",
  "descriptionHtml": "<p>Welcome</p>",
  "timezone": "Asia/Hong_Kong",
  "startsAt": "2026-03-01T09:00:00+08:00",
  "endsAt": "2026-03-02T18:00:00+08:00",
  "isPublished": true,
  "createdAt": "2026-01-15T02:00:00.000Z",
  "updatedAt": "2026-01-15T02:00:00.000Z"
}