Campaigns

Get a campaign

One campaign, in the same shape as an entry of the list - and taking the same view and buyers parameters, so a caller who only wants the name need not pay for the fields.

Everything the caps and filters endpoints need comes from here: the campaign id, the supplier and buyer ids, and the field names with their types. That is the default view=full answer.

get/v2/campaigns/{id}

Request

  • Base URL: https://api.leadprosper.io/public
  • URL: https://api.leadprosper.io/public/v2/campaigns/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Path parameters

idinteger required

Campaign id.

Query parameters

view'short' | 'summary' | 'full'

How much of the campaign to return - the same three values the listing takes, and the same default. short is the four identifying properties; summary adds trimmed suppliers and buyers; full adds every field and the whole delivery object.

buyers'active' | 'all'

Which buyers to include: active (the default) leaves out paused buyers, all includes them.

Response

Success

statusstring

Changes

No recorded changes to this operation across all 1 revision of this API.