For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
contact@agentmail.ccDiscord
DocumentationAPI ReferenceKnowledge BaseChangelog
DocumentationAPI ReferenceKnowledge BaseChangelog
  • API Reference
      • GETList Inboxes
      • GETGet Inbox
      • POSTCreate Inbox
      • PATCHUpdate Inbox
      • DELDelete Inbox
        • GETList Messages
        • GETSearch Messages
        • GETGet Message
        • POSTBatch Get Messages
        • GETGet Attachment
        • GETGet Raw Message
        • PATCHUpdate Message
        • DELDelete Message
        • POSTSend Message
        • POSTReply To Message
        • POSTReply All Message
        • POSTForward Message
LogoLogo
contact@agentmail.ccDiscord
API ReferenceInboxesMessages

Search Messages

GET
/v0/inboxes/:inbox_id/messages/search
GET
/v0/inboxes/:inbox_id/messages/search
1from agentmail import AgentMail
2
3client = AgentMail(
4    api_key="YOUR_TOKEN_HERE",
5)
6
7client.inboxes.messages.search(
8    inbox_id="inbox_id",
9    q="q",
10)
1{
2  "count": 1,
3  "messages": [
4    {
5      "created_at": "2024-01-15T09:30:00Z",
6      "from": "from",
7      "inbox_id": "inbox_id",
8      "labels": [
9        "labels",
10        "labels"
11      ],
12      "message_id": "message_id",
13      "size": 1,
14      "thread_id": "thread_id",
15      "timestamp": "2024-01-15T09:30:00Z",
16      "to": [
17        "to",
18        "to"
19      ],
20      "updated_at": "2024-01-15T09:30:00Z",
21      "attachments": [
22        {
23          "attachment_id": "attachment_id",
24          "size": 1,
25          "filename": "filename",
26          "content_type": "content_type",
27          "content_disposition": "inline",
28          "content_id": "content_id"
29        },
30        {
31          "attachment_id": "attachment_id",
32          "size": 1,
33          "filename": "filename",
34          "content_type": "content_type",
35          "content_disposition": "inline",
36          "content_id": "content_id"
37        }
38      ],
39      "bcc": [
40        "bcc",
41        "bcc"
42      ],
43      "cc": [
44        "cc",
45        "cc"
46      ],
47      "headers": {
48        "headers": "headers"
49      },
50      "highlights": {
51        "from": [
52          "from",
53          "from"
54        ],
55        "recipients": [
56          "recipients",
57          "recipients"
58        ],
59        "subject": [
60          "subject",
61          "subject"
62        ],
63        "text": [
64          "text",
65          "text"
66        ]
67      },
68      "in_reply_to": "in_reply_to",
69      "preview": "preview",
70      "references": [
71        "references",
72        "references"
73      ],
74      "subject": "subject"
75    },
76    {
77      "created_at": "2024-01-15T09:30:00Z",
78      "from": "from",
79      "inbox_id": "inbox_id",
80      "labels": [
81        "labels",
82        "labels"
83      ],
84      "message_id": "message_id",
85      "size": 1,
86      "thread_id": "thread_id",
87      "timestamp": "2024-01-15T09:30:00Z",
88      "to": [
89        "to",
90        "to"
91      ],
92      "updated_at": "2024-01-15T09:30:00Z",
93      "attachments": [
94        {
95          "attachment_id": "attachment_id",
96          "size": 1,
97          "filename": "filename",
98          "content_type": "content_type",
99          "content_disposition": "inline",
100          "content_id": "content_id"
101        },
102        {
103          "attachment_id": "attachment_id",
104          "size": 1,
105          "filename": "filename",
106          "content_type": "content_type",
107          "content_disposition": "inline",
108          "content_id": "content_id"
109        }
110      ],
111      "bcc": [
112        "bcc",
113        "bcc"
114      ],
115      "cc": [
116        "cc",
117        "cc"
118      ],
119      "headers": {
120        "headers": "headers"
121      },
122      "highlights": {
123        "from": [
124          "from",
125          "from"
126        ],
127        "recipients": [
128          "recipients",
129          "recipients"
130        ],
131        "subject": [
132          "subject",
133          "subject"
134        ],
135        "text": [
136          "text",
137          "text"
138        ]
139      },
140      "in_reply_to": "in_reply_to",
141      "preview": "preview",
142      "references": [
143        "references",
144        "references"
145      ],
146      "subject": "subject"
147    }
148  ],
149  "limit": 1,
150  "next_page_token": "next_page_token"
151}

Full-text search across messages in the inbox, ranked by relevance. The query is matched against the sender, recipients, and subject (substring) and the message body (tokenized full text). Spam, trash, blocked, and unauthenticated messages are always excluded. limit cannot exceed 100.

Was this page helpful?
Previous

Get Message

Next
Built with

Authentication

AuthorizationBearer

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

Path parameters

inbox_idstringRequired
The ID of the inbox.

Query parameters

qstringRequired

Full-text search query. Matched against the sender, recipients, and subject (substring) and the message body (tokenized full text).

limitintegerOptional
Limit of number of items returned.
page_tokenstringOptional
Page token for pagination.
beforedatetimeOptional
Timestamp before which to filter by.
afterdatetimeOptional
Timestamp after which to filter by.

Response

This endpoint returns an object.
countinteger
Number of items returned.
messageslist of objects
Ordered by relevance, best match first.
limitinteger
Limit of number of items returned.
next_page_tokenstring
Page token for pagination.

Errors

400
Validation Error
404
Not Found Error