List all links

GET{handle}.blutui.com/admin/api/collections/{collection_id}/links

List all links for a collection in a project.

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.links.list('collection-id')
JSON Response
{
  "object": "list",
  "data": [
    {
      "id": "0195b611-161e-733c-9372-72985cffa043",
      "object": "collection_link",
      "collection_id": "0195b60e-87c6-7063-9b8a-e4c75d1b1268",
      "to": "0195b544-bc46-7223-851d-3ce553b11ae6",
      "type": "hasMany",
      "through_field": "title",
      "foreign_key": "collection",
      "created_at": "2025-03-21T13:18:47+13:00",
      "updated_at": "2025-03-21T13:18:47+13: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 link resources. If no collection links are available, an empty array is returned.

metaobject

Additional information about the list.

Last updated on

On this page