List collections
const url = 'https://api.example.com/cms/data';const options = {method: 'GET', headers: {'API-Key': '<API-Key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.example.com/cms/data \ --header 'API-Key: <API-Key>'Every structured data collection and its fields.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Collections
object
A structured data collection: a user-defined shape whose records connectors write and frontends read.
object
Collection ID
The key used in the API path (/cms/data/{key}). Never changes.
Name
Description
Bootstrap Icons class
The text field whose value is a record’s title
The fields a record’s data can hold
A field of a structured data collection. Its key and type never change once saved.
object
The field’s name in a record’s data: a lowercase letter, then lowercase letters, numbers and underscores
Name shown in the CMS
Field type
Help for connector developers
A value is required in every record
The value is a list of items of the type (text, number, date, datetime, enum, media, reference)
No two records of the collection can hold the same value
Can be used in filter[…] and sort when listing records. Lists, references and media always are.
Text: the maximum length
Number: the minimum
Number: the maximum
Number: whole numbers only
Enum: the allowed values
Reference: what it points to, “record:
The value a record gets when none is sent
When the collection last changed
GET /cms/data/{collection} only: the JSON Schema of a record’s data, to validate what a connector sends
object
Example
{ "data": [ { "id": 3, "key": "matches", "name": "Matches", "icon": "bi-calendar-event", "titleField": "label", "fields": [ { "key": "kickoff", "name": "Kick-off", "type": "text", "values": [ "Grass", "Hybrid" ], "target": "record:teams" } ] } ]}