API reference

Every resource in the Partner API, grouped by area. Paths are relative to https://yourcompany.eventogy-api.com/api/v1/partner.

Field-level reference and examples need an access code from Eventogy. Enter access code

Delete says what DELETE does: Soft keeps a restorable tombstone, Hard removes the record permanently, Read-only resources can't be changed. See Deletes.

Authentication

Obtaining access tokens and checking connectivity.

Resource	Path	Methods	Delete
Check connectivity	`/ping`	GET	—

Events & agendas

Events, their agendas, agenda sessions (elements) and tracks.

Resource	Path	Methods	Delete
Event	`/events`	GET, POST, PUT, PATCH, DELETE	Soft
Agenda	`/events/{eventId}/agendas`	GET, POST, PUT, PATCH, DELETE	Soft
Agenda session	`/events/{eventId}/agendas/{agendaId}/elements`	GET, POST, PUT, PATCH, DELETE	Soft
Agenda track	`/events/{eventId}/agendas/{agendaId}/tracks`	GET, POST, PUT, PATCH, DELETE	Soft

Attendees & registrations

Tenant-wide attendee records and their registrations to individual events.

Resource	Path	Methods	Delete
Attendee	`/attendees`	GET, POST, PUT, PATCH, DELETE	Soft
Registration	`/events/{eventId}/attendee-events`	GET, POST, PUT, PATCH, DELETE	Soft

Forms

Registration and survey forms, their questions and answer options.

Resource	Path	Methods	Delete
Form	`/events/{eventId}/forms`	GET, POST, PUT, PATCH, DELETE	Soft
Form question	`/events/{eventId}/forms/{formId}/questions`	GET, POST, PUT, PATCH, DELETE	Soft
Answer option	`/events/{eventId}/forms/{formId}/questions/{questionId}/options`	GET, POST, PUT, PATCH, DELETE	Soft

Website pages

Event website pages and the content blocks on them.

Resource	Path	Methods	Delete
Event website page	`/events/{eventId}/pages`	GET, POST, PUT, PATCH, DELETE	Soft
Website page block	`/events/{eventId}/pages/{pageId}/page-blocks`	GET, POST, PUT, PATCH, DELETE	Soft

Emails

Event emails, their content blocks, send batches and per-recipient send tracking.

Resource	Path	Methods	Delete
Event email	`/events/{eventId}/emails`	GET, POST, PUT, PATCH, DELETE	Soft
Scheduled email send	`/events/{eventId}/emails/{emailId}/email-batches`	GET, POST, PUT, PATCH, DELETE	Soft
Email delivery record	`/events/{eventId}/emails/{emailId}/email-batches/{emailBatchId}/scheduled-emails`	GET	Read-only
Email content block	`/events/{eventId}/emails/{emailId}/email-blocks`	GET, POST, PUT, PATCH, DELETE	Soft

Compilations

Curated collections of items (for example speakers or sponsors) and their values.

Resource	Path	Methods	Delete
Compilation (collection)	`/events/{eventId}/compilations`	GET, POST, PUT, PATCH, DELETE	Soft
Compilation item	`/events/{eventId}/compilations/{compilationId}/items`	GET, POST, PUT, PATCH, DELETE	Soft
Compilation item value	`/events/{eventId}/compilations/{compilationId}/items/{itemId}/values`	GET, POST, PUT, DELETE	Hard

Meetings

Organiser-side meeting structure: meetings, contacts, notes and custom meeting fields.

Resource	Path	Methods	Delete
Meeting custom field	`/events/{eventId}/meeting-field-questions`	GET, POST, PUT, PATCH, DELETE	Soft
Meeting field answer option	`/events/{eventId}/meeting-field-questions/{meetingFieldQuestionId}/answer-options`	GET, POST, PUT, PATCH, DELETE	Soft
Meeting	`/events/{eventId}/meetings`	GET, POST, PUT, PATCH, DELETE	Soft
Meeting contact	`/events/{eventId}/meetings/{meetingId}/contacts`	GET, POST, PUT, PATCH, DELETE	Soft
Meeting note	`/events/{eventId}/meetings/{meetingId}/notes`	GET, POST, PUT, PATCH, DELETE	Soft

Attendee data

Attendee tags and organiser note questions used to classify registrations.

Resource	Path	Methods	Delete
Attendee note question	`/events/{eventId}/attendee-note-questions`	GET, POST, PUT, PATCH, DELETE	Soft
Attendee note answer option	`/events/{eventId}/attendee-note-questions/{attendeeNoteQuestionId}/answer-options`	GET, POST, PUT, PATCH, DELETE	Soft
Attendee tag	`/events/{eventId}/attendee-tags`	GET, POST, PUT, PATCH, DELETE	Soft

Content & engagement

Content items, locations, Q&A categories and mobile app pages.

Resource	Path	Methods	Delete
Event content block	`/events/{eventId}/content`	GET, POST, PUT, PATCH, DELETE	Soft
Event location	`/events/{eventId}/locations`	GET, POST, PUT, PATCH, DELETE	Soft
Mobile-app page	`/events/{eventId}/mobile-pages`	GET, POST, PUT, PATCH, DELETE	Soft
Q&A category	`/events/{eventId}/qna-categories`	GET, POST, PUT, PATCH, DELETE	Soft

Theming

Event styles, colour palettes and palette components.

Resource	Path	Methods	Delete
Event email style	`/event-styles`	GET, POST, PUT, PATCH, DELETE	Soft
Brand palette	`/palettes`	GET, POST, PUT, DELETE	Hard
Palette component value	`/palettes/{paletteId}/components`	GET	Read-only

Reports

Saved report configurations. Generated report files are not available through this API.

Resource	Path	Methods	Delete
Report definition	`/events/{eventId}/report-configs`	GET, POST, PUT, PATCH, DELETE	Soft

Accounts & access

Operator user accounts, stakeholders, roles and teams. Credentials are never returned or writable.

Resource	Path	Methods	Delete
Stakeholder linked to an event	`/events/{eventId}/event-stakeholders`	GET	Read-only
Operator permission role	`/roles`	GET, POST, PUT, DELETE	Hard
Stakeholder access area	`/stakeholder-access-types`	GET	Read-only
Stakeholder account	`/stakeholders`	GET, POST, PUT, PATCH, DELETE	Soft
Team of operator users	`/teams`	GET, POST, PUT, PATCH, DELETE	Soft
Operator user profile value	`/user-data`	GET, POST, PUT, DELETE	Hard
Operator user account	`/users`	GET, POST, PUT, PATCH, DELETE	Soft

Configuration

Public tenant settings and per-event app settings.

Resource	Path	Methods	Delete
Event attendee-app setting value	`/app-setting-data`	GET, POST, PUT, DELETE	Hard
Event attendee-app settings	`/events/{eventId}/app-settings`	GET, POST, PUT, PATCH, DELETE	Soft
Organisation-wide public setting	`/settings`	GET, POST, PUT, PATCH, DELETE	Soft

Activity & engagement

Attendee activity, host-app activity, likes and the tenant audit log.

Resource	Path	Methods	Delete
Audit log entry	`/activities`	GET	Read-only
Attendee check-in record	`/attendee-host-app-activities`	GET, POST, PUT, DELETE	Hard
Attendee change history entry	`/events/{eventId}/attendee-activities`	GET, POST, PUT, DELETE	Hard
Attendee like	`/likes`	GET, POST, PUT, DELETE	Hard

Reference data

Read-only lookup tables that other resources reference by id.

Resource	Path	Methods	Delete
Permission area	`/access-categories`	GET	Read-only
Page visibility	`/access-types`	GET	Read-only
Check-in activity type	`/activity-types`	GET	Read-only
Registration approval state	`/approval-types`	GET	Read-only
Collection type	`/compilation-types`	GET	Read-only
Collection field type	`/compilation-value-types`	GET	Read-only
Email delivery status	`/email-status-types`	GET	Read-only
Email type	`/email-types`	GET	Read-only
Event type tag	`/event-types`	GET	Read-only
Form type	`/form-types`	GET	Read-only
Import outcome type	`/import-exception-types`	GET	Read-only
Question input type	`/input-types`	GET	Read-only
Supported language	`/languages`	GET	Read-only
Meeting status	`/meeting-status-types`	GET	Read-only
Palette setting type	`/palette-component-types`	GET	Read-only
Report type	`/report-config-types`	GET	Read-only
Registration status type	`/status-types`	GET	Read-only