STstuut
email-threads

List Email Threads

List Email Threads

get/v2/email-threads

Request

  • Base URL
    https://api.stuut.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Query parameters

pageinteger

Page number, 0 indexed.

limitinteger

Number of records per page.

category'all' | 'drafts' | 'sent' | 'unread'

Filter threads by category: drafts, unread, sent, or all.

partner_idstring nullable

Filter threads by partner ID.

invoice_idstring nullable

Filter threads by invoice ID.

credit_memo_idstring nullable

Filter threads by credit memo ID.

workflow_idstring nullable

Filter threads by workflow ID.

business_unit_id__instring[] nullable

Filter threads by business unit IDs. Independent of the user's BU visibility scope, which is always enforced.

assigneestring nullable

Filter by partner assignee user ID. Empty string filters to unassigned threads.

has_responsesboolean nullable

True: threads with more than one email; False: single-email threads.

readboolean nullable

True: no unread inbound emails; False: at least one unread inbound email.

has_open_tasksboolean nullable

Filter threads by whether they have any open tasks.

triage_status'pending' | 'auto_matched' | 'manually_matched' | 'dismissed'

Filter to threads in a specific triage state. Takes precedence over is_triaged and triaged_by__in.

is_triagedboolean nullable

True: AUTO_MATCHED or MANUALLY_MATCHED; False: PENDING. Ignored when triage_status is set.

triaged_by__instring[] nullable

Filter resolved triage threads by the actor that resolved them. Use TRIAGE_AI_ACTOR_ID for AI-resolved.

is_from_centralized_inboxboolean nullable

Filter threads to those from (or not from) the centralized inbox.

is_internalboolean nullable

True: show only internal-to-internal threads (every address on every email belongs to the org). When True, bypasses the default partner_id requirement since internal threads have no partner. False/None: existing behavior.

exclude_draftsboolean

True: skip draft-only threads and order by the latest non-draft email. Drafts inside returned threads are still included.

searchstring nullable

Search threads by partner name or email.

Response

Successful Response

current_pageinteger required

The current page.

total_recordsinteger nullable required

Total number of records.

next_pageinteger nullable required

The next page number, if one exists.

Changes

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