API Reference
Contacts
Custom Fields
Campaigns
Contact Lists
Campaigns
Get Campaign
Retrieve the details of a specific campaign by its ID using the AutoSend API.
GET
/
campaigns
/
{campaignId}
curl --request GET \
--url 'https://api.autosend.com/v1/campaigns/60d5ec49f1b2c72d9c8b4567' \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"id": "69d348dd0351e0c32be90342",
"projectId": "68c7e05a0bd5787257e6ee3b",
"organizationId": "68c7e05a0bd5787257e6ee38",
"createdBy": 68c7e05a0bd5787257e7ec99,
"name": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"replyTo": "[email protected]",
"toLists": [
{
"id": "696e1158fbfc515799175f02",
"name": "seg list",
"type": "list",
"contactCount": 3
}
],
"excludeLists": [],
"unsubscribeGroupId": null,
"sendNow": true,
"scheduledAt": "2026-04-06T05:56:02.850Z",
"templateId": "A-280fa451a7ca5cc17513",
"status": "sent",
"from": {
"email": "[email protected]",
"name": "Example Team"
},
"metrics": {
"sent": 200,
"delivered": 200,
"opened": 160,
"suppressed": 0,
"clicked": 0,
"bounced": 0,
"unsubscribed": 0,
"spamReported": 0,
"processedCount": 200,
"totalContacts": 200,
"failedCount": 0
},
"sentAt": "2026-04-06T05:54:51.190Z",
"abortedAt": null,
"failureReason": null,
"createdAt": "2026-04-06T05:47:09.523Z",
"updatedAt": "2026-04-06T07:26:09.190Z",
"sendToGlobalList": false,
"template": {
"templateId": "A-280fa451a7ca5cc17513",
"projectId": "68c7e05a0bd5787257e6ee3b",
"templateName": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"emailTemplate": "<!DOCTYPE html><html><head></head><body><h1>Welcome, {{name}}!</h1><p>Thanks for signing up.</p></body></html>",
"templateType": "marketing",
"builderType": "code",
"createdAt": "2026-04-06T05:47:09.516Z",
"updatedAt": "2026-04-06T05:47:09.516Z",
},
"trackingClick": true,
"trackingOpen": true,
"sendMode": "immediate",
"resumedAt": null,
"pausedReason": null,
"pausedAt": null,
"thresholdPreset": "balanced",
"source": "api",
},
"message": "Campaign retrieved successfully"
}
curl --request GET \
--url 'https://api.autosend.com/v1/campaigns/60d5ec49f1b2c72d9c8b4567' \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"id": "69d348dd0351e0c32be90342",
"projectId": "68c7e05a0bd5787257e6ee3b",
"organizationId": "68c7e05a0bd5787257e6ee38",
"createdBy": 68c7e05a0bd5787257e7ec99,
"name": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"replyTo": "[email protected]",
"toLists": [
{
"id": "696e1158fbfc515799175f02",
"name": "seg list",
"type": "list",
"contactCount": 3
}
],
"excludeLists": [],
"unsubscribeGroupId": null,
"sendNow": true,
"scheduledAt": "2026-04-06T05:56:02.850Z",
"templateId": "A-280fa451a7ca5cc17513",
"status": "sent",
"from": {
"email": "[email protected]",
"name": "Example Team"
},
"metrics": {
"sent": 200,
"delivered": 200,
"opened": 160,
"suppressed": 0,
"clicked": 0,
"bounced": 0,
"unsubscribed": 0,
"spamReported": 0,
"processedCount": 200,
"totalContacts": 200,
"failedCount": 0
},
"sentAt": "2026-04-06T05:54:51.190Z",
"abortedAt": null,
"failureReason": null,
"createdAt": "2026-04-06T05:47:09.523Z",
"updatedAt": "2026-04-06T07:26:09.190Z",
"sendToGlobalList": false,
"template": {
"templateId": "A-280fa451a7ca5cc17513",
"projectId": "68c7e05a0bd5787257e6ee3b",
"templateName": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"emailTemplate": "<!DOCTYPE html><html><head></head><body><h1>Welcome, {{name}}!</h1><p>Thanks for signing up.</p></body></html>",
"templateType": "marketing",
"builderType": "code",
"createdAt": "2026-04-06T05:47:09.516Z",
"updatedAt": "2026-04-06T05:47:09.516Z",
},
"trackingClick": true,
"trackingOpen": true,
"sendMode": "immediate",
"resumedAt": null,
"pausedReason": null,
"pausedAt": null,
"thresholdPreset": "balanced",
"source": "api",
},
"message": "Campaign retrieved successfully"
}
Authorizations
Bearer authentication header of the form Bearer
<token>, where <token> is your auth token.Path Parameters
The id of the campaign to retrieve.
Response
Returns the full campaign object for the given ID.Indicates whether the request was successful.
The campaign object.
Show data
Show data
Unique identifier of the campaign.
ID of the project this campaign belongs to.
ID of the organization this campaign belongs to.
ID of the user who created the campaign.
Display name of the campaign.
Email subject line.
Preview text shown in email clients.
ID of the sender used for this campaign.
Reply-to email address.
Lists or segments excluded from this campaign.
ID of the unsubscribe group associated with this campaign.
Whether the campaign was sent immediately.
ISO 8601 date-time when the campaign is scheduled to send. Null if not scheduled.
ID of the email template used by this campaign.
Current status of the campaign. One of:
draft, scheduled, sending, sending_gradual, paused, sent, failed, aborted.Campaign delivery and engagement metrics.
Show metrics
Show metrics
Number of emails sent.
Number of emails delivered.
Number of emails opened.
Number of emails suppressed.
Number of emails clicked.
Number of emails bounced.
Number of unsubscribes.
Number of spam reports.
Total number of emails processed.
Total number of contacts targeted.
Number of emails that failed to send.
Average sending rate per second.
Total time taken to send the campaign in seconds.
ISO 8601 timestamp when the campaign was sent.
ISO 8601 timestamp when the campaign was aborted. Null if not aborted.
Internal job ID for the campaign send process.
Reason for campaign failure. Null if the campaign did not fail.
ISO 8601 timestamp when the campaign was created.
ISO 8601 timestamp when the campaign was last updated.
Whether the campaign was sent to the global contact list.
The email template associated with this campaign.
Show template
Show template
Unique identifier of the template.
ID of the project the template belongs to.
Display name of the template.
Email subject line from the template.
Preview text from the template.
HTML content of the email template.
Type of the template. One of:
marketing, transactional.How the template was built. One of:
code, editor.Editor JSON data if built with the visual editor.
Parent body properties for the template.
ISO 8601 timestamp when the template was created.
ISO 8601 timestamp when the template was last updated.
Whether the template has been flagged.
Source of the template. One of:
api, dashboard.Internal ID of the template.
Whether click tracking is enabled.
Whether open tracking is enabled.
How the campaign is delivered:
immediate, scheduled, or gradual.ISO 8601 timestamp when the campaign was resumed. Null if never paused.
Reason the campaign was paused. Null if not paused.
ISO 8601 timestamp when the campaign was paused. Null if not paused.
Sending threshold preset. One of:
balanced, aggressive, conservative.Source of the campaign. One of:
api, dashboard.Gradual send configuration. Null if not using gradual send mode.
A human-readable message describing the result.
⌘I
curl --request GET \
--url 'https://api.autosend.com/v1/campaigns/60d5ec49f1b2c72d9c8b4567' \
--header 'Authorization: Bearer <token>'
{
"success": true,
"data": {
"id": "69d348dd0351e0c32be90342",
"projectId": "68c7e05a0bd5787257e6ee3b",
"organizationId": "68c7e05a0bd5787257e6ee38",
"createdBy": 68c7e05a0bd5787257e7ec99,
"name": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"replyTo": "[email protected]",
"toLists": [
{
"id": "696e1158fbfc515799175f02",
"name": "seg list",
"type": "list",
"contactCount": 3
}
],
"excludeLists": [],
"unsubscribeGroupId": null,
"sendNow": true,
"scheduledAt": "2026-04-06T05:56:02.850Z",
"templateId": "A-280fa451a7ca5cc17513",
"status": "sent",
"from": {
"email": "[email protected]",
"name": "Example Team"
},
"metrics": {
"sent": 200,
"delivered": 200,
"opened": 160,
"suppressed": 0,
"clicked": 0,
"bounced": 0,
"unsubscribed": 0,
"spamReported": 0,
"processedCount": 200,
"totalContacts": 200,
"failedCount": 0
},
"sentAt": "2026-04-06T05:54:51.190Z",
"abortedAt": null,
"failureReason": null,
"createdAt": "2026-04-06T05:47:09.523Z",
"updatedAt": "2026-04-06T07:26:09.190Z",
"sendToGlobalList": false,
"template": {
"templateId": "A-280fa451a7ca5cc17513",
"projectId": "68c7e05a0bd5787257e6ee3b",
"templateName": "Spring Sale Newsletter",
"subject": "Don't miss our Spring Sale!",
"previewText": "Up to 50% off this weekend only",
"emailTemplate": "<!DOCTYPE html><html><head></head><body><h1>Welcome, {{name}}!</h1><p>Thanks for signing up.</p></body></html>",
"templateType": "marketing",
"builderType": "code",
"createdAt": "2026-04-06T05:47:09.516Z",
"updatedAt": "2026-04-06T05:47:09.516Z",
},
"trackingClick": true,
"trackingOpen": true,
"sendMode": "immediate",
"resumedAt": null,
"pausedReason": null,
"pausedAt": null,
"thresholdPreset": "balanced",
"source": "api",
},
"message": "Campaign retrieved successfully"
}