Skip to main content
GET
/
v2
/
sandcastles
List Sandcastles
curl --request GET \
  --url https://app.textql.com/v2/sandcastles \
  --header 'Authorization: Bearer <token>'
{
  "sandboxes": [
    {
      "sandbox_id": "<string>",
      "member_id": "<string>",
      "chat_id": "<string>",
      "started_at": "2023-11-07T05:31:56Z",
      "released_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next_cursor": "<string>"
}
Liveness in list results is eventually consistent — a sandbox that died abruptly may report running for a short window (up to ~1 hour). GET /v2/sandcastles/ is the authoritative live check for a single sandbox.

Authorizations

​
Authorization
string
header
required

API key or JWT token

Query Parameters

​
status
enum<string>
default:running

Filter by lease state. running (default) returns sandboxes with an open lease — individual items may report running, stale, or unknown. stopped returns released sandboxes. all returns both.

Available options:
running,
stopped,
all
​
limit
integer<int32>
default:50

Maximum number of sandboxes to return (default 50, max 200)

Required range: 1 <= x <= 200
​
cursor
string

Opaque pagination cursor from a previous response's next_cursor. Omit to start from the first page.

Response

Paginated list of sandboxes

​
sandboxes
object[]
required
​
next_cursor
string | null

Opaque cursor to pass as cursor on the next request. Omitted when there are no more results.