---
title: "Retrieve a list"
method: GET
path: "/v1/list/{list_id}"
tags: ["list"]
---

# Retrieve a list

`GET /v1/list/{list_id}`

## Request

- Base URL: `http://localhost:3030`
- URL: `http://localhost:3030/v1/list/{list_id}`
- Auth: HTTP bearer

Retrieves a list with its name and how many items it holds.

## Path parameters

- `list_id` string, required: The list's id, `lst_...`.

## Response `200`

The saved list.

- SavedList
  - `object` 'list', required: The object's type. Always `list`.
  - `id` string, required: Unique identifier for the object.
  - `name` string, required: The list's name.
  - `item_count` integer, required: Number of items on the list.
  - `status_counts` StatusCounts, required: Number of items on a list in each status.
    - `new` integer, required: Items with status `new`.
    - `reviewing` integer, required: Items with status `reviewing`.
    - `pursuing` integer, required: Items with status `pursuing`.
    - `passed` integer, required: Items with status `passed`.
  - `created_at` string, date-time, required: Time at which the object was created.
  - `updated_at` string, date-time, required: Time at which the object was last updated.
  - `href` string, required: The object's path in the API.

## Other responses

- `401`: `credential_missing`, `credential_invalid` or `credential_expired`. The request has no valid credential.
- `403`: `scope_missing`, `person_required`, `api_key_not_accepted` or `entitlement_missing`. The credential or plan does not allow this request. `detail` names the reason.
- `404`: `no_such_resource`. No object has that id.
- `422`: `parameter_invalid`, `id_malformed` or a cursor code. A parameter is missing or invalid. `errors` lists each one.
- `429`: `rate_limited`. Too many requests. Retry after the `Retry-After` interval. Nothing is charged.

---

[API](https://skmtc.dev/placestack/apis/placestack-api.md) · [All operations](https://skmtc.dev/placestack/apis/placestack-api/llms.txt) · [OpenAPI document](https://skmtc.dev/placestack/apis/placestack-api/revisions/0ccdf0882668?raw)
