Collections

List collections visible to the api-key

GET/collections

Collections the linked user can see: their own, public ones, and those shared with them or their usergroup. Ordered by name. Requires the read scope.

X-Api-Key<token>

Issued to you when your integration is provisioned. Determines which catalogue resources are visible and which AI tools are available.

In: header

Query Parameters

limit?integer

Page size (max 100).

Range1 <= value <= 100
Default25
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/collections"
{  "data": {    "items": [      {        "ref": 55,        "name": "Spring catalogue",        "resourceCount": 12,        "created": "2026-07-01 10:00:00"      }    ],    "total": 1,    "limit": 25,    "offset": 0  }}

{  "success": false,  "status": "fail",  "message": "API key is required",  "error": {    "code": "NO_API_KEY",    "message": "API key is required"  }}

{  "success": false,  "status": "fail",  "message": "This API key does not have the 'write' scope",  "error": {    "code": "INSUFFICIENT_SCOPE",    "message": "This API key does not have the 'write' scope"  }}