Items
List all items in a collection
Returns a list of the items in the given collection.
Query Parameters
Unique identifier of the collection the item resides in.
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
How many items to skip when fetching data.
What metadata to return in the response.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
GET /items/{collection}
{
"data": [
{}
]
}
Create Multiple Items
Create new items in the given collection.
Query Parameters
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
What metadata to return in the response.
Request Body
POST /items/{collection}
{
"data": [
{}
],
"meta": {}
}
Delete Multiple Items
Delete multiple items at the same time.
Query Parameters
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
Any of the following:
Primary keys of items to be deleted.
Object containing either keys or query to selected what items to update.
DELETE /items/{collection}
Update Multiple Items
Update multiple items at the same time.
Query Parameters
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
A limit on the number of objects that are returned.
What metadata to return in the response.
How many items to skip when fetching data.
How to sort the returned items. sort is a CSV of fields used to sort the fetched items. Sorting defaults to ascending (ASC) order but a minus sign (-) can be used to reverse this to descending (DESC) order. Fields are prioritized by their order in the CSV. You can also use a ? to sort randomly.
Select items in collection by given conditions.
Filter by items that contain the given search query in one of their fields.
Request Body
PATCH /items/{collection}
{
"data": [
{}
],
"meta": {}
}
Create an item
Create a new item in the given collection.
Query Parameters
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
POST /items/{collection}
{
"data": {}
}
Retrieve a Singleton
Retrieves a singleton of a given collection. The REST and GraphQL requests for singletons are the same as those used to Get Items but in contrast the response consists of a plain item object (the singleton) instead of an array of items.
Query Parameters
Collection of which you want to retrieve the items from.
Retrieve an item's state from a specific Content Version. The value corresponds to the "key" of the Content Version.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /items/{collection}/singleton
{
"data": {}
}
Update Singleton
Update a singleton item. The REST and GraphQL requests for singletons are the same as those used to Update Multiple Items but in contrast the request should consist of the plain item object.
Query Parameters
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
PATCH /items/{collection}/singleton
{
"data": {}
}
Retrieve an Item
Retrieves an item in a given collection.
Query Parameters
Unique identifier for the object.
Collection of which you want to retrieve the items from.
Retrieve an item's state from a specific Content Version. The value corresponds to the "key" of the Content Version.
Control what fields are being returned in the object.
What metadata to return in the response.
GET /items/{collection}/{id}
{
"data": {}
}
Delete an item
Delete an existing item.
Query Parameters
Unique identifier of the item.
Collection of which you want to retrieve the items from.
DELETE /items/{collection}/{id}
Update an item
Update an existing item.
Query Parameters
Unique identifier of the item.
Collection of which you want to retrieve the items from.
Control what fields are being returned in the object.
What metadata to return in the response.
Request Body
PATCH /items/{collection}/{id}
{
"data": {}
}