Overview
This page documents the three event-related response models: a single event row (EventListItem), the paginated event list response (EventListResponse), and the per-event details response (EventDetailsResponse).
EventListItem
EventListItem is returned inside the events array from List Events.
| Field | Type | Description |
|---|---|---|
event_id | number | Unique event identifier. |
event_name | string | null | Display name of the event. |
event_slug | string | null | URL-friendly slug. |
event_date | string | null | Event date as an ISO 8601 datetime string. |
status | string | null | Current event status. |
cover_image | string | null | Cover image URL or path for the event. |
EventListResponse
Top-level response returned by List Events. It uses the standard envelope from Conventions; the typed payload lives indata.
| Field | Type | Description |
|---|---|---|
data.events | array | Paginated list of EventListItem objects. |
data.pagination | object | PaginationInfo metadata. |
EventDetailsResponse
EventDetailsResponse is returned by Event Details. The event metadata lives inside data.
| Field | Type | Description |
|---|---|---|
data.event_id | number | Unique event identifier. |
data.event_name | string | null | Display name of the event. |
data.event_slug | string | null | URL-friendly slug. |
data.event_date | string | null | Event date as an ISO 8601 datetime string. |
data.status | string | null | Current event status. |
data.event_enabled | boolean | Whether the event is enabled for client/external use. |
data.bib_search | boolean | Whether 9Pic BibTrack (BIB Search) is enabled. |
data.selfie_search | boolean | Whether 9Pic FaceFind (Face Search) is enabled. |
data.name_search | boolean | Whether name-based search is enabled. |
data.video_search | boolean | Whether 9Pic Motion (Video Clipping Search) is enabled at the event level. |
data.video_selfie_search | boolean | Whether selfie-driven 9Pic Motion video clipping is enabled. Always false when video_search is false. |
data.timeline_search | boolean | Whether the Photo Timeline endpoints (GET /timeline/days, GET /timeline/images) are enabled. |
Used By
List Events
Returns
EventListResponse containing EventListItem[] and PaginationInfo.Event Details
Returns
EventDetailsResponse.
