List document collections

GET

Retrieves all collections that contain the specified document. This endpoint is restricted to superusers only and provides a system-wide view of document organization.

Collections are used to organize documents and manage access control. A document can belong to multiple collections, and users can access documents through collection membership.

The results are paginated and ordered by collection creation date, with the most recently created collections appearing first.

NOTE - This endpoint is only available to superusers, it will be extended to regular users in a future release.

Path parameters

idstringRequired

Document ID

Query parameters

offsetintegerOptional

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

limitintegerOptional

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("http://localhost:7272")
4	# when using auth, do client.login(...)
5
6	response = client.documents.list_collections(
7	id="b4ac4dd6-5f27-596e-a55b-7cf242ca30aa", offset=0, limit=10
8	)

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	}