---
title: "ListSessions"
method: POST
path: "/gitpod.v1.SessionService/ListSessions"
tags: ["gitpod.v1.SessionService"]
---

# ListSessions

`POST /gitpod.v1.SessionService/ListSessions`

## Query parameters

- `pageSize` integer
- `token` string

## Request body

- GitpodV1ListSessionsRequest
  - `pagination` GitpodV1PaginationRequest
    - `pageSize` integer — Page size is the maximum number of results to retrieve per page. Defaults to 25. Maximum 100.
    - `token` string — Token for the next set of results that was returned as next_token of a PaginationResponse
  - `phase` 'SESSION_PHASE_UNSPECIFIED' | 'SESSION_PHASE_ACTIVE' | 'SESSION_PHASE_ARCHIVED'

## Response `200`

Success

- GitpodV1ListSessionsResponse
  - `pagination` GitpodV1PaginationResponse
    - `nextToken` string — Token passed for retrieving the next set of results. Empty if there are no more results
  - `sessions` GitpodV1Session[]
    - `description` string
    - `id` string
    - `name` string
    - `orchestratorAgentExecutionId` string — orchestrator_agent_execution_id is the agent execution that drives this session's name. The first agent execution linked to a session becomes its orchestrator.
    - `phase` 'SESSION_PHASE_UNSPECIFIED' | 'SESSION_PHASE_ACTIVE' | 'SESSION_PHASE_ARCHIVED'
    - `resources` GitpodV1SessionResource[]
      - `description` string, nullable
      - `id` string
      - `kind` 'SESSION_RESOURCE_KIND_UNSPECIFIED' | 'SESSION_RESOURCE_KIND_ISSUE' | 'SESSION_RESOURCE_KIND_PULL_REQUEST' | 'SESSION_RESOURCE_KIND_DOCUMENTATION'
      - `role` 'SESSION_RESOURCE_ROLE_UNSPECIFIED' | 'SESSION_RESOURCE_ROLE_OWNED' | 'SESSION_RESOURCE_ROLE_PRIMARY' | 'SESSION_RESOURCE_ROLE_SUBAGENT' | 'SESSION_RESOURCE_ROLE_FIXES' | 'SESSION_RESOURCE_ROLE_BLOCKED_BY' | 'SESSION_RESOURCE_ROLE_BLOCKS' | 'SESSION_RESOURCE_ROLE_REVIEWS' | 'SESSION_RESOURCE_ROLE_CREATED' | 'SESSION_RESOURCE_ROLE_REFERENCES'
      - `title` string, nullable
      - `url` string, nullable

## Other responses

- `default` — Error

---

[API](https://skmtc.net/gitpod-io/apis/gitpod-v1.md) · [All operations](https://skmtc.net/gitpod-io/apis/gitpod-v1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gitpod-io/gitpod-v1/revisions/44d50c2ac284/schema)