LangChain Reference home pageLangChain ReferenceLangChain Reference
  • GitHub
  • Main Docs
Deep Agents
LangChain
LangGraph
Integrations
LangSmith
  • Overview
  • Client
  • AsyncClient
  • Run Helpers
  • Run Trees
  • Evaluation
  • Schemas
  • Utilities
  • Wrappers
  • Anonymizer
  • Testing
  • Expect API
  • Middleware
  • Pytest Plugin
  • Deployment SDK
⌘I

LangChain Assistant

Ask a question to get started

Enter to send•Shift+Enter new line

Menu

OverviewClientAsyncClientRun HelpersRun TreesEvaluationSchemasUtilitiesWrappersAnonymizerTestingExpect APIMiddlewarePytest PluginDeployment SDK
Language
Theme
PythonlangsmithresourcessandboxesboxesBoxesResourcelist
Method●Since v0.14

list

Copy
list(
  self,
  *,
  created_by: str | Omit = omit
View source on GitHub
,
cursor
:
str
|
Omit
=
omit
,
label
:
SequenceNotStr
[
str
]
|
Omit
=
omit
,
limit
:
int
|
Omit
=
omit
,
name_contains
:
str
|
Omit
=
omit
,
offset
:
int
|
Omit
=
omit
,
page_size
:
int
|
Omit
=
omit
,
sort_by
:
str
|
Omit
=
omit
,
sort_direction
:
str
|
Omit
=
omit
,
sort_order
:
str
|
Omit
=
omit
,
status
:
str
|
Omit
=
omit
,
tag_value_id
:
SequenceNotStr
[
str
]
|
Omit
=
omit
,
extra_headers
:
Headers
|
None
=
None
,
extra_query
:
Query
|
None
=
None
,
extra_body
:
Body
|
None
=
None
,
timeout
:
float
|
httpx
.
Timeout
|
None
|
NotGiven
=
not_given
)
->
SyncItemsCursorGetPagination
[
SandboxResponse
]

Parameters

NameTypeDescription
created_bystr | Omit
Default:omit

Filter by creator identity. Only 'me' is supported.

cursorstr | Omit
Default:omit

Opaque pagination cursor from a prior response's next_cursor

labelSequenceNotStr[str] | Omit
Default:omit
limitint | Omit
Default:omit
name_containsstr | Omit
Default:omit
offsetint | Omit
Default:omit
page_sizeint | Omit
Default:omit
sort_bystr | Omit
Default:omit
sort_directionstr | Omit
Default:omit
sort_orderstr | Omit
Default:omit
statusstr | Omit
Default:omit
tag_value_idSequenceNotStr[str] | Omit
Default:omit
extra_headersHeaders | None
Default:None
extra_queryQuery | None
Default:None
extra_bodyBody | None
Default:None
timeoutfloat | httpx.Timeout | None | NotGiven
Default:not_given

List sandboxes for the authenticated tenant, with optional filtering, sorting, and pagination. Page with page_size and cursor: replay the response's next_cursor until it comes back null, which is the only signal that no pages remain. Cursors are opaque and only valid on this endpoint; do not parse or construct one.

Filter by label. Repeatable; all must match. Use 'key' to match on key presence or 'key=value' for equality.

Deprecated: use page_size. Maximum number of results

Filter by name substring

Deprecated: use cursor. Pagination offset

Number of results per page

Sort column (name, status, created_at, stopped_at, idle_ttl_seconds, delete_after_stop_seconds)

Deprecated: use sort_order. Sort direction (asc, desc)

Sort direction (asc, desc)

Filter by status (provisioning, ready, failed, stopped, deleting)

Filter by workspace resource tag value IDs; all must match

Send extra headers

Add additional query parameters to the request

Add additional JSON properties to the request

Override the client-level default timeout for this request, in seconds