Skip to main content
GET
/
collections
List collections
curl --request GET \
  --url https://api.thehaystack.ai/v2/bevly/collections \
  --header 'Authorization: Bearer <token>'
{
  "collections": [
    {
      "id": 1,
      "name": "Sunday Sermons",
      "itemDescriptor": "sermon"
    }
  ],
  "total": 123,
  "page": 123,
  "pageSize": 123
}

Authorizations

​
Authorization
string
header
required

Enter your API token from the Haystack dashboard

Query Parameters

​
_limit
integer
default:50

Maximum number of records to return (max: 100, default: 50)

Required range: 1 <= x <= 100
​
_offset
integer
default:0

Number of records to skip for pagination (default: 0)

Required range: x >= 0
​
_orderBy
string[]

Sort order as array of strings in format 'fieldName,direction' (e.g., 'title,ASC'). Can specify multiple.

​
_expand
enum<string>[]

Related entities to include in the response

Available options:
variantTypes
​
_withDeleted
boolean
default:false

Include soft-deleted records in the results

Response

200 - application/json

List of collections with pagination metadata (limit, offset, page, totalRecords, totalPages, hasMore)

​
collections
object[]
​
total
integer
​
page
integer
​
pageSize
integer