List Threads

GET

/v0/inboxes/:inbox_id/threads

GET

/v0/inboxes/:inbox_id/threads

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

Try it

200Retrieved

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

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.

threadslist of objects

Thread items. Ordered by timestamp descending.