---
title: "List Variables"
method: GET
path: "/api/v1/variables"
tags: ["Variables"]
---

# List Variables

`GET /api/v1/variables`

Retrieves a paginated list of global variables for a specific connector. Can be filtered by `label`, `key`, and `value`.
Note: In the Patchworks dashboard, a `system` is known as a `connector`.

## Query parameters

- `filter[label]` string
- `filter[key]` string
- `filter[value]` string
- `sort` string
- `page` integer
- `per_page` integer

## Response `200`

Successful response

- VariablesListResponse
  - `data` Variables[]
    - `id` integer — Unique identifier
    - `label` string
    - `key` string
    - `value` string
    - `secret` string
    - `locked` string
    - `configurable` string
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `modified` string
    - `pivot` string
    - `required` boolean
    - `advanced` boolean
    - `alias` string
  - `meta` PaginationMeta
    - `current_page` integer
    - `from` integer, nullable
    - `last_page` integer
    - `path` string
    - `per_page` integer
    - `to` integer, nullable
    - `total` integer
  - `links` PaginationLinks
    - `first` string, uri
    - `last` string, uri
    - `prev` string, uri, nullable
    - `next` string, uri, nullable

## Other responses

- `401` — Unauthenticated
- `403` — Unauthorized

---

[API](https://skmtc.net/wearepatchworks/apis/patchworks-core-api.md) · [All operations](https://skmtc.net/wearepatchworks/apis/patchworks-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wearepatchworks/patchworks-core-api/revisions/89261af4dd80/schema)