List sessions | Vercel SDK

APIs & SDKs

List sessions

GEThttps://api.vercel.com/v2/sandboxes/sessions

Retrieves a paginated list of sessions belonging to a specific sandbox. Results are sorted by creation time and paginated using an opaque cursor.

Request

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.sandboxes.listSessions({
    project: "prj_abc123",
    name: "my-sandbox",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

"value"

Authentication

AuthorizationbearerToken

Default authentication mechanism

Query parameters

projectstringOptional

The unique identifier or name of the project to list sessions for.

namestringOptional

Filter sessions by sandbox name. Only sessions belonging to the specified sandbox are returned.

limitnumberOptional

Maximum number of sessions to return in the response. Used for pagination.

cursorstringOptional

Opaque pagination cursor from a previous response.

sortOrderstringOptional

Sort direction for results by creation time.

teamIdstringOptional

The Team identifier to perform the request on behalf of.

slugstringOptional

The Team slug to perform the request on behalf of.

Response

200The list of sessions matching the request filters.

Errors

400One of the provided values in the request query is invalid.

401The request is not authorized.

403You do not have permission to access this resource.

404Error

410Error

429Error

500Error

Request

import { Vercel } from "@vercel/sdk";

const vercel = new Vercel({
  bearerToken: "<YOUR_BEARER_TOKEN_HERE>",
});

async function run() {
  const result = await vercel.sandboxes.listSessions({
    project: "prj_abc123",
    name: "my-sandbox",
    teamId: "team_1a2b3c4d5e6f7g8h9i0j1k2l",
    slug: "my-team-url-slug",
  });

  console.log(result);
}

run();

Response

"value"

OpenAPI Specification