Get List Entry | AgentMail

CLI:

$ agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry>

**CLI:** ```bash agentmail inboxes:lists retrieve --inbox-id <inbox_id> --direction <direction> --type <type> --entry <entry> ```

AuthorizationBearer

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

inbox_idstringRequired

The ID of the inbox.

directionenumRequired

Direction of list entry.

Allowed values:

typeenumRequired

Type of list entry.

Allowed values:

entrystringRequired

Email address or domain.

This endpoint returns an object.

created_atdatetime

Time at which entry was created.

directionenum

Direction of list entry.

Allowed values:

entrystring

Email address or domain of list entry.

entry_typeenum

Whether the entry is an email address or domain.

Allowed values:

list_typeenum

Type of list entry.

Allowed values:

organization_idstring

ID of organization.

pod_idstring

ID of pod.

inbox_idstring

ID of inbox, if entry is inbox-scoped.

reasonstring

Reason for adding the entry.

404

Not Found Error

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.inboxes.lists.get(
8	inbox_id="inbox_id",
9	direction="send",
10	type="allow",
11	entry="entry",
12	)

1	{
2	"created_at": "2024-01-15T09:30:00Z",
3	"direction": "send",
4	"entry": "entry",
5	"entry_type": "email",
6	"list_type": "allow",
7	"organization_id": "organization_id",
8	"pod_id": "pod_id",
9	"inbox_id": "inbox_id",
10	"reason": "reason"
11	}