v1

latestOpenAPI 3.0.3Apache 2.02026-08-062991191002.1 KB

Campaign

Retrieves a Campaign resource.

get/campaigns/{id}

idstring required

Resource identifier

Campaign resource

idstring

integrationstring

The key of the integration source e.g. "quickbooks", or "xero"

srcIdstring

the unique identifier of the source 3rd party integration

campaignNamestring nullable

name of the campaign

campaignOwnerstring nullable

name of the person the campaign responsibility is assigned to

descriptionstring nullable

details about the campaign

startDatestring date-time nullable

campaign start time date

endDatestring date-time nullable

campaign end time date

budgetedCoststring nullable

planned amount to spent on the campaign

actualCoststring nullable

actual amount spent on the campaign

expectedRevenuestring nullable

expected revenue from the campaign

statusstring nullable

status of the campaign e.g:done

createdstring date-time nullable

when the campaign is created

modifiedstring date-time nullable

when the campaign attributes is modified

nExpectedResponseinteger nullable

{
  "integration": "quickbooks"
}