Skip to main content
GET
/
api
/
r2r
/
v3
/
collections
List collections
curl --request GET \
  --url https://api.intelligence.io.solutions/api/r2r/v3/collections \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "id",
      "name": "name",
      "graph_cluster_status": "graph_cluster_status",
      "graph_sync_status": "graph_sync_status",
      "created_at": "2024-01-15T09:30:00Z",
      "updated_at": "2024-01-15T09:30:00Z",
      "user_count": 1,
      "document_count": 1,
      "owner_id": "owner_id",
      "description": "description"
    }
  ],
  "total_entries": 1
}
Results can be filtered by providing specific collection IDs. Regular users will only see collections they own or have access to. Superusers can see all collections. The collections are returned in order of last modification, with most recent first.

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

​
ids
string

A list of collection IDs to retrieve. If not provided, all collections will be returned.

​
offset
integer
default:0

Specifies the number of objects to skip. Defaults to 0. м

​
limit
integer
default:100

Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100. >=1 <=1000

​
owner_only
boolean
default:false

If true, only returns collections owned by the user, not all accessible collections.

Response

200

​
results
object[]
​
total_entries
integer
default:0
Example:

1

⌘I