Returns a list of email messages received from email feed sources.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| email_config | string | optional | Pass the ID of the email feed source to retrieve emails from a specific source. By default, emails from all email sources are retrieved. To retrieve the email source ID, use the GET Email Source List API under Administration > Integration management > Email Feed Sources. |
| is_read | string | optional | Pass true to retrieve read emails only. By default, both read and unread emails are retrieved. |
| is_starred | string | optional | Pass true to retrieve starred emails only. By default, both starred and non-starred emails are retrieved. |
| is_regulatory_email | string | optional | Pass true to retrieve regulatory emails only. By default, both regulatory and non-regulatory emails are retrieved. |
| is_delete | string | optional | Pass true to retrieve trashed emails only. By default, trashed emails are not returned. |
| q | string | optional | Pass the query text to search in the subject and body of emails. |
| page_size | string | optional | Pass the number of emails to retrieve on each page. |
| page | string | optional | Pass the page number to retrieve emails. |
| has_attachments | string | optional | Pass true to retrieve emails with attachments. |
| is_reviewed | string | optional | Pass true to retrieve reviewed emails only. By default, both reviewed and unreviewed emails are retrieved. |
Run it
Use the Request parameters panel to enter path IDs, query values, JSON body, and credentials. Then run any snippet below — all languages use the same values. Base URL: https://cs-testv2.cyware.com/ctixapi (change in API Settings).
Playground
Request parameters
Edit values here before running any snippet below (cURL, JavaScript, or Python). Code blocks are reference only — your inputs above are what gets sent.
Open API (HMAC signature) · Get credentials from Cyware Admin → Open API → Generate Credentials.
Signature and Expires are generated when you run a request. Access ID and Secret Key stay in memory for this tab only.
Credentials from Authentication auto-fill here for this product. If fields are empty after connecting, refresh this page or open the product docs again.
curl --request GET \
--url "https://cs-testv2.cyware.com/ctixapi/conversion/feed-sources/email/inbox/?email_config=8d8e31e0-aae7-42fa-9f92-ec85e5970d2d&is_read=false&is_starred=true&is_regulatory_email=true&is_delete=true&q=alert&page_size=400&page=10&has_attachments=true&is_reviewed=true&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E"View-only example — running live API calls requires a role with snippet testing access.
const url = "https://cs-testv2.cyware.com/ctixapi/conversion/feed-sources/email/inbox/?email_config=8d8e31e0-aae7-42fa-9f92-ec85e5970d2d&is_read=false&is_starred=true&is_regulatory_email=true&is_delete=true&q=alert&page_size=400&page=10&has_attachments=true&is_reviewed=true&AccessID=%3Cyour%20access%20id%3E&Signature=%3Cyour%20signature%3E&Expires=%3Cyour%20expires%3E";
const response = await fetch(url, {
method: "GET",
});
const text = await response.text();
let data;
try { data = JSON.parse(text); } catch { data = text; }
console.log(response.status, data);View-only example — running live API calls requires a role with snippet testing access.
import requests
url = "https://cs-testv2.cyware.com/ctixapi/conversion/feed-sources/email/inbox/"
params = {
"email_config": "8d8e31e0-aae7-42fa-9f92-ec85e5970d2d",
"is_read": "false",
"is_starred": "true",
"is_regulatory_email": "true",
"is_delete": "true",
"q": "alert",
"page_size": "400",
"page": "10",
"has_attachments": "true",
"is_reviewed": "true",
"AccessID": "<your access id>",
"Signature": "<your signature>",
"Expires": "<your expires>"
}
headers = {}
response = requests.request("GET", url, params=params, headers=headers)
print(response.status_code)
print(response.text)View-only example — running live API calls requires a role with snippet testing access.
{
"next": {},
"previous": {},
"page_size": 10,
"total": 1,
"results": [
{}
],
"unread_email_count": 1
}View-only example — running live API calls requires a role with snippet testing access.