Collections

List resources in a collection

GET/collections/{ref}/resources

Resources in the collection, in the collection's own sort order. Includes both active and archived resources (see each item's archive flag). Requires the read scope and read access to the collection.

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

Path Parameters

ref*integer

Collection id.

Query Parameters

limit?integer
Range1 <= value <= 100
Default48
offset?integer
Range0 <= value
Default0

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/collections/0/resources"
{  "data": {    "items": [      {        "ref": 101,        "title": "A Book of Verse",        "resourceType": 0,        "resourceTypeName": "Document",        "fileExtension": "epub",        "created": "string",        "archive": 0      }    ],    "total": 0,    "limit": 48,    "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"  }}

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