POST GET campaigns/lookup

Get full details of a campaign record

* required

Parameters

Name	Type	Description
campaignID	integer	Unique ID of a campaign. Required if campaignIDs is not provided.
campaignIDs	array[integer]	Multiple campaignIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Required if campaignID is not provided. Max: 25

Response Data

Returns a fully populated campaign object, or an array of campaign objects if looking up multiple campaignIDs

Name

Type

Description

campaignID

integer

Unique ID of campaign

contentCounts

object

Counts of content currently assigned to the campaign

automatedEmails	integer	Number of automated emails in campaign
calendarEvents	integer	Number of calendar events in campaign
landingPages	integer	Number of landing pages in campaign
manualEmails	integer	Number of manual emails in campaign
sms	integer	Number of SMS in campaign
socialMessages	integer	Number of social messages in campaign
surveys	integer	Number of surveys in campaign
workflows	integer	Number of workflows in campaign

dateAdded

datetime

Date record was added

dateModified

datetime

Date record was modified

description

string

Description of campaign

endDate

date

Last date of campaign

startDate

date

First date of campaign

status

string

Current status of campaign. One of: Active, Inactive

title

string

Title of campaign

userID

integer

ID of system user the campaign belongs to (owner)

Example Calls

Lookup campaign by ID

GET

/campaigns/lookup?campaignID=123

cURL

Copy

curl https://api.emailer.emfluence.com/v1/campaigns/lookup?campaignID=123 \
	-H "Authorization: Bearer {{accessToken}}"

Response Data

{"success":1,"data":{"campaignID":123,"title":"Spring Promotion","description":"Q1 product launch campaign","status":"Active","userID":456,"dateAdded":"2025-01-15 14:30:00","dateModified":"2026-03-10 09:15:00","startDate":"2025-03-01","endDate":"2025-03-31","contentCounts":{"manualEmails":4,"automatedEmails":2,"socialMessages":3,"landingPages":1,"workflows":1,"calendarEvents":2,"surveys":0,"sms":1}},"code":0,"requestID":"5A733160-AD29-424B-8F9E2C5D65C76AE1"}

Lookup multiple campaigns by array of IDs

POST

/campaigns/lookup

cURL

Copy

curl https://api.emailer.emfluence.com/v1/campaigns/lookup \
	-H "Authorization: Bearer {{accessToken}}" \
	-H "Content-Type: application/json" \
	-X POST \
	-d '{
		"campaignIDs": [123, 456, 789]
	}'

Response Data

{"success":1,"data":[{"campaignID":123,"title":"Spring Promotion","description":"Q1 product launch campaign","status":"Active","userID":456,"dateAdded":"2025-01-15 14:30:00","dateModified":"2026-03-10 09:15:00","startDate":"2025-03-01","endDate":"2025-03-31","contentCounts":{"manualEmails":4,"automatedEmails":2,"socialMessages":3,"landingPages":1,"workflows":1,"calendarEvents":2,"surveys":0,"sms":1}},{"campaignID":456,"title":"Webinar Series","description":"Monthly webinar outreach","status":"Active","userID":456,"dateAdded":"2025-06-01 10:00:00","dateModified":"2026-02-20 16:45:00","startDate":"2025-06-01","endDate":"2025-12-31","contentCounts":{"manualEmails":8,"automatedEmails":0,"socialMessages":5,"landingPages":2,"workflows":0,"calendarEvents":6,"surveys":1,"sms":0}},{"campaignID":789,"title":"Holiday Campaign","description":"","status":"Inactive","userID":789,"dateAdded":"2024-11-08 08:20:00","dateModified":"2025-12-01 11:00:00","startDate":"2024-11-15","endDate":"2024-12-31","contentCounts":{"manualEmails":3,"automatedEmails":1,"socialMessages":4,"landingPages":0,"workflows":0,"calendarEvents":0,"surveys":0,"sms":2}}],"code":0,"requestID":"853CA651-2D6C-4459-B0470362C8F881E0"}

API Console

The console uses production data, so BE CAREFUL!

GET

campaigns/lookup

Param	Value	Type	Description
campaignID		integer	Unique ID of a campaign. Required if campaignIDs is not provided.
campaignIDs		array[integer]	Multiple campaignIDs. Requests that use this parameter will change the response data from a single object to an array of objects. Required if campaignID is not provided. Max: 25

Access token: *

Campaigns

POST GET campaigns/lookup

Parameters

Response Data

Example Calls

Lookup campaign by ID

Lookup multiple campaigns by array of IDs

API Console