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

# GetEditor

`POST /gitpod.v1.EditorService/GetEditor`

GetEditor returns the editor with the given ID

## 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

## Other responses

- `default` — Error

## Changes

- **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`
- **2025-02-14** `988164042da1` — 1 breaking, 8 info
  - the request property `id` became required
  - the response property `editor` became required for the status `200`
  - the response property `editor/allOf[subschema #1: Editor]/alias` became required for the status `200`
  - the response property `editor/allOf[subschema #1: Editor]/iconUrl` became required for the status `200`
  - …5 more

[Change 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/27f7bd641de1/schema)