List all collections

Query parameters

limitinteger | default: 10

Limit the number of objects to return, ranging between 1 and 20.

pageinteger | default: 1

The current page used to display the pagination results.

expandstring[]

Expand the response for the given items. Expand array accepts list.

Response

import Blutui from 'blutui'

const blutui = new Blutui('ey....')

blutui.project('one').admin.collections.list()

JSON Response

{
  "object": "list",
  "data": [
    {
      "id": "0195b544-bc46-7223-851d-3ce553b11ae6",
      "object": "collection",
      "name": "Products",
      "handle": "products",
      "fields": [
        {
          "id": "0195b56e-a8d7-736a-b1f6-93fefa597bb4",
          "name": "title",
          "label": "Title",
          "type": "text",
          "default_value": null,
          "help_text": null,
          "required": true,
          "order": 0,
          "max": "255"
        }
      ],
      "links": [],
      "parent_links": [],
      "deleted_at": null,
      "created_at": "2023-08-14T16:49:46+12:00",
      "updated_at": "2023-08-14T16:49:46+12:00"
    },
    {...},
    {...}
  ],
  "meta": {
    "has_more": false,
    "current_page": 1,
    "from": 1,
    "to": 3,
    "total": 3,
    "per_page": 10,
    "last_page": 1
  }
}

objectstring

This will always contain list for this endpoint.

dataarray

An array of up to limit collection resources. If no collections are available, an empty array is returned.

metaobject

Additional information about the list.

Query parameters

Response

On this page