Skip to content

List Items

Retrieve a list of items from a collection.

Endpoint: GET /items/{collection}

Parameters

Path Parameters

NameTypeRequiredDescription
collectionstringYesUnique identifier of the collection

Query Parameters

NameTypeDescription
fieldsarrayControl which fields are returned in the response
limitintegerLimit the number of objects returned
offsetintegerNumber of items to skip when fetching data
sortarrayCSV of fields to sort by (use - prefix for descending order)
filterobjectFilter items by given conditions
searchstringFilter items containing the search query in any field
metastringSpecify what metadata to return
backlinkbooleanRetrieve relational items excluding reverse relations when using wildcard fields

Responses

200 OK

Successful request returns an array of items:

json
{
  "data": [
    {
      "id": 1,
      "title": "Item 1",
      ...
    }
  ],
  "meta": {
    "total_count": 100,
    "limit": 10,
    "offset": 0
  }
}

401 Unauthorized

Authentication required. Include a valid access token in the Authorization header.

404 Not Found

The specified collection does not exist.

Example Request

http
GET /items/articles?fields=id,title,status&limit=20&sort=-date_created&filter={"status":"published"} HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN

Notes

  • Sorting defaults to ascending (ASC). Prefix field names with - for descending (DESC)
  • The filter parameter supports various operators like _eq, _contains, _gt, etc.
  • Use the fields parameter to optimize response size by requesting only needed fields
  • Pagination metadata is included in the meta object when applicable
  • The backlink parameter is useful when using wildcard fields (*) to avoid circular references