---
title: "GetEditor"
method: POST
path: "/gitpod.v1.EditorService/GetEditor"
tags: ["gitpod.v1.EditorService"]
---

# GetEditor

`POST /gitpod.v1.EditorService/GetEditor`

Gets details about a specific editor.

 Use this method to:
 - View editor information
 - Get editor configuration

 ### Examples

 - Get editor details:

   Retrieves information about a specific editor.

   ```yaml
   id: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
   ```

## Request body

- GitpodV1GetEditorRequest
  - `id` string, required — id is the ID of the editor to get

## Response `200`

Success

- GitpodV1GetEditorResponse
  - `editor` GitpodV1Editor, required
    - `alias` string
    - `iconUrl` string
    - `id` string, uuid, required
    - `installationInstructions` string, required
    - `name` string, required
    - `shortDescription` string
    - `urlTemplate` string, required
    - `versions` GitpodV1EditorVersion[] — versions contains the list of available versions for this editor
      - `version` string, required — version is the version string of the editor Examples for JetBrains: 2025.2

## Other responses

- `default` — Error

## Changes

> 18 revisions in range; 1 could not be searched.

- **2025-12-15** `d62ef4b9187c` — 1 info
  - added the optional property `editor/versions` to the response with the `200` status
- **2025-02-21** `3655d5ad0ac3` — 1 breaking, 8 info
  - the `editor` response's property type/format changed from ``/`` to `object`/`` for status `200`
  - added the optional property `editor/alias` to the response with the `200` status
  - added the optional property `editor/iconUrl` to the response with the `200` status
  - added the optional property `editor/shortDescription` to the response with the `200` status
  - …5 more
- **2025-02-18** `cd6a05ae99d2` — 1 warning
  - removed the optional property `detail` from the response with the `default` status
- **2025-02-14** `27f7bd641de1` — 3 breaking
  - the response property `editor/allOf[subschema #1: Editor]/alias` became optional for the status `200`
  - the response property `editor/allOf[subschema #1: Editor]/iconUrl` became optional for the status `200`
  - the response property `editor/allOf[subschema #1: Editor]/shortDescription` became optional for the status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/gitpod-io/apis/gitpod-v1/changes/gitpod.v1.EditorService/GetEditor/post.md)

---

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