---
title: "List all contact lists"
method: GET
path: "/v1/lists"
tags: ["Lists"]
---

# List all contact lists

`GET /v1/lists`

## Request

- Base URL: `https://api.honkio.ca`
- URL: `https://api.honkio.ca/v1/lists`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Requires `lists:r`.

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

A page of lists, newest first, each with its entries.

- object: Offset pagination, returned alongside `data` by the verify, contacts, contact groups and lists listings.
  - `total` integer, required: Total matching records.
  - `limit` integer, required
  - `offset` integer, required
  - `data` ContactList[], required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `entry_count` integer, required
    - `entries` object[], required
      - `id` string, required
      - `phone_number` string, nullable, required: Set on a direct number entry.
      - `contact_id` string, nullable, required: Set on a contact entry.
      - `contact_group_id` string, nullable, required: Set on a group entry, which expands to the group's members at send time.
      - `contact_name` string, nullable, required
      - `contact_phone` string, nullable, required
      - `group_name` string, nullable, required
      - `added_at` string, date-time, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required

## Other responses

- `401`: Missing, invalid, revoked or expired API key.
- `402`: The account has no balance, or a LIVE key was used before the first top-up.
- `403`: The API key lacks the permission this operation requires, or the account is suspended or closed.
- `422`: VALIDATION_ERROR: the request failed validation; details names the fields.
- `429`: Rate limit reached: 100 requests per second per account, or a route-specific limit (Retry-After set where one applies).
- `500`: Unexpected server error.

---

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