List Collection Items

Get all items for a given collection.

Request


GET https://app.ycode.com/api/v1/collections/{collection_id}/items

Path parameters

Parameter	Type	Required	Description
`collection_id`	`string`	Yes	Unique identifier for the collection

Query parameters

Parameter	Type	Description
`include`	`string`	Include nested reference and multi-reference relations. Comma-separated field names (e.g. `Author,Categories`).
`fields`	`string`	Limit the returned fields. Format: `fields[CollectionName]=Field1,Field2` (e.g. `fields[Blogposts]=Name,Summary`). Nested relation fields use dot notation: `fields[Blogposts.Author]=Name`.
`filter`	`string`	Filter records by exact match on a field value. Format: `filter[FieldName]=value` (e.g. `filter[Name]=Blogpost title`).
`sort_by`	`string`	Sort records by a given field name (e.g. `Name`).
`order_by`	`string`	Order direction: `asc` or `desc`.
`page`	`integer`	Page number for paginated results.
`per_page`	`integer`	Number of items per page (e.g. `150`).
`limit`	`integer`	Limit the total number of records returned (e.g. `20`).

Headers

Header	Value
Authorization	`Bearer YOUR_API_TOKEN`

Response

Returns an array of item objects in data and a pagination object.

Pagination fields

Field	Type	Description
`per_page`	`integer`	Number of items per page
`limit`	`integer`	Limit applied to the results
`current_page`	`integer`	Current page number
`total`	`integer`	Total number of items in the collection

Example response


{
  "data": [
    {
      "_ycode_id": "16687860798456377a79fce481",
      "ID": 1,
      "Name": "Blogpost title",
      "Slug": "blogpost-title",
      "Created date": "2022-11-18T15:41:19.000Z",
      "Updated date": "2022-11-18T15:42:03.000Z",
      "Summary": "Lorem ipsum dolor sit amet...",
      "Main Image": "https://storage.googleapis.com/ycode-prod-uploads/...",
      "Featured": 1,
      "Author": "16687859744696377a736727d8",
      "Categories": [
        "1669309639520637fa4c77eea7",
        "1669309662211637fa4de338d6"
      ],
      "Body": "<p>Lorem ipsum dolor sit amet...</p>"
    }
  ],
  "pagination": {
    "per_page": 100,
    "limit": null,
    "current_page": 1,
    "total": 10
  }
}

Example requests

Basic request:


curl https://app.ycode.com/api/v1/collections/637781341a6f7/items \
  -H "Authorization: Bearer YOUR_API_TOKEN"

With includes, filtering, and pagination:


curl "https://app.ycode.com/api/v1/collections/637781341a6f7/items?include=Author,Categories&filter[Featured]=1&sort_by=Name&order_by=asc&page=1&per_page=20" \
  -H "Authorization: Bearer YOUR_API_TOKEN"