Search Inboxes

GET

/v0/pods/:pod_id/inboxes/search

GET

/v0/pods/:pod_id/inboxes/search

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

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 }

Searches inboxes in the pod by address or display name, ranked by relevance. Each word in the query matches the start of a word in the address or display name, so sup matches support@example.com but port does not. An exact address match always ranks first. limit cannot exceed 100. A page can be empty and still carry a next_page_token; keep paging until the token is absent.

Searches inboxes in the pod by address or display name, ranked by relevance. Each word in the query matches the start of a word in the address or display name, so `sup` matches `support@example.com` but `port` does not. An exact address match always ranks first. `limit` cannot exceed 100. A page can be empty and still carry a `next_page_token`; keep paging until the token is absent.

Authentication

AuthorizationBearer

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

Path parameters

pod_idstringRequired

ID of pod.

Query parameters

qstringRequired

Address or display name to search for. Matches word prefixes. Must be 2 to 256 characters.

limitintegerOptional

Limit of number of items returned.

page_tokenstringOptional

Page token for pagination.

Response

This endpoint returns an object.

countinteger

Number of items returned.

inboxeslist of objects

Ordered by relevance, best match first.

limitintegerOptional

Limit of number of items returned.

next_page_tokenstringOptional

Page token for pagination.

Errors

400

Validation Error

404

Not Found Error