---
title: "List contact groups"
method: GET
path: "/v1/contact-groups"
tags: ["Contact Groups"]
---

# List contact groups

`GET /v1/contact-groups`

## Request

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

Requires `contact_groups:r`.

## Query parameters

- `limit` integer
- `offset` integer
- `search` string

## Response `200`

A page of groups, newest first, each with its members.

- 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` ContactGroup[], required
    - `id` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `member_count` integer, required
    - `members` object[], required
      - `id` string, required: The contact id.
      - `phone_number` string, nullable, required
      - `name` string, nullable, 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)