Events

List events

Events of the workspace, newest start date first by default. Archived events are left out unless archived says otherwise. The sample events created at onboarding are never listed. Amounts are null without reports.view or quotes.manage. Role permission: none (any member).

get/events

Request

  • Base URL: https://joinways.app/api/v1
  • URL: https://joinways.app/api/v1/events
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://joinways.app/oauth/authorize, token URL https://joinways.app/api/oauth/token, scopes: mcp.read)

Query parameters

pageinteger

1-based page number.

per_pageinteger

Items per page.

sort'start_date' | 'created_at' | 'title' | 'status' | 'company_name'

Field to sort by. Any other value sorts by start_date.

order'asc' | 'desc'
statusEventStatus[]

One or more statuses (repeat the parameter or separate with commas).

[
  "confirmed"
]
typestring[]

One or more event types (repeat the parameter or separate with commas).

company_idstring uuid

Only events of this company.

venue_idstring uuid

Only events at this venue.

fromstring date

Lower bound on start_date (inclusive), YYYY-MM-DD or an ISO timestamp.

tostring date

Upper bound on start_date, inclusive. A YYYY-MM-DD day covers that whole day (UTC); an ISO timestamp is used as is.

qstring

Case-insensitive match on the event title.

archived'exclude' | 'only' | 'all'

exclude (default) hides archived events, only shows only them, all shows both.

Response

Page of events. A page past the last one is empty.

Example response

{
  "data": [
    {
      "event_number": 1042,
      "title": "Corporate dinner Acme",
      "type": "dinner",
      "status": "confirmed",
      "pax": 80,
      "start_date": "2026-11-12T18:00:00+00:00",
      "selected_dates": [
        "2026-11-12",
        "2026-11-14"
      ],
      "day_hours": [
        {
          "date": "2026-11-12",
          "start": "09:00",
          "end": "18:00"
        },
        {
          "date": "2026-11-13",
          "start": "19:00",
          "end": "02:00"
        }
      ],
      "timezone": "Europe/Paris",
      "language": "fr",
      "currency": "EUR",
      "venue_name": "Le Grand Salon",
      "company_name": "Acme",
      "contact_first_name": "Jane",
      "contact_last_name": "Doe",
      "contact_email": "jane@acme.com"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1234,
    "total_pages": 25
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.