Campaigns

List campaigns

Every campaign on the account.

How much of each campaign comes back is chosen with view. The default is full, which carries the suppliers, buyers and every field - on an account with a few hundred campaigns that runs to megabytes, so ask for short when looking a campaign up by name, or summary to see who is on it.

Only campaigns that are fully set up appear. Paged with a cursor: pass the response's search_after value for the next page, and stop when it is null.

get/v2/campaigns

Request

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

Query parameters

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

How much of each campaign to return.

  • short - id, name, public_name and campaign_type. For finding a campaign by name.
  • summary - adds suppliers and buyers, each trimmed to what identifies it and whether it is live. A buyer's delivery is the type on its own.
  • full (default) - adds every field the campaign accepts, the client behind each supplier and buyer, and the whole delivery object.
name_containsstring

Only campaigns whose name or public name contains this text. Case-insensitive.

buyers'active' | 'all'

Which buyers to include. active, the default, leaves out buyers that are paused, because a paused buyer is not receiving leads; all includes them. Suppliers are unaffected either way - they always appear, with their own paused flag. Ignored under view=short, which carries no buyers at all.

limitinteger

Campaigns per page. 100 is also the ceiling, so this can only ask for a smaller page.

search_afterstring

The search_after value from the previous page. Omit for the first page.

Response

Success

statusstring

Changes

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