Skip to main content
GET
/
collections
List Collections
curl --request GET \
  --url https://getunblocked.com/api/v1/collections \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "Apollo",
    "description": "Documents from the Apollo customer support tool including support responses.",
    "iconUrl": "https://my.company.com/apollo/logo.svg"
  }
]

Authorizations

​
Authorization
string
header
required

The API key to authenticate requests. Obtainable from the web dashboard.

Query Parameters

​
limit
integer<int32>

Limit used to constrain results of list operations. When not specified a default limit of 25 is used.

A maximum limit is applied to the results, so the server may respond with fewer results than requested; clients must not use this as a signal that this is the final page of results.

Required range: 1 <= x <= 200
​
after
string

Opaque cursor to be used for paging in a forward or backward direction. Cursors are stateless and so they never expire.

Required string length: 1 - 10000
​
before
string

Opaque cursor to be used for paging in a forward or backward direction. Cursors are stateless and so they never expire.

Required string length: 1 - 10000

Response

OK

​
id
string<uuid>
required

The ID of the collection.

​
name
string

A brief identifier for the collection.

Example:

"Apollo"

​
description
string

A sentence defining the document type within this collection, aiding the language model in grasping the content's essence.

Example:

"Documents from the Apollo customer support tool including support responses."

​
iconUrl
string

A URL of a square image used to visually represent document references from the collection in the Unblocked UI. Preferred image formats are SVG, PNG, and JPG.

Example:

"https://my.company.com/apollo/logo.svg"