Skip to main content
GET
List threads

Query Parameters

Threads of these account links. Repeat the key to match any of several.

Pattern: ^[0-9a-z]+$
platform
string[]

Repeat the key to match any of several.

The platform. Every team can use twitter; a team may have others enabled.

contactId
string[]

Threads with these contacts. With accountLinkId, finds the thread between an account and a contact. Repeat the key to match any of several.

Pattern: ^[0-9a-z]+$
folder
enum<string>

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.

Available options:
inbox,
noReply,
requests,
archived,
all
tag
string[]

Threads whose contact has one of these tags. Repeat the key to match any of several.

A tag, by ID or by name. Names match ignoring case and accents. When a value is one tag's ID and another's name, the ID wins.

status
string[]

Threads whose contact has one of these statuses. Repeat the key to match any of several.

A status, by ID or by name. Names match ignoring case and accents. When a value is one status's ID and another's name, the ID wins.

assigneeId
string[]

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.

Pattern: ^[0-9a-z]+$
unassigned
boolean

true keeps threads with no assignee, including through their contact. Not combinable with assigneeId.

campaignId
string[]

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.

Pattern: ^[0-9a-z]+$
q
string

Searches profile display names, usernames and the activity preview. Results follow order, not relevance.

Minimum string length: 1
order
enum<string>

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.

Available options:
desc,
asc
expand
enum<string>[]

Related resources to embed next to their ID field, one path per key, at most 4.

Maximum array length: 4
Available options:
profile,
contact,
accountLink,
assignee
limit
integer

Page size, from 1 to 100. Defaults to 50.

Required range: 1 <= x <= 100
cursor
string

The previous page's nextCursor. Opaque, and valid only with the filters it was issued for.

Response

In inbox order, newest first unless order is asc.

In inbox order, newest first unless order is asc.

data
object[]
required
nextCursor
string | null
required

Pass it back as cursor, with the same filters, to read the next page. Null on the last page.