Skip to main content
GET
Get campaign

Headers

x-api-key
string
required

API key needed to authorize the request

Path Parameters

campaignId
string<uuid>
required

The ID of the campaign, from List campaigns

Response

Campaign retrieved successfully.

id
string<uuid>
name
string
Example:

"Autocash Septiembre"

status
enum<string>
Available options:
draft,
active,
paused,
archived
campaign_type
enum<string>
Available options:
one_time
kpi_event
object | null

The conversion goal of the campaign

audience
object
lifecycle
enum<string>
Available options:
notSent,
inProcess,
finished
delivery
object
created_at
string<date-time>
front_url
string

Link to the campaign in Vambe

first_batch_at
string<date-time> | null
results
object
steps
object[]

Performance of each send step, in campaign order