castomAPI
Get your key
POST /v1/google/gmail/messages/list 1 token API key Google Workspace

Search and list emails from Gmail matching custom queries (is:unread

Search and list emails from Gmail matching custom queries (is:unread, from:boss, has:attachment)

POST

Request

  • x-api-key: <your-api-key>
  • Content-Type: application/json

Response 

{
  "messages": [
    {
      "id": "usr_824801",
      "threadId": "thr_209183"
    }
  ],
  "nextPageToken": "<token>",
  "resultSizeEstimate": 22,
  "status": "success",
  "tokensDeducted": 1
}
The response below is a mock built from the endpoint's own schema — no request leaves this page. Edit the body, press Send, read the shape you will get back. Run it for real in the dashboard →

What it does

Search and list emails from Gmail matching custom queries (is:unread, from:boss, has:attachment)

Request

Body

FieldTypeRequiredDescription
accessTokenstringyes
includeSpamTrashbooleanno
labelIdsarray<string>no
maxResultsintegerno
pageTokenstringno
qstringnoGmail search query syntax

Example request

{
  "accessToken": "<token>",
  "includeSpamTrash": false,
  "labelIds": [
    "lab_274347"
  ],
  "maxResults": 50,
  "pageToken": "<token>",
  "q": "castomapi"
}

Response

FieldTypeDescription
messagesarray<object>
  ↳ idstring
  ↳ threadIdstring
nextPageTokenstring
resultSizeEstimateinteger
statusstring
tokensDeductedinteger

Example response

{
  "messages": [
    {
      "id": "usr_824801",
      "threadId": "thr_209183"
    }
  ],
  "nextPageToken": "<token>",
  "resultSizeEstimate": 22,
  "status": "success",
  "tokensDeducted": 1
}

Errors

Every error answers with the same envelope: an HTTP status, a machine code and a sentence.

400The body or a parameter failed validation. The details array names the field.
401No key, a revoked key or a wrong header. Send x-api-key.
402The wallet cannot cover this call. Top up or wait for the monthly grant.
404The resource does not exist, or it is not yours. Both answer identically and cost nothing.
429Over the per-minute quota of your tier. Back off and retry.
5xxUpstream refused or timed out. The call is not billed.

Code

curl -X POST 'https://app.castomapi.com/v1/google/gmail/messages/list' \
  -H 'x-api-key: <your-api-key>' \
  -H 'Content-Type: application/json' \
  -d '{"accessToken": "<token>", "includeSpamTrash": false, "labelIds": ["lab_274347"], "maxResults": 50, "pageToken": "<token>", "q": "castomapi"}'
const res = await fetch('https://app.castomapi.com/v1/google/gmail/messages/list', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accessToken": "<token>", "includeSpamTrash": false, "labelIds": ["lab_274347"], "maxResults": 50, "pageToken": "<token>", "q": "castomapi"})
});
const data = await res.json();
console.log(data);
import { request } from 'node:https';

// Node 18+ has fetch built in
const res = await fetch('https://app.castomapi.com/v1/google/gmail/messages/list', {
  method: 'POST',
  headers: { 'x-api-key': '<your-api-key>', 'Content-Type': 'application/json' },
  body: JSON.stringify({"accessToken": "<token>", "includeSpamTrash": false, "labelIds": ["lab_274347"], "maxResults": 50, "pageToken": "<token>", "q": "castomapi"})
});
const data = await res.json();
console.log(data);
import requests

res = requests.post(
    'https://app.castomapi.com/v1/google/gmail/messages/list',
    headers={'x-api-key': '<your-api-key>'},
    json={"accessToken": "<token>", "includeSpamTrash": False, "labelIds": ["lab_274347"], "maxResults": 50, "pageToken": "<token>", "q": "castomapi"},
    timeout=30,
)
print(res.json())
<?php
$ch = curl_init('https://app.castomapi.com/v1/google/gmail/messages/list');
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['x-api-key: <your-api-key>', 'Content-Type: application/json'],
    CURLOPT_POSTFIELDS => json_encode(['accessToken' => '<token>', 'includeSpamTrash' => false, 'labelIds' => ['lab_274347'], 'maxResults' => 50, 'pageToken' => '<token>', 'q' => 'castomapi']),
]);
$data = json_decode(curl_exec($ch), true);
print_r($data);

Cost and limits

This operation costs 1 token. A call that fails is never billed. Every account gets 1000 free tokens a month; paid balances never expire.

Rate limits per minute

No key10
Free60
Pro300
Enterprise1200

Docs → Pricing

Questions

What does Search and list emails from Gmail matching custom queries (is:unread cost?

1 token per successful call, debited from your wallet after the response. Failed calls are free. Every account receives 1000 free tokens a month.

How do I authenticate?

Send your key in the x-api-key header. One key covers every metered endpoint; there is nothing to enable per endpoint.

Can I send an Authorization: Bearer token instead?

Not for a metered endpoint — those take the x-api-key header and nothing else. Bearer tokens belong to the account side: the dashboard and account APIs accept a JWT session, and castomapi-auth issues those through a standard OAuth2 handshake, with authorization code, client credentials and refresh grants. The auth service page covers it.

What are the limits?

10 requests a minute per IP with no key at all, 60 a minute on the free tier, 300 on Pro, 1200 on Enterprise. Above the no-key tier the quota is per account, across every endpoint.

OpenAPI: https://app.castomapi.com/docs/json