Skip to main content
Many list endpoints return a shared pagination envelope.

Common fields

Request pattern

Most list endpoints accept page and pageSize.
Use explicit values instead of relying on defaults in production clients.

What to expect

  • Exact item fields vary by endpoint family.
  • Some endpoints return extra route-specific metadata in addition to the shared pagination fields.
  • Event-scoped exhibitor and personnel list endpoints can include semantics metadata that explains preview access and unlock guidance.
  • Identifiers such as event_id, exhibitor_id, and personnel_id are string values in API requests and responses.
  • Parameter naming is route-specific. Treat each endpoint page as the source of truth for casing and field names.

Preview semantics

Event-scoped exhibitor and personnel lists can return an additional semantics object:
Use semantics to decide whether a page is fully accessible or whether the user should unlock the event for more records.

Requesting pages beyond the preview limit

When an event is locked and you request a page outside the accessible preview window, the API returns:
Key behaviors:
  • items is empty — no records are returned for inaccessible pages.
  • total and totalPages are 0 — they reflect the inaccessible current page, not the true matching total.
  • semantics.counts.actualTotal is the true matching total when the API can calculate it.
  • pageState.accessible is false — use this flag to detect when a page is outside the preview window.
  • pageState.maxAccessiblePage tells you the last page you can request without unlocking. Treat this as authoritative instead of calculating from previewLimit / pageSize.
  • guidance.code changes to "preview_page_inaccessible" (versus "preview_results_truncated" on accessible preview pages).
Handle this by checking pageState.accessible before rendering results. If false, show the unlock prompt rather than an empty state.

Notes

  • Most endpoints use a maximum pageSize of 100.
  • Personnel list endpoints use a maximum pageSize of 50.
  • Use each endpoint page as the source of truth for route-specific filters, item fields, and any additional metadata returned with paginated results.