List collections

GET

Returns a paginated list of collections the authenticated user has access to.

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.

Headers

X-API-KeystringRequired

Query parameters

idsstringOptional

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

offsetintegerOptional>=0Defaults to 0

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

limitintegerOptional>=1<=1000Defaults to 100

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

Response

Successful Response

resultslist of objects

total_entriesinteger

Errors

Built with

1	from r2r import R2RClient
2
3	client = R2RClient()
4	# when using auth, do client.login(...)
5
6	result = client.collections.list(
7	offset=0,
8	limit=10,
9	)

1	{
2	"results": [
3	{
4	"id": "id",
5	"name": "name",
6	"graph_cluster_status": "graph_cluster_status",
7	"graph_sync_status": "graph_sync_status",
8	"created_at": "2024-01-15T09:30:00Z",
9	"updated_at": "2024-01-15T09:30:00Z",
10	"user_count": 1,
11	"document_count": 1,
12	"owner_id": "owner_id",
13	"description": "description"
14	}
15	],
16	"total_entries": 1
17	}