Skip to main content

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.
{
  "event_id": 456,
  "event_name": "Mumbai Marathon 2026",
  "event_slug": "mumbai-marathon-2026",
  "event_date": "2026-01-19T06:00:00",
  "status": "active",
  "cover_image": "https://photos.9pic.ai/imgs/456/cover.jpg"
}
FieldTypeDescription
event_idnumberUnique event identifier.
event_namestring | nullDisplay name of the event.
event_slugstring | nullURL-friendly slug.
event_datestring | nullEvent date as an ISO 8601 datetime string.
statusstring | nullCurrent event status.
cover_imagestring | nullCover 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 in data.
{
  "responseType": "success",
  "message": "Records for events",
  "data": {
    "events": [],
    "pagination": {
      "total": 0,
      "currentPage": 0,
      "totalPages": 0,
      "hasNextPage": false,
      "hasPreviousPage": false,
      "page_size": 10
    }
  }
}
FieldTypeDescription
data.eventsarrayPaginated list of EventListItem objects.
data.paginationobjectPaginationInfo metadata.

EventDetailsResponse

EventDetailsResponse is returned by Event Details. The event metadata lives inside data.
{
  "responseType": "success",
  "message": "Event details",
  "data": {
    "event_id": 456,
    "event_name": "Mumbai Marathon 2026",
    "event_slug": "mumbai-marathon-2026",
    "event_date": "2026-01-19T06:00:00",
    "status": "active",
    "event_enabled": true,
    "bib_search": true,
    "selfie_search": true,
    "name_search": false,
    "video_search": true,
    "video_selfie_search": true,
    "timeline_search": true
  }
}
FieldTypeDescription
data.event_idnumberUnique event identifier.
data.event_namestring | nullDisplay name of the event.
data.event_slugstring | nullURL-friendly slug.
data.event_datestring | nullEvent date as an ISO 8601 datetime string.
data.statusstring | nullCurrent event status.
data.event_enabledbooleanWhether the event is enabled for client/external use.
data.bib_searchbooleanWhether 9Pic BibTrack (BIB Search) is enabled.
data.selfie_searchbooleanWhether 9Pic FaceFind (Face Search) is enabled.
data.name_searchbooleanWhether name-based search is enabled.
data.video_searchbooleanWhether 9Pic Motion (Video Clipping Search) is enabled at the event level.
data.video_selfie_searchbooleanWhether selfie-driven 9Pic Motion video clipping is enabled. Always false when video_search is false.
data.timeline_searchbooleanWhether 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.