Threads

List threads

Threads in inbox order, filtered by folder and by contact CRM state.

get/threads

Request

  • Base URL: https://inboxapp.com/api/v2
  • URL: https://inboxapp.com/api/v2/threads
  • Auth: HTTP bearer

Query parameters

accountLinkIdCuid2[]

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

platformPlatform[]

Repeat the key to match any of several.

[
  "twitter"
]
contactIdCuid2[]

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

folder'inbox' | 'noReply' | 'requests' | 'archived' | 'all'

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.

tagstring[]

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

statusstring[]

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

assigneeIdCuid2[]

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.

unassignedboolean

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

campaignIdCuid2[]

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.

qstring

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

order'desc' | 'asc'

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.

expandstring[]

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

limitinteger

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

cursorstring

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

Response

OK

nextCursorstring nullable required

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

Changes

No recorded changes to this operation across all 1 revision of this API.