Skip to main content
GET
Get campaign details
Requires campaigns:read. Use an ID from List Campaigns. The generated response schema below defines campaign configuration, progress and sender fields. A missing campaign or an ID outside this workspace is unavailable to the caller.

Authorizations

X-API-Key
string
header
required

API key for authentication (prefix: sp_live_ or sp_test_)

Path Parameters

id
string
required

Campaign ID

Response

Campaign details

id
string
required

Campaign ID

Example:

"clxyz123..."

name
string
required

Campaign name

Example:

"Q1 Outreach"

status
enum<string>
required

Campaign status

Available options:
not_started,
started,
paused,
failed,
finished,
scheduling,
draft,
unknown
Example:

"started"

totalLeads
number
required

Total leads in campaign

Example:

500

createdAt
string<date-time>
required

When the campaign was created

type
string
required

Campaign type

Example:

"regular"

linkedInSenderIds
string[]
required

Linked LinkedIn account IDs

Example:
leadsContacted
number

Leads contacted

Example:

250

connectionsSent
number

Connections sent

Example:

200

messagesSent
number

Messages sent

Example:

150

repliesReceived
number

Replies received

Example:

25

updatedAt
string<date-time>

When the campaign was last updated