Skip to main content
POST
Query Campaigns
Call Get Query Options for the Campaign query type to discover the parameters, operators, and result fields available, then send one or more groups of conditions here along with selectedColumns, includeDetails, and your paging options. For numeric fields using the Between operator, put the lower bound in value and the upper bound in secondaryValue.
Setting includeDetails=true adds each campaign’s related records (segments, pages, and page statistics) and may slow down large result sets.

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The campaign query request, including queryType, structured groups/conditions, selectedColumns, includeDetails, and paging options.

Request body for advanced query endpoints such as donor and campaign queries.

filter
string | null

A free-text search term applied to the results.

skip
integer<int32>

The number of records to skip before the first record returned. Use it with take to page through the results.

take
integer<int32>

The maximum number of records to return in this page of results.

sortBy
enum<string> | null

Field to sort by (case-insensitive). Valid options: createdate, createddatetime, email, firstname, gifts, giftsum, id, lastname, modifieddatetimeutc, name, phone

Available options:
createdate,
createddatetime,
email,
firstname,
gifts,
giftsum,
id,
lastname,
modifieddatetimeutc,
name,
phone
Example:

"createdate"

descending
boolean

The direction to sort the results. Set to true to sort in descending order.

includeDetails
boolean

When true, includes the related records for each item in the response. Not every list has extra records to return, and it can slow down large result sets.

queryType
enum<integer>

The logical type of query being executed.

Available options:
0,
1,
2,
3,
4,
5,
6,
7,
8,
9
groups
object[] | null

The groups of conditions that make up the query.

selectedColumns
string[] | null

The list of result columns to return for each item.

Response

OK

A page of campaigns with the total number that match the request.

items
object[]

The campaigns in this page of results.

total
integer<int32>

The total number of campaigns that match the request. Use it with skip and take to page through the full set.

Last modified on April 23, 2026