Search Inbox Messages

Search AgentMail messages in a specific inbox using a full-text query.

GET https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search

Search Messages

cURL

curl --request GET \
  --url https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.aisa.one/apis/v1/agentmail/inboxes/{inbox_id}/messages/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "count": 123,
  "messages": [
    {
      "inbox_id": "<string>",
      "thread_id": "<string>",
      "message_id": "<string>",
      "labels": [
        "<string>"
      ],
      "timestamp": "2023-11-07T05:31:56Z",
      "from": "<string>",
      "to": [
        "<string>"
      ],
      "size": 123,
      "updated_at": "2023-11-07T05:31:56Z",
      "created_at": "2023-11-07T05:31:56Z",
      "cc": [
        "<string>"
      ],
      "bcc": [
        "<string>"
      ],
      "subject": "<string>",
      "preview": "<string>",
      "attachments": [
        {
          "attachment_id": "<string>",
          "size": 123,
          "filename": "<string>",
          "content_type": "<string>",
          "content_id": "<string>"
        }
      ],
      "in_reply_to": "<string>",
      "references": [
        "<string>"
      ],
      "headers": {},
      "highlights": {
        "from": [
          "<string>"
        ],
        "recipients": [
          "<string>"
        ],
        "subject": [
          "<string>"
        ],
        "text": [
          "<string>"
        ]
      }
    }
  ],
  "limit": 123,
  "next_page_token": "<string>"
}

{
  "name": "<string>",
  "errors": "<unknown>"
}

{
  "name": "<string>",
  "message": "<string>"
}

Authorizations

Authorization · string · header · required

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

Headers

Authorization · string · required

Bearer authentication

Path Parameters

inbox_id · string · required

The ID of the inbox.

Query Parameters

q · string · required

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

limit · integer

Limit of number of items returned.

page_token · string

Page token for pagination.

before · string<date-time>

Timestamp before which to filter by.

after · string<date-time>

Timestamp after which to filter by.

Response

200

application/json

Response with status 200

count · integer · required

Number of items returned.

messages · SearchMessageItem · object[] · required

Ordered by relevance, best match first.

Show child attributes

limit · integer

Limit of number of items returned.

next_page_token · string

Page token for pagination.