Skip to main content
GET
List reply drafts

Authorizations

X-API-Key
string
header
required

Query Parameters

status
enum<string>[] | null

Only drafts in any of these states, repeated for several. pending_approval is a reply waiting for a person.

Maximum array length: 8

Where one drafted reply stands.

STALE is its own terminal state rather than a flavour of DISCARDED: "the prospect wrote again before anyone answered" and "a human said no" are different facts, and only the second one says anything about draft quality.

The send states past SCHEDULED exist for the same reason SEND_UNKNOWN does: once a draft can leave without a person watching, "we do not know" has to be a state of its own. Collapsing it into SEND_FAILED would have a retry send the same reply twice; collapsing it into SENT would lose a reply silently.

Available options:
pending_approval,
sent,
discarded,
stale,
scheduled,
sending,
send_unknown,
send_failed
thread_id
string<uuid> | null

Only the drafts of this conversation

limit
integer
default:10

The number of items to return.

Required range: 1 <= x <= 100
order_by
enum<string>
default:id
Available options:
id
order_direction
enum<string>
default:desc
Available options:
asc,
desc
cursor
string | null

Set the cursor to the next or previous page. You can get the cursor from the previous page's response.

Response

Successful Response

data
AiDraftReadSchema · object[]

The list of ResponseItems.

next_page_cursor
string | null

The cursor to the next page. If there are no more pages, this is None.

previous_page_cursor
string | null

The cursor to the previous page. If there are no previous pages, this is None.