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       "event_id": "event_id",
9       "labels": [
10         "labels",
11         "labels"
12       ],
13       "timestamp": "2024-01-15T09:30:00Z",
14       "from": "from",
15       "to": [
16         "to",
17         "to"
18       ],
19       "cc": [
20         "cc",
21         "cc"
22       ],
23       "bcc": [
24         "bcc",
25         "bcc"
26       ],
27       "subject": "subject",
28       "preview": "preview",
29       "attachments": [
30         {
31           "attachment_id": "attachment_id",
32           "filename": "filename",
33           "content_type": "content_type",
34           "size": 1,
35           "inline": true
36         },
37         {
38           "attachment_id": "attachment_id",
39           "filename": "filename",
40           "content_type": "content_type",
41           "size": 1,
42           "inline": true
43         }
44       ],
45       "in_reply_to": "in_reply_to",
46       "references": [
47         "references",
48         "references"
49       ]
50     },
51     {
52       "inbox_id": "inbox_id",
53       "thread_id": "thread_id",
54       "message_id": "message_id",
55       "event_id": "event_id",
56       "labels": [
57         "labels",
58         "labels"
59       ],
60       "timestamp": "2024-01-15T09:30:00Z",
61       "from": "from",
62       "to": [
63         "to",
64         "to"
65       ],
66       "cc": [
67         "cc",
68         "cc"
69       ],
70       "bcc": [
71         "bcc",
72         "bcc"
73       ],
74       "subject": "subject",
75       "preview": "preview",
76       "attachments": [
77         {
78           "attachment_id": "attachment_id",
79           "filename": "filename",
80           "content_type": "content_type",
81           "size": 1,
82           "inline": true
83         },
84         {
85           "attachment_id": "attachment_id",
86           "filename": "filename",
87           "content_type": "content_type",
88           "size": 1,
89           "inline": true
90         }
91       ],
92       "in_reply_to": "in_reply_to",
93       "references": [
94         "references",
95         "references"
96       ]
97     }
98   ],
99   "limit": 1,
100   "last_key": "last_key"
101 }

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.

last_keystringOptional

Key of last item.

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

Message items. Ordered by timestamp descending.