Skip to content

List

The List API endpoint returns a paginated collection of content items. Each response includes up to 100 items per page by default.

This endpoint supports customisable response fields. The structure of each object in the data array depends on the configured list layout. Only fields explicitly enabled in the layout configuration are returned.

Endpoint

GET /api/v1/{content_type}

Path Parameters

Parameter Description
content_type The route identifier of the requested content type

Response Structure

A successful response includes pagination metadata and a data array containing content items.

{
  "current_page": 1,
  "data": [
    {
        "id": 3,
        "deleted_at": null,
        "is_current_owner": 1,
        "is_current_author": 1,
        "is_current_group": 0
    },
    {
        "id": 2,
        "deleted_at": null,
        "is_current_owner": 1,
        "is_current_author": 1,
        "is_current_group": 0
    },
    {
        "id": 1,
        "deleted_at": null,
        "is_current_owner": 1,
        "is_current_author": 1,
        "is_current_group": 0
    }
  ],
  "first_page_url": "http://example.com/api/v1/content_type?page=1",
  "from": 1,
  "last_page": 1,
  "last_page_url": "http://example.com/api/v1/content_type?page=1",
  "links": [
    {
      "url": null,
      "label": "« Previous",
      "page": null,
      "active": false
    },
    {
      "url": "http://example.com/api/v1/content_type?page=1",
      "label": "1",
      "page": 1,
      "active": true
    },
    {
      "url": null,
      "label": "Next »",
      "page": null,
      "active": false
    }
  ],
  "next_page_url": null,
  "path": "http://example.com/api/v1/content_type",
  "per_page": 100,
  "prev_page_url": null,
  "to": 2,
  "total": 2
}

Field Behaviour

Each object in the data array may contain different fields depending on the content type configuration.

Only fields enabled as featured in the list layout configuration are included in the response.

Default Data Fields

The following system-generated fields are automatically included in the response:

Field Type Description
id integer Unique identifier of the item
deleted_at string null
is_current_owner boolean Indicates whether the item is owned by the authenticated user
is_current_author boolean Indicates whether the item was created by the authenticated user
is_current_group boolean Indicates whether the item belongs to the user’s group

Pagination Fields

Field Description
current_page Current page number
per_page Number of items per page (default: 100)
from Index of the first item on the current page
to Index of the last item on the current page
total Total number of items
last_page Total number of pages
path Base request URL
first_page_url URL for the first page
last_page_url URL for the last page
prev_page_url URL for the previous page (if available)
next_page_url URL for the next page (if available)

The links array provides pagination navigation links.

Field Description
url URL for the page (or null if unavailable)
label Display label (e.g. page number or navigation text)
page Page number associated with the link
active Indicates whether the link represents the current page

More Examples

For more examples, visit: