Skip to content

List records

GET
/cms/data/{collection}/records
curl --request GET \
--url 'https://api.example.com/cms/data/matches/records?filter%5Bkickoff%5D=%7B%22gte%22%3A%222026-11-25%22%7D&filter%5Bhome%5D=21&sort=kickoff%2C-updatedAt&page_number=1&limit=20&include=home.country%2Caway&status=draft%2Cpublished' \
--header 'API-Key: <API-Key>'

Filters work on the record’s id, externalId, createdAt, updatedAt and publishedAt, and on filterable fields: filter[field]=value (comma-separated: any of them) or filter[field][op]=value with op one of eq, neq, in, gt, gte, lt, lte, between (from,to), exists (1 or 0). Dates are ISO 8601; a date without a time is midnight UTC. Cached for the collection’s cache time; every write in the collection refreshes it.

collection
required
string

Collection key

Example

matches
filter

Filter[field]=value or filter[field][op]=value

object

Example

?filter[kickoff]=[object Object]&filter[home]=21
q
string

Search in titles

sort
string

Comma-separated; - for descending. id, title, createdAt, updatedAt, publishedAt or a single-value filterable field (3 fields at most). Default -updatedAt.

Example

kickoff,-updatedAt
page_number
integer
default: 1
limit
integer
default: 20

1–100

include
string

Reference fields to expand, comma-separated; a dot goes one level further (two at most)

Example

home.country,away
status
string

CMS users only: statuses to list, comma-separated (published when left out). Frontends always get published records.

Example

draft,published

Records

Media typeapplication/json
object
total
integer
page
integer
limit
integer
data
Array<object>
StructuredRecord

A record of a structured data collection

object
id

Record ID

integer
externalId

The connector’s own id for the record, unique in the collection

string
nullable
collection

The collection’s key

string
status

Status. Frontends (API keys not linked to a CMS user) only see published records.

string
Allowed values: draft published archived
title

The value of the collection’s title field

string
data

The field values, by field key. A reference holds the id of what it points to; expand it with include=.

object
included

With include=: what the named reference fields point to, by field key (an object, a list for several values, or null when it is missing or not published)

object
createdAt

Created

string format: date-time
nullable
updatedAt

Last changed

string format: date-time
nullable
publishedAt

First published

string format: date-time
nullable

Example

{
"data": [
{
"id": 27,
"externalId": "opta:m1",
"collection": "matches",
"status": "draft",
"title": "Arsenal v Chelsea",
"data": {
"label": "Arsenal v Chelsea",
"home": 21,
"away": 22,
"kickoff": "2026-11-20T20:00:00+00:00"
}
}
]
}

A filter, sort or include is not valid (the message says why)

No such collection or record