Skip to navigation
SDK ReferenceGraph

List graphs

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Query parameters

page_sizeintegerOptional1-200Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional
Opaque page cursor
order_byenumOptional
Sort field
Allowed values:
orderenumOptional
asc or desc
Allowed values:

Request

Request body
searchstringOptional
Filters results to graphs whose name, description, or graph ID contains this text.

Response

OK
itemslist of objectsOptional
The graphs on this page.
next_cursorstringOptional
Opaque cursor for retrieving the next page, present only when more results are available.
total_sizeintegerOptional
The total number of graphs that match the request.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error