List graphs

GET

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

Results can be filtered by providing specific graph IDs. Regular users will only see graphs they own or have access to. Superusers can see all graphs.

The graphs are returned in order of last modification, with most recent first.

Headers

X-API-KeystringRequired

Query parameters

collection_idsstringOptional

A list of graph IDs to retrieve. If not provided, all graphs 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	response = client.graphs.list()

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