---
title: "Get a list of sessions"
method: GET
path: "/v1/sessions"
tags: ["sessions"]
---

# Get a list of sessions

`GET /v1/sessions`

Get a paginated list of sessions filtered by ID or status

## Query parameters

- `sessionIds` string
- `status` 'awaitingCapacity' | 'initializing' | 'running' | 'ended' | 'completed' | 'cancelled' | 'all' — Status of the session to get.
- `offset` integer
- `limit` integer

## Headers

- `Authorization` string, required

## Response `200`

OK

- TypeSessionsResponse
  - `data` TypeSessionsWithPagination, required
    - `pagination` TypePagination, required
      - `currentLimit` integer, required — The number of items to return
      - `currentPage` integer, required — The current page number
      - `finalCount` integer, required — The final count of items displayed on the current page
      - `hasMore` boolean, required — Whether there are more items
      - `initialCount` integer, required — The initial count of items displayed on the current page
      - `nextOffset` integer, required — The number of items to skip
      - `numberOfPages` integer, required — The total number of pages
      - `totalItems` integer, required — The total number of items
    - `sessions` TypeExternalSessionWithConnectionInfo[] — List of sessions.
      - `cdpUrl` string — Url to connect to chrome devtools protocol port on the Airtop browser. Include the header 'Authorization: Bearer <api-key>.'
      - `cdpWsUrl` string — Websocket url to connect to the Airtop browser for CDP-based automation frameworks (e.g. Puppeteer or Playwright). Include the header 'Authorization: Bearer <airtop-api-key>.'
      - `chromedriverUrl` string — Websocket url to connect to the Airtop browser for webdriver-based automation frameworks (e.g. Selenium). Include the header 'Authorization: Bearer <airtop-api-key>.'
      - `configuration` TypeExternalSessionConfig, required
        - `baseProfileId` string — Id of a profile to load into the session.
        - `persistProfile` boolean — Persist the profile.
        - `timeoutMinutes` integer — Max length of session in minutes, after which it will terminate if not already deleted.
      - `currentUsage` integer — Current usage in minutes.
      - `dateCreated` string, date-time — Date the session was created.
      - `id` string, uuid, required — Id of the session.
      - `lastActivity` string, date-time — Date of the last activity.
      - `profileId` string — Id of a newly persisted profile. DEPRECATED: Use profileName.
      - `status` string, required — Session status.
      - `viceUrl` string — -
  - `errors` TypeIssue[]
    - `code` string — Issue code.
    - `details` object — Any associated details.
    - `message` string, required — Message describing the issue.
    - `reason` string — Underlying reason for the issue.
  - `meta` TypeEnvelopeDefaultMeta, required
    - `requestId` string
  - `warnings` TypeIssue[]
    - `code` string — Issue code.
    - `details` object — Any associated details.
    - `message` string, required — Message describing the issue.
    - `reason` string — Underlying reason for the issue.

## Other responses

- `404` — Not Found
- `422` — Unprocessable Entity
- `500` — Internal Server Error

---

[API](https://skmtc.net/airtop/apis/airtop-api.md) · [All operations](https://skmtc.net/airtop/apis/airtop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/airtop/airtop-api/versions/77d6e0f03453/schema)