## ListEditors

`editors.list(EditorListParams**kwargs)  -> SyncEditorsPage[Editor]`

**post** `/gitpod.v1.EditorService/ListEditors`

Lists all available code editors, optionally filtered to those allowed in an organization.

Use this method to:

- View supported editors
- Get editor capabilities
- Browse editor options
- Check editor availability

### Examples

- List editors:

  Shows all available editors with pagination.

  ```yaml
  pagination:
    pageSize: 20
  ```

- List editors available to the organization:

  Shows all available editors that are allowed by the policies enforced in the organization with pagination.

  ```yaml
  pagination:
    pageSize: 20
  filter:
    allowedByPolicy: true
  ```

### Parameters

- `token: Optional[str]`

- `page_size: Optional[int]`

- `filter: Optional[Filter]`

  filter contains the filter options for listing editors

  - `allowed_by_policy: Optional[bool]`

    allowed_by_policy filters the response to only editors that are allowed by the policies enforced in the organization

- `pagination: Optional[Pagination]`

  pagination contains the pagination options for listing environments

  - `token: Optional[str]`

    Token for the next set of results that was returned as next_token of a
    PaginationResponse

  - `page_size: Optional[int]`

    Page size is the maximum number of results to retrieve per page.
    Defaults to 25. Maximum 100.

### Returns

- `class Editor: …`

  - `id: str`

  - `installation_instructions: str`

  - `name: str`

  - `url_template: str`

  - `alias: Optional[str]`

  - `icon_url: Optional[str]`

  - `short_description: Optional[str]`

  - `versions: Optional[List[EditorVersion]]`

    versions contains the list of available versions for this editor

    - `version: str`

      version is the version string of the editor
      Examples for JetBrains: 2025.2

### Example

```python
import os
from gitpod import Gitpod

client = Gitpod(
    bearer_token=os.environ.get("GITPOD_API_KEY"),  # This is the default and can be omitted
)
page = client.editors.list(
    pagination={
        "page_size": 20
    },
)
page = page.editors[0]
print(page.id)
```

#### Response

```json
{
  "editors": [
    {
      "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
      "installationInstructions": "installationInstructions",
      "name": "name",
      "urlTemplate": "urlTemplate",
      "alias": "alias",
      "iconUrl": "iconUrl",
      "shortDescription": "shortDescription",
      "versions": [
        {
          "version": "version"
        }
      ]
    }
  ],
  "pagination": {
    "nextToken": "nextToken"
  }
}
```