---
title: "List vault variables"
method: GET
path: "/vault-variables"
tags: ["VaultVariables"]
---

# List vault variables

`GET /vault-variables`

## Request

- Base URL: `https://public.escape.tech/v3`
- URL: `https://public.escape.tech/v3/vault-variables`
- Auth: API key in header `X-ESCAPE-API-KEY`

List the vault variables of the organization. Values are never returned: only the id, the type and the name.

## Query parameters

- `cursor` string: The cursor to start the pagination from. Returned by the previous page response. If not provided, the first page will be returned.
- `size` integer: The number of items to return per page
- `search` string: Search term to filter variables by name
- `types` string[]: Filter by variable types

## Response `200`

OK

- object
  - `nextCursor` string, nullable, required
  - `totalCount` integer
  - `data` object[], required
    - `id` string, uuid, required: The id of the vault variable
    - `type` 'EXTERNAL' | 'PLAINTEXT' | 'SECRET', required: The type of the vault variable
    - `name` string, required: The name of the vault variable, referenced from scan configs as ${NAME}

## Other responses

- `400`: Pagination error

---

[API](https://skmtc.dev/escape/apis/escape-public-api.md) - [All operations](https://skmtc.dev/escape/apis/escape-public-api/llms.txt) - [OpenAPI document](https://skmtc.dev/escape/apis/escape-public-api/revisions/2eab35df40c7?raw)