Gmail Search
Searches the connected Gmail mailbox with Gmail search syntax and returns sender, subject, date and snippet per message.
- Price per call
- 1 credit
- per successful call
- Price ceiling
- 1 credit
- every call, same price
- Failed calls
- Free
- retried automatically
- Billed
- Per call
- only on success
Endpoint
api.primaryapi.com/ v1/ run/ gmail. searchAuth: API key with run or full access, or a dashboard session
Send the input below as a JSON body. The call is routed to a healthy upstream; if an attempt fails, it is retried automatically inside the same request and you pay only for the answer you get. To check an input and see the exact price without running anything, call POST /v1/quote/gmail.search with the same body (free).
Example request
curl -sS -X POST "https://api.primaryapi.com/v1/run/gmail.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"subject:report newer_than:30d","limit":2}'const res = await fetch('https://api.primaryapi.com/v1/run/gmail.search', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.PRIMARYAPI_API_KEY}`,
'Content-Type': 'application/json',
},
body: JSON.stringify({
query: 'subject:report newer_than:30d',
limit: 2,
}),
});
const body = await res.json();
if (!res.ok) throw new Error(`${body.code}: ${body.error}`);
// found:false is a successful answer ("does not exist"), not an error
console.log(body.output.found ? body.output.data : body.output.reason, body.credits);import os
import requests
res = requests.post(
"https://api.primaryapi.com/v1/run/gmail.search",
headers={"Authorization": f"Bearer {os.environ['PRIMARYAPI_API_KEY']}"},
json={
"query": "subject:report newer_than:30d",
"limit": 2,
},
timeout=60,
)
body = res.json()
if not res.ok:
raise RuntimeError(f"{body['code']}: {body['error']}")
# found=False is a successful answer ("does not exist"), not an error
print(body["output"]["data"] if body["output"]["found"] else body["output"]["reason"], body["credits"]){
"name": "run_api",
"arguments": {
"sku": "gmail.search",
"input": {
"query": "subject:report newer_than:30d",
"limit": 2
}
}
}Price this exact input first (free)
curl -sS -X POST "https://api.primaryapi.com/v1/quote/gmail.search" \
-H "Authorization: Bearer $PRIMARYAPI_API_KEY" \
-H "Content-Type: application/json" \
-d '{"query":"subject:report newer_than:30d","limit":2}'Returns credits (what the call is expected to cost) and maxCredits (the most it can cost, which is set aside while it runs). Invalid input fails here the same way it would on run.
Input
JSON body fields. Unknown fields are rejected with 400 invalid_input (never silently ignored). You may add the routing controls preferLatencyUnderMs and maxCredits to the same object.
querystringrequired- Gmail search query, the same syntax as the Gmail search box, for example "from:[email protected] newer_than:7d".max 500 chars
labelIdsstring[]- Only messages that carry ALL of these label ids, for example ["INBOX", "UNREAD"].max 10 items · items max 100 chars
includeSpamTrashbooleandefaultfalse- Also search Spam and Trash (default false).
limitintegerdefault10- Maximum number of results to return (1-25, default 10).1–25
cursorstring- Opaque pagination cursor: pass the previous response's nextCursor.
connectionstring- Which connected account to use when the workspace has several for this provider: the customId you gave it (exact), its connection id ("con_…"), its handle (login, email or @handle) or its name. Optional; prefer the customId or id, which never match two accounts.max 200 chars
Output
When output.found is true, output.data has these fields (a list under messages, billed per item returned).
messagesobject[]messages[].idstring- Message id (read it with gmail.message)
messages[].threadIdstring | nullmessages[].fromstring | nullmessages[].tostring | nullmessages[].subjectstring | nullmessages[].datestring | null- The Date header as sent
messages[].receivedAtstring | null- When Gmail received it (ISO-8601)
messages[].snippetstring | null- Short part of the message text
messages[].labelIdsstring[]messages[].sizeEstimateinteger | null- Bytes
resultSizeEstimateinteger | null- Gmail’s estimate of all matching messages
nextCursorstring | null
TypeScript type
/** output.data when output.found is true */
type GmailSearch = {
messages: {
/** Message id (read it with gmail.message) */
id: string;
threadId: string | null;
from: string | null;
to: string | null;
subject: string | null;
/** The Date header as sent */
date: string | null;
/** When Gmail received it (ISO-8601) */
receivedAt: string | null;
/** Short part of the message text */
snippet: string | null;
labelIds: string[];
/** Bytes */
sizeEstimate: number | null;
}[];
/** Gmail’s estimate of all matching messages */
resultSizeEstimate: number | null;
nextCursor: string | null;
};If what you asked about does not exist, is private, or a search matches nothing, the call still succeeds: output.found is false, output.data is null and output.reason says why. Such misses are free unless the notes below say misses are billed, in which case a miss costs the price of one call.
Pagination. Pass the previous response’s nextCursor as cursor to get the next page. nextCursor: null means there is nothing more. See Pagination.
Example response
Values are placeholders that follow the output schema (strings as "string", numbers as 0); credits shows what this call would cost at the usual price.
{
"output": {
"found": true,
"data": {
"messages": [
{
"id": "18c3a1f0e2b4d5f6",
"threadId": "18c3a1f0e2b4d5f6",
"from": "Alice Example <[email protected]>",
"to": "[email protected]",
"subject": "October report",
"date": "Mon, 02 Nov 2026 09:00:00 +0000",
"receivedAt": "2026-11-02T09:00:00.000Z",
"snippet": "Here are the numbers for October.",
"labelIds": [
"INBOX",
"UNREAD"
],
"sizeEstimate": 5120
}
],
"resultSizeEstimate": 2,
"nextCursor": "eyJ0IjoiMDg3NjU0MzIxMDk4NzY1NDMyMTAifQ"
}
},
"provider": "PrimaryAPI",
"credits": 1,
"items": 1,
"requestId": "req_01JBXK6Y2N9V8T4R3Q2P1M0A7Z",
"nextCursor": null
}Pricing and reliability
Calls go only to upstreams that are healthy right now. If an attempt fails, the call is retried automatically inside the same request; a failed attempt costs nothing, and a call never costs more than its quote’s maxCredits. Live figures below are measured on real traffic.
Success rate, uptime, latency and call counts are measured live from real traffic over 30 days and show “—” until there is data.
Errors
Errors are JSON { code, error, requestId } and are never charged. The ones to handle for this endpoint:
- invalid_inputThe request failed validation before anything ran.
- unauthorizedNo valid API key or session was presented.
- insufficient_balanceThe balance cannot cover the most this call could cost.
- key_limit_reachedThe key’s own spend limit is used up for the current window.
- trial_cap_reachedAn agent trial key has used its whole trial budget.
- forbiddenThe credential is valid but may not do this.
- not_foundThe thing addressed by the URL does not exist for you.
- idempotency_conflictThe
Idempotency-Keyis already bound to a different request. - rate_limitedToo many requests in the current window.
- all_sources_failedThe call could not be answered, even after automatic retries.
- service_unavailableThis API cannot run in this deployment right now.
- timeoutThe request passed its deadline before it finished.
Notes
Runs as your connected Google account (read-only Gmail access). Message bodies are not included: read one with gmail.message. Run the call again to refresh them.
More Gmail endpoints
Generated from the PrimaryAPI catalog. Machine-readable contract: GET https://api.primaryapi.com/v1/apis/gmail.search.