---
title: "List All Sessions"
method: GET
path: "/v1/sessions"
tags: ["Sessions"]
---

# List All Sessions

`GET /v1/sessions`

## Request

- Base URL: `https://api.edgegap.com`
- URL: `https://api.edgegap.com/v1/sessions`
- Auth: API key in header `authorization`

List all the active sessions.

## Response `200`

Success

- Sessions
  - `data` SessionContext[]: List of Active Sessions
    - `session_id` string, required: Unique UUID
    - `custom_id` string: Custom ID if Available
    - `status` string, required: Current status of the session
    - `ready` boolean, required: If the session is linked to a Ready deployment
    - `linked` boolean, required: If the session is linked to a deployment
    - `kind` string, required: Type of session created
    - `user_count` integer, required: Count of user this session currently have
    - `deployment_request_id` string: Unique UUID
    - `webhook_url` string: When your Session is Linked, Unprocessable or in Error, we will POST the session's details on the webhook_url
  - `total_count` integer: Total Session in the Database
  - `pagination` Pagination
    - `number` integer: Current page number
    - `next_page_number` integer: Next page number
    - `previous_page_number` integer: Previous page number
    - `paginator` Paginator
      - `num_pages` integer: Total pages count
    - `has_next` boolean: If there is a next page
    - `has_previous` boolean: If there is a previous page

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `404`: Not Found
- `500`: Internal Server Error

---

[API](https://skmtc.dev/edgegap/apis/edgegap-v1.md) · [All operations](https://skmtc.dev/edgegap/apis/edgegap-v1/llms.txt) · [OpenAPI document](https://skmtc.dev/edgegap/apis/edgegap-v1/revisions/9fa2b393a6be?raw)
