GET /v1/collections

Retrieve a paginated list of all collections belonging to your organisation.

Request

curl -H "X-API-Key: your-api-key" \
  "https://api.interplai.app/v1/collections?page=0&pageSize=20"

const response = await fetch(
  'https://api.interplai.app/v1/collections?page=0&pageSize=20',
  { headers: { 'X-API-Key': 'your-api-key' } }
);
const data = await response.json();

Query parameters

Parameter	Type	Default	Description
page	integer	0	Page number (0-indexed)
pageSize	integer	20	Items per page (min: 1, max: 100)
contentType	string	—	Filter by content type (see Content Types)

Filtering by content type

# Only social post collections
curl -H "X-API-Key: your-api-key" \
  "https://api.interplai.app/v1/collections?contentType=SOCIAL_POST"

Response

{
  "collections": [
    {
      "id": "col_abc123",
      "name": "Match Day Social Feed",
      "contentType": "SOCIAL_POST",
      "stagingContentCount": 5,
      "liveContentCount": 20,
      "createdDate": "2026-01-10T08:00:00.000Z",
      "lastModifiedDate": "2026-01-18T10:35:00.000Z",
      "url": "https://api.interplai.app/v1/collections/col_abc123"
    },
    {
      "id": "col_def456",
      "name": "Fan Messages - Premier League",
      "contentType": "SOCIAL_POST",
      "stagingContentCount": 2,
      "liveContentCount": 10,
      "createdDate": "2026-01-08T12:00:00.000Z",
      "lastModifiedDate": "2026-01-17T14:22:00.000Z",
      "url": "https://api.interplai.app/v1/collections/col_def456"
    }
  ],
  "meta": {
    "page": 0,
    "pageSize": 20,
    "totalItems": 42,
    "totalPages": 3
  }
}

Response fields

Collection summary

Field	Type	Description
id	string	Unique collection identifier
name	string	Collection display name
contentType	string	Content type (see Content Types)
stagingContentCount	integer	Number of staging content items
liveContentCount	integer	Number of live content items
createdDate	string	ISO 8601 creation timestamp
lastModifiedDate	string	ISO 8601 last update timestamp
url	string	URL to fetch the full collection

Pagination meta

Field	Type	Description
page	integer	Current page number (0-indexed)
pageSize	integer	Items per page
totalItems	integer	Total number of collections
totalPages	integer	Total number of pages

Error responses

Status	Code	Description
400	VALIDATION_ERROR	Invalid query parameters
401	MISSING_API_KEY / INVALID_API_KEY	Authentication failure
502	BAD_GATEWAY	Upstream service error
503	SERVICE_UNAVAILABLE	Service temporarily unavailable