Use this API to download all the attachments of an email message.
Path Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| email_id | string | optional | Pass the unique ID of an email. |
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| all_files | string | optional | Pass true to download all attachments of an email message in a ZIP file. |
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/b5b51b15-88ef-4683-a7fb-95c0318a6322/attachments/?all_files=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/b5b51b15-88ef-4683-a7fb-95c0318a6322/attachments/?all_files=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/b5b51b15-88ef-4683-a7fb-95c0318a6322/attachments/"
params = {
"all_files": "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.
{
"result": "\"http://localhost:8000/feed_sources/email/inbox/b8945432-f1fd-4e05-9fbd-b1afe358f654/attachments/download/?token=cdb618ee-98f0-4a00-a844-8a4f3fab6967&all_files=True\""
}View-only example — running live API calls requires a role with snippet testing access.