---
title: "List threads"
method: GET
path: "/v1/threads"
tags: ["Threads"]
---

# List threads

`GET /v1/threads`

## Request

- Base URL: `https://api.mails.ai`
- URL: `https://api.mails.ai/v1/threads`
- Auth: HTTP bearer

**Requires scope:** `read`.

## Query parameters

- `limit` integer
- `cursor` string
- `agent_id` string
- `status` string
- `folder` 'inbox' | 'archive' | 'spam' | 'trash' | 'sent' | 'all'
- `read` boolean
- `label` string
- `mode` 'live' | 'test' | 'all'
- `q` string

## Response `200`

A page of threads (most-recent activity first).

- object
  - `data` Thread[], required: The items on this page, at most `limit` of them.
    - `id` string, required: Thread id (`thrd_…`).
    - `agent_id` string, required: Id (`agt_…`) of the agent the thread belongs to; a thread holds one agent's mail only.
    - `subject` string: The subject of the thread's first message, without one leading `Re:`, `Fwd:` or `Fw:`. Empty when that message had no subject.
    - `root_message_id` string: Id of the message that started the thread: `msg_…` for one the agent sent, `rcv_…` for one it received.
    - `last_message_id` string: Id of the message that joined the thread most recently (`msg_…` or `rcv_…`).
    - `last_message_at` string, date-time: When the latest message joined the thread. The thread list is ordered by it, newest first.
    - `message_count` integer, required: How many messages have joined the thread, sent and received.
    - `participants` string[]: Every address the thread has involved, in lower case and without repeats: the agent's own, the senders of received mail and the recipients of sent mail.
    - `labels` string[]: Label names, up to 50, each at most 64 characters. Any such name works; names that match a label object also appear in `label_ids`.
    - `label_ids` string[], required: Ids (`lbl_…`) of the label objects whose names are on this thread.
    - `status` 'open' | 'closed' | 'archived', required: `open` (every new thread), `closed` or `archived`, changed with PATCH. `archived` goes with folder `archive`, and only an `open` thread takes in new mail matched by its subject (mail from someone already in the thread).
    - `read` boolean, required: False once new mail arrives; set it with PATCH.
    - `folder` 'inbox' | 'archive' | 'spam' | 'trash' | 'sent', required: `inbox`, `archive`, `spam`, `trash` or `sent`. `archive` goes with status `archived`. `sent` holds a thread whose messages are all ones the agent sent, until a reply moves it to the inbox. Threads in trash are deleted for good 30 days after they were trashed.
    - `trashed_at` string, date-time: When the thread was moved to trash. Present only while it is there.
    - `test_mode` boolean, required: True when the thread holds no live mail: every message in it was sent with a test key (`mk_test_…`) or delivered through `POST /v1/test/inbound`. A thread with any live message is live. Its `thread.*` events carry the same `test_mode`, and `GET /v1/threads` lists a key's own mode unless `mode` says otherwise.
    - `created_at` string, date-time, required: When the thread was created, with its first message.
    - `updated_at` string, date-time: When the thread last changed: a message joined it, or its read state, folder, status or labels changed.
  - `has_more` boolean, required: True when more items follow this page: pass `next_cursor` as `cursor` to get them.
  - `next_cursor` string: Pass as `cursor` to fetch the next page. Absent on the last page.

## Other responses

- `400`: Invalid request — malformed JSON or a field failed validation. Also `feature_not_enabled` when this server has a feature switched off (custom domains before they are available).
- `401`: Missing or invalid API key.
- `403`: The API key lacks the required scope (`insufficient_scope`), or the token belongs to an app connected by sign-in and this operation is closed to connected apps (`connected_app_not_allowed`).
- `409`: Conflict — duplicate resource, an in-progress idempotent request, a draft or scheduled message that started sending while it was being changed, or a thread deleted for good while one of its messages is being sent (`duplicate_resource`); or an agent name more than one agent has (`agent_name_conflict`: use the agent's id); or a status change on an archived agent, since archiving cannot be undone (`agent_archived`).
- `500`: Internal server error.

---

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