Sign in

v51

latestOpenAPI 3.0.3raw.githubusercontent.com2026-08-01121113461.4 KB
threads

List threads with optional search functionality.

get/api/v1.0/threads/

Query parameters

has_activeinteger

Filter threads that have active messages (1=true, 0=false).

has_archivedinteger

Filter threads that have archived (1=true, 0=false).

has_assigned_to_meinteger

Filter threads assigned to the current user (1=true, 0=false).

has_attachmentsinteger

Filter threads with attachments (1=true, 0=false).

has_delivery_pendinginteger

Filter threads that have delivery pending messages: sending, retry or failed (1=true, 0=false).

has_draftinteger

Filter threads with draft messages (1=true, 0=false).

has_mentioninteger

Filter threads with any mention (read or unread) for the current user (1=true, 0=false).

has_messagesinteger

Filter threads that have messages (1=true, 0=false).

has_senderinteger

Filter threads with messages sent by the user (1=true, 0=false).

has_starredinteger

Filter threads with starred messages (1=true, 0=false).

has_trashedinteger

Filter threads that have trashed messages (1=true, 0=false).

has_unassignedinteger

Filter threads with no active assignment from any user (1=true, 0=false).

has_unreadinteger

Filter threads with unread messages (1=true, 0=false). Requires mailbox_id.

has_unread_mentioninteger

Filter threads with unread mentions for the current user (1=true, 0=false).

is_spaminteger

Filter threads that are spam (1=true, 0=false).

is_trashedinteger

Filter threads that have all messages trashed (1=true, 0=false).

label_slugstring

Filter threads by label slug.

mailbox_idstring uuid

Filter threads by mailbox ID.

pageinteger

A page number within the paginated result set.

searchstring

Search threads by content (subject, sender, recipients, message body).

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}