List threads
threads_listList threads
Threads in inbox order, filtered by folder and by contact CRM state.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| q | No | Searches profile display names, usernames and the activity preview. Results follow `order`, not relevance. | |
| tag | No | Threads whose contact has one of these tags. Repeat the key to match any of several. | |
| limit | No | Page size, from 1 to 100. Defaults to 50. | |
| order | No | Sort direction by inbox order: `activity.at`, or `createdAt` for a thread with no activity. A reminder or an accepted message request moves a thread up until its next message, without changing `activity.at`. Defaults to `desc`, newest first. | |
| cursor | No | The previous page's `nextCursor`. Opaque, and valid only with the filters it was issued for. | |
| expand | No | Related resources to embed next to their ID field, one path per key, at most 4. | |
| folder | No | Defaults to `inbox`, threads that are neither archived nor requests. `noReply` is the `inbox` threads whose latest activity is inbound. `requests` holds unarchived threads where `isRequest` is true. `archived` includes requests. `all` spans every folder. Every other filter narrows the folder. | |
| status | No | Threads whose contact has one of these statuses. Repeat the key to match any of several. | |
| platform | No | Repeat the key to match any of several. | |
| contactId | No | Threads with these contacts. With `accountLinkId`, finds the thread between an account and a contact. Repeat the key to match any of several. | |
| assigneeId | No | Threads whose `assigneeId`, the thread's own assignee or else its contact's, is one of these members. Repeat the key to match any of several. | |
| campaignId | No | Threads these campaigns sent a message in. Campaign sends archive the thread, so pair it with `folder=archived` or `all`. Repeat the key to match any of several. | |
| unassigned | No | `true` keeps threads with no assignee, including through their contact. Not combinable with `assigneeId`. | |
| accountLinkId | No | Threads of these account links. Repeat the key to match any of several. |