Skip to main content
POST
email.drafts.list

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
inbox
string

One owned inbox; omit for your whole workspace.

Required string length: 1 - 320
labels
string[]

Required labels.

Maximum array length: 20

A label, up to 64 characters, e.g. awaiting-reply.

Required string length: 1 - 64
before
string<date-time>

UTC instant ending in Z.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
after
string<date-time>

UTC instant ending in Z.

Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
ascending
boolean

Oldest changes first.

limit
number

Page size, 1 to 50; default 10.

Required range: x >= 1
cursor
string

Opaque nextCursor from the previous page.

Required string length: 1 - 4096

Response

The result

results
object[]
required

Draft summaries; bodies are read with email.draft.get.

nextCursor
string

Opaque nextCursor from the previous page.

Required string length: 1 - 4096