Skip to content

Get a record

GET
/cms/data/{collection}/records/{id}
curl --request GET \
--url 'https://api.example.com/cms/data/matches/records/1?include=home.country%2Caway' \
--header 'API-Key: <API-Key>'

Frontends only get published records.

collection
required
string

Collection key

Example

matches
id
required
integer

Record ID

include
string

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

Example

home.country,away

The record

Media typeapplication/json
object
data
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"
}
}
}

No such collection or record