AGagentmail-to
pods > inboxes

Search Inboxes

Changed on

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.

get/v0/pods/{pod_id}/inboxes/search

Request

  • Base URL
    https://api.agentmail.to
  • URL
    https://api.agentmail.to/v0/pods/{pod_id}/inboxes/search
  • Auth
    HTTP bearer

Path parameters

pod_idstring required

ID of pod.

Query parameters

qstring required

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

limitinteger

Limit of number of items returned.

page_tokenstring

Page token for pagination.

Response

Response with status 200

countinteger required

Number of items returned.

limitinteger

Limit of number of items returned.

next_page_tokenstring

Page token for pagination.

Changes