## GetEditor

`client.editors.retrieve(EditorRetrieveParamsbody, RequestOptionsoptions?): EditorRetrieveResponse`

**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"
  ```

### Parameters

- `body: EditorRetrieveParams`

  - `id: string`

    id is the ID of the editor to get

### Returns

- `EditorRetrieveResponse`

  - `editor: Editor`

    editor contains the editor

    - `id: string`

    - `installationInstructions: string`

    - `name: string`

    - `urlTemplate: string`

    - `alias?: string`

    - `iconUrl?: string`

    - `shortDescription?: string`

    - `versions?: Array<EditorVersion>`

      versions contains the list of available versions for this editor

      - `version: string`

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

### Example

```typescript
import Gitpod from '@gitpod/sdk';

const client = new Gitpod({
  bearerToken: process.env['GITPOD_API_KEY'], // This is the default and can be omitted
});

const editor = await client.editors.retrieve({ id: 'd2c94c27-3b76-4a42-b88c-95a85e392c68' });

console.log(editor.editor);
```

#### Response

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