Skip to main content
GET
Get Inbox List Entry
Fetches one allow or block entry on an inbox: entry, entry_type, reason, direction, list_type, created_at, read_only, inbox_id, pod_id and organization_id. read_only marks entries the platform manages, which cannot be deleted. List them all with get_agentmail_inbox_list_entries.

Example

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer authentication

Path Parameters

inbox_id
string
required

The ID of the inbox.

direction
enum<string>
required

Direction of list entry.

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

Type of list entry.

Available options:
allow,
block
entry
string
required

Email address or domain.

Response

Response with status 200

entry
string
required

Email address or domain of list entry.

organization_id
string
required

ID of organization.

direction
enum<string>
required

Direction of list entry.

Available options:
send,
receive,
reply
list_type
enum<string>
required

Type of list entry.

Available options:
allow,
block
entry_type
enum<string>
required

Whether the entry is an email address or domain.

Available options:
email,
domain
created_at
string<date-time>
required

Time at which entry was created.

pod_id
string
required

ID of pod.

reason
string

Reason for adding the entry.

read_only
boolean

Whether the entry is read-only and cannot be deleted via the API.

inbox_id
string

ID of inbox, if entry is inbox-scoped.