Documentation Index
Fetch the complete documentation index at: /docs/llms.txt
Use this file to discover all available pages before exploring further.
Full-text search across messages in a mailbox or across your entire organization
GET /mailboxes/{email_address}/search
q parameter accepts plain natural-language queries (e.g. order confirmation, invoice january).
| Parameter | Type | Description |
|---|---|---|
email_address | string | Email address of the mailbox to search |
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search query (1–500 chars) |
limit | integer | No | 50 | Maximum results to return (1–100) |
{
"items": [
{
"id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
"mailbox_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"thread_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
"message_id": "<20250301120000.abc123@inkboxmail.com>",
"from_address": "agent-sales@inkboxmail.com",
"to_addresses": ["customer@example.com"],
"cc_addresses": null,
"subject": "Your order is confirmed",
"snippet": "Hi! Your order #1234 has been confirmed and will ship within...",
"direction": "outbound",
"status": "sent",
"is_read": true,
"is_starred": false,
"has_attachments": false,
"created_at": "2025-03-01T12:00:00Z"
}
],
"next_cursor": null,
"has_more": false
}
curl -X GET "https://inkbox.ai/api/v1/mail/mailboxes/EMAIL_ADDRESS/search?q=order+confirmed&limit=10" \
-H "X-API-Key: YOUR_API_KEY"
const emailAddress = "agent-sales@inkboxmail.com";
const params = new URLSearchParams({ q: "order confirmed", limit: "10" });
const response = await fetch(
`https://inkbox.ai/api/v1/mail/mailboxes/${emailAddress}/search?${params}`,
{ headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const results = await response.json();
import requests
email_address = "agent-sales@inkboxmail.com"
response = requests.get(
f"https://inkbox.ai/api/v1/mail/mailboxes/{email_address}/search",
headers={"X-API-Key": "YOUR_API_KEY"},
params={"q": "order confirmed", "limit": 10},
)
results = response.json()
GET /search
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
q | string | Yes | — | Search query (1–500 chars) |
limit | integer | No | 50 | Maximum results to return (1–100) |
curl -X GET "https://inkbox.ai/api/v1/mail/search?q=order+confirmed&limit=10" \
-H "X-API-Key: YOUR_API_KEY"
const params = new URLSearchParams({ q: "order confirmed", limit: "10" });
const response = await fetch(
`https://inkbox.ai/api/v1/mail/search?${params}`,
{ headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const results = await response.json();
import requests
response = requests.get(
"https://inkbox.ai/api/v1/mail/search",
headers={"X-API-Key": "YOUR_API_KEY"},
params={"q": "order confirmed", "limit": 10},
)
results = response.json()
Was this page helpful?