Skip to main content
GET
Search 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, linkedin, whatsapp; 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]+$
view
string

A view's id from List views: lists the threads that view lists, in place of folder. Every other filter narrows it. A cursor issued for a saved view is invalidCursor once the view changes.

Minimum string length: 1
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. Each folder is also a view: inbox, awaitingReply for noReply, requests, archived and all.

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
required

Matched with typo tolerance against profile display names and usernames, the contact's name and the activity preview.

Minimum string length: 1
limit
integer

How many best matches to return, from 1 to 50. Defaults to 25.

Required range: 1 <= x <= 50
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

Response

OK

Most relevant first, in one page: nextCursor is always null.

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.