# Retrieve a list

Source: https://kirora.io/docs/api/reference/getList

`GET /v1/lists/{id}`

Requires an API key with the `lists:read` scope. [About keys and scopes](https://kirora.io/docs/api/reference/authentication)

Works with integration, agent and partner keys. Also available to embed sessions.

Returns one list. Its members are read with `GET /v1/contacts?listId=`, which takes the same filters and pages as any contact list.

## Path parameters

- `id` (string, required, uuid) — The list's id.

## Header parameters

- `Kirora-Workspace` (string, optional, pattern `^[A-Za-z0-9._:-]{1,128}$`) — Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.

## Returns

Returns `200 OK` with a `List` in `data`. Otherwise returns an error; [Errors](https://kirora.io/docs/api/reference/errors) lists every code and which to retry.

- `id` (string, required, uuid)
- `name` (string, required)
- `description` (string | null, required)
- `createdAt` (string, required, date-time)
- `updatedAt` (string, required, date-time)

## Example

```bash
curl https://api.kirora.io/v1/lists/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b \
  -H "Authorization: Bearer $KIRORA_API_KEY"
```

Response `200`:

```json
{
  "data": {
    "id": "0192f3a2-1b3c-7e5d-8a21-4f6a7b8c9d0e",
    "name": "Newsletter",
    "description": "Everyone who wants the monthly newsletter",
    "createdAt": "2026-09-01T10:00:00.000Z",
    "updatedAt": "2026-10-01T09:30:00.000Z"
  }
}
```
