---
title: "List contacts"
method: GET
path: "/v1/accounts/{accountID}/contacts/list"
tags: ["Contacts"]
---

# List contacts

`GET /v1/accounts/{accountID}/contacts/list`

List merged contacts for a specific account with cursor-based pagination.

## Path parameters

- `accountID` string, required — Account ID this resource belongs to.

## Query parameters

- `cursor` string — Opaque pagination cursor; do not inspect. Use together with 'direction'.
- `direction` 'after' | 'before' — Pagination direction used with 'cursor': 'before' fetches older results, 'after' fetches newer results. Defaults to 'before' when only 'cursor' is provided.
- `limit` integer — Maximum contacts to return per page.
- `query` string — Optional search query for blended contact lookup.

## Response `200`

Request executed successfully

- ListContactsOutput
  - `items` object[], required — Merged contacts for the selected account.
    - `id` string, required — Stable Beeper user ID. Use as the primary key when referencing a person.
    - `username` string — Human-readable handle if available (e.g., '@alice'). May be network-specific and not globally unique.
    - `phoneNumber` string — User's phone number in E.164 format (e.g., '+14155552671'). Omit if unknown.
    - `email` string — Email address if known. Not guaranteed verified.
    - `fullName` string — Display name as shown in clients (e.g., 'Alice Example'). May include emojis.
    - `imgURL` string — Avatar image URL if available. May be temporary or local-only to this device; download promptly if durable access is needed.
    - `cannotMessage` boolean — True if Beeper cannot initiate messages to this user (e.g., blocked, network restriction, or no DM path). The user may still message you.
    - `isSelf` boolean — True if this user represents the authenticated account's own identity.
  - `hasMore` boolean, required — True if additional results can be fetched using cursors.
  - `oldestCursor` string, nullable, required — Cursor for fetching older results (use with direction='before'). Opaque string; do not inspect.
  - `newestCursor` string, nullable, required — Cursor for fetching newer results (use with direction='after'). Opaque string; do not inspect.

## Other responses

- `400` — Invalid request parameters
- `401` — Access token is missing or invalid
- `403` — Access token does not have the required scope
- `404` — Resource not found
- `422` — Unprocessable entity - validation error
- `429` — Too many requests - rate limit exceeded
- `500` — Internal server error

---

[API](https://skmtc.net/beeper/apis/beeper-desktop-api.md) · [All operations](https://skmtc.net/beeper/apis/beeper-desktop-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/beeper/beeper-desktop-api/revisions/5a8ac7b545c4/schema)