List Inboxes | AgentMail

from agentmail import AgentMail
client = AgentMail(
    api_key="YOUR_TOKEN_HERE",
)
client.pods.inboxes.list(
    pod_id="pod_id",
)

{
  "count": 1,
  "inboxes": [
    {
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "email": "email",
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "display_name": "display_name",
      "client_id": "client_id",
      "metadata": {
        "metadata": "metadata"
      }
    },
    {
      "pod_id": "pod_id",
      "inbox_id": "inbox_id",
      "email": "email",
      "updated_at": "2024-01-15T09:30:00Z",
      "created_at": "2024-01-15T09:30:00Z",
      "display_name": "display_name",
      "client_id": "client_id",
      "metadata": {
        "metadata": "metadata"
      }
    }
  ],
  "limit": 1,
  "next_page_token": "next_page_token"
}

CLI:

$ agentmail pods:inboxes list --pod-id <pod_id>

**CLI:** ```bash agentmail pods:inboxes list --pod-id <pod_id> ```

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired

ID of pod.

Query parameters

limitintegerOptional

Limit of number of items returned.

page_tokenstringOptional

Page token for pagination.

ascendingbooleanOptional

Sort in ascending temporal order.

Response

This endpoint returns an object.

countinteger

Number of items returned.

inboxeslist of objects

Ordered by created_at descending.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Errors

404

Not Found Error

1	from agentmail import AgentMail
2
3	client = AgentMail(
4	api_key="YOUR_TOKEN_HERE",
5	)
6
7	client.pods.inboxes.list(
8	pod_id="pod_id",
9	)

1	{
2	"count": 1,
3	"inboxes": [
4	{
5	"pod_id": "pod_id",
6	"inbox_id": "inbox_id",
7	"email": "email",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"created_at": "2024-01-15T09:30:00Z",
10	"display_name": "display_name",
11	"client_id": "client_id",
12	"metadata": {
13	"metadata": "metadata"
14	}
15	},
16	{
17	"pod_id": "pod_id",
18	"inbox_id": "inbox_id",
19	"email": "email",
20	"updated_at": "2024-01-15T09:30:00Z",
21	"created_at": "2024-01-15T09:30:00Z",
22	"display_name": "display_name",
23	"client_id": "client_id",
24	"metadata": {
25	"metadata": "metadata"
26	}
27	}
28	],
29	"limit": 1,
30	"next_page_token": "next_page_token"
31	}