List Messages

GET

/v0/inboxes/:inbox_id/messages

GET

/v0/inboxes/:inbox_id/messages

1 from agentmail import AgentMail
2 client = AgentMail(api_key="YOUR_API_KEY", )
3 client.inboxes.messages.list(inbox_id='inbox_id', )

Try it

200Retrieved

1 {
2   "count": 1,
3   "messages": [
4     {
5       "inbox_id": "inbox_id",
6       "thread_id": "thread_id",
7       "message_id": "message_id",
8       "labels": [
9         "labels",
10         "labels"
11       ],
12       "timestamp": "2024-01-15T09:30:00Z",
13       "from": "from",
14       "to": [
15         "to",
16         "to"
17       ],
18       "cc": [
19         "cc",
20         "cc"
21       ],
22       "bcc": [
23         "bcc",
24         "bcc"
25       ],
26       "subject": "subject",
27       "preview": "preview",
28       "attachments": [
29         {
30           "attachment_id": "attachment_id",
31           "size": 1,
32           "inline": true,
33           "filename": "filename",
34           "content_type": "content_type"
35         },
36         {
37           "attachment_id": "attachment_id",
38           "size": 1,
39           "inline": true,
40           "filename": "filename",
41           "content_type": "content_type"
42         }
43       ]
44     },
45     {
46       "inbox_id": "inbox_id",
47       "thread_id": "thread_id",
48       "message_id": "message_id",
49       "labels": [
50         "labels",
51         "labels"
52       ],
53       "timestamp": "2024-01-15T09:30:00Z",
54       "from": "from",
55       "to": [
56         "to",
57         "to"
58       ],
59       "cc": [
60         "cc",
61         "cc"
62       ],
63       "bcc": [
64         "bcc",
65         "bcc"
66       ],
67       "subject": "subject",
68       "preview": "preview",
69       "attachments": [
70         {
71           "attachment_id": "attachment_id",
72           "size": 1,
73           "inline": true,
74           "filename": "filename",
75           "content_type": "content_type"
76         },
77         {
78           "attachment_id": "attachment_id",
79           "size": 1,
80           "inline": true,
81           "filename": "filename",
82           "content_type": "content_type"
83         }
84       ]
85     }
86   ],
87   "limit": 1,
88   "next_page_token": "next_page_token"
89 }

Path parameters

inbox_idstringRequired

ID of inbox.

Headers

AuthorizationstringRequired

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

Query parameters

limitintegerOptional

Limit of number of items returned.

page_tokenstringOptional

Page token for pagination.

labelslist of stringsOptional

Labels to filter by.

ascendingbooleanOptional

Whether to sort in ascending temporal order.

Response

This endpoint returns an object.

countinteger

Number of items returned.

messageslist of objects

Ordered by timestamp descending.

limitinteger or null