Get Campaign

https://lumail.io/api/v1/campaigns/{campaignId}

Retrieve detailed information about a specific campaign, including its content, sender details, and performance metrics.

Response

• Success (200 OK) - Returns the campaign object with full details.
• Error (404 Not Found) - Campaign not found or doesn't belong to your organization.
• Error (401 Unauthorized) - Invalid or missing API token.

Path Parameters

Parameter	Type	Description
campaignId	string	Required. The unique campaign ID

Response Fields

Field	Type	Description
success	boolean	Indicates if the operation was successful
campaign	object	The campaign object with full details
campaign.id	string	Unique identifier for the campaign
campaign.campaignId	string	Same as id (for consistency)
campaign.name	string	Name of the campaign
campaign.subject	string	Email subject line
campaign.preview	string or null	Preview text for the email
campaign.status	string	Campaign status: DRAFT, SCHEDULED, SENDING, SENT
campaign.contentType	string	Content type: MAILY, PLATE, or MARKDOWN
campaign.content	object	Email content in TipTap JSON format
campaign.replyTo	string or null	Reply-to email address
campaign.senderId	string	Email sender ID
campaign.scheduledAt	string or null	ISO timestamp when the campaign is scheduled
campaign.sendAt	string or null	ISO timestamp when the campaign was sent
campaign.timezone	string	Timezone for scheduling
campaign.recipientCount	number	Number of recipients
campaign.recipientFilters	array	Filters applied to select recipients
campaign.emailsSentCount	number	Number of emails sent
campaign.emailsOpenedCount	number	Number of emails opened
campaign.emailsClickedCount	number	Number of emails clicked
campaign.createdAt	string	ISO timestamp when the campaign was created
campaign.updatedAt	string	ISO timestamp when the campaign was last updated
campaign.sender	object	Email sender details
campaign.sender.id	string	Sender ID
campaign.sender.name	string	Sender name
campaign.sender.displayName	string	Display name shown in emails
campaign.sender.localPart	string	Local part of the email address
campaign.sender.replyTo	string or null	Reply-to address for the sender
campaign.sender.domain.domain	string	Domain for the sender email
campaignId	string	Campaign ID at the root level for convenience

Usage Example

Use this API endpoint to:

• Retrieve full campaign details for editing
• Display campaign content in your application
• Check campaign status and performance metrics
• Get sender information for a campaign
• Build campaign preview functionality

Related Documentation

• List Campaigns - List all campaigns
• Create Campaign - Create a new campaign
• Update Campaign - Update a campaign
• Delete Campaign - Delete a campaign