Get a collection

Returns a single collection. A deleted collection returns 404.

The fields array includes fields with a status of deleted, so entries written against an older schema still make sense. Only fields marked active accept new values.

Path parameters

collectionIdstringrequired

ID of the collection.

Response · 200

collectionobjectrequired

Show 9 propertiesHide properties

idstringrequired

namestringrequired

descriptionstring | nullrequired

fieldsobject[]required

Show 8 propertiesHide properties

idstringrequired

labelstringrequired

typeenumrequired

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredbooleanrequired

statusenumrequired

One of: active, deleted

optionsobject[] | nullrequired

Show 3 propertiesHide properties

valuestringrequired

labelstringrequired

statusenumrequired

One of: active, deleted

repeatedbooleanrequired

fieldsobject[] | nullrequired

Show 6 propertiesHide properties

idstringrequired

labelstringrequired

typeenumrequired

One of: text, number, boolean, date, timestamp, url, asset, select, group

requiredbooleanrequired

statusenumrequired

One of: active, deleted

optionsobject[] | nullrequired

displayFieldIdstring | nullrequired

defaultSortobject | nullrequired

Show 2 propertiesHide properties

fieldIdstringrequired

directionenumrequired

One of: asc, desc

statusenumrequired

One of: active, deleted

createdAtstringrequired

updatedAtstringrequired

Errors: 400, 401, 404, 405, 429, 500. See Errors for the response shape.