Skip to main content
POST
Find Campaign

Body

string
Search term.
integer
Page number. Default: 1
integer
Number of results to return. Default: 100
string
Key to sort by. Allowed values: id, name, amount_raised, amount_goal
string
Direction of sorting. Allowed values: asc, desc
string
Email filter.
string
Campaign status. Allowed values: approved, pending
boolean
True if campaign is hidden, otherwise false.
object
Campaign’s creation date filter.
object
Campaign’s amount goal filter.
object
Campaign’s amount raised filter.
integer
Return teams after Team ID.
string
API’s locale. Allowed values: en, fr
integer
Filter campaigns only available in locale
string[]
List of fundraiser tags.

Response

Returns an array of objects with the following fields.
integer
Campaign ID.
integer
Site ID.
string
Campaign name.
string
Campaign creation date.
number
Goal amount.
number
Amount raised by the campaign.
string
Formatted amount raised by the campaign, includes currency symbol.
string
Date and time when campaign starts.
string
Date and time when campaign ends.
string
Campaign location.
string
URL to campaign.
integer
Number of donors.
integer
Number of teams.
integer
Number of pages.
string
Campaign’s approval status. Allowed values: approved, pending
string
Campaign’s activity status code. Allowed values: live, deleted, archived, pending_approval, opening_soon, closed
boolean
True if campaign is hidden, otherwise false.
string
Date when campaign is scheduled to auto-open
string
Date when campaign is scheduled to auto-close
string
Date when campaign was closed
string
Date when campaign was archived
string
Campaign language. Allowed values: en, fr
string
Value of In support of field associated with campaign.
string
Code provided for In support of field.
string
Appeal code.
object
object
object
object
object[]
List of custom questions and responses.
any[]
Campaign tags.
Other responses