Retrieve Workflow emails when you need delivery, engagement, recipient, or template data outside Odie. You can retrieve sent email records across Workflows and list the email templates for a specific Workflow.
Use the Workflow email endpoints
| Task | Endpoint |
|---|---|
| List Workflow emails | GET /v1/workflow-emails |
| Retrieve one Workflow email | GET /v1/workflow-emails/{email_id} |
| List a Workflow's email templates | GET /v1/workflows/{workflow_id}/email-templates |
List Workflow emails
curl "https://public-api.us.unison.totango.com/v1/workflow-emails?page[limit]=20" \ --header "Authorization: Bearer <public_api_credential>"
The default page size is 20 emails and the maximum is 50.
Retrieve one Workflow email
curl "https://public-api.us.unison.totango.com/v1/workflow-emails/<email_id>" \ --header "Authorization: Bearer <public_api_credential>"
Understand Workflow email fields
| Field | Description |
|---|---|
id |
The email ID. |
workflow_id |
The related Workflow ID. |
template_id |
The related email template ID. |
subject |
The email subject. |
automated |
Whether the email was sent automatically. |
status |
The email status. |
sent_at, approved_at, rejected_at, updated_at
|
Lifecycle timestamps for the email. |
sender |
The sender ID, display name, and address. |
recipients |
Recipient addresses and engagement timestamps. |
performance |
Delivery, open, click, reply, and unsubscribe ratios. |
Interpret recipients
Each recipient has a type of to, cc, bcc, or other. Engagement fields can include first and last open or click times, bounce time, reply time, and unsubscribe time.
List email templates for a Workflow
curl "https://public-api.us.unison.totango.com/v1/workflows/<workflow_id>/email-templates?page[limit]=25" \ --header "Authorization: Bearer <public_api_credential>"
Each template includes its ID, Workflow ID, subject, automated setting, and created and updated times. The default page size is 25 templates and the maximum is 100.