Skip to main content
POST
email.filter.entries.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
direction
enum<string>

Which traffic the entry governs: "send" (your inboxes mailing out), "receive" (mail coming in) or "reply". Leave out to read all three.

Available options:
send,
receive,
reply
type
enum<string>

"allow" entries permit the traffic, "block" entries refuse it. Leave out to read both.

Available options:
allow,
block
inbox
string

Read one inbox's own lists instead of the workspace-wide ones.

Required string length: 1 - 320
limit
number

How many to return, 1 to 50. Default 10.

Required range: x >= 1
cursor
string

The nextCursor from a previous call.

Maximum string length: 64

Response

The result

results
object[]
required

Entries, ordered by address or domain.

nextCursor
string

Pass as cursor to read the next page. Left out when this page is the last.