Notes

List notes

The notes on a campaign, newest first.

Both path segments are optional: omit target for every note in a scope, and omit both for every note on the campaign - on the campaign itself, its suppliers and its buyers together. campaign is the note on the campaign itself, the same level filters call global, and takes no target.

Notes exist only on multi-buyer campaigns; any other campaign answers 422. Each note lists its attachments by name and URL.

get/v2/campaigns/{campaign}/notes/{scope}/{target}

Request

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

Path parameters

campaigninteger required

Campaign id.

scope'campaign' | 'suppliers' | 'buyers'

campaign, suppliers or buyers. Omit for every note on the campaign.

targetinteger

One supplier or buyer id. Omit to cover all of them within the scope. Not accepted with campaign.

Query parameters

limitinteger

Notes per page, up to 250. Default 50.

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.