API Reference

Get Campaigns

Retrieve a paginated list of campaigns using optional filters and sorting. Permission: Read Campaigns

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

The page number for paginated results. Defaults to 1.

string

The field to sort results by. Prefix with '-' for descending order (e.g., '-createdAt'). Sortable fields are indicated in each field's description.

string

Filter expression in the format: filter[field][operator]=value. See individual field descriptions for available operators. Example: filter[status][eq]=Funded.

string

An external identifier from a marketing system. Sortable: Yes. Filter Operators: eq, ne, nn, null, se, sw

string

The campaign name. Sortable: Yes. Filter Operators: eq, ne, nn, null, se, sw

string

The campaign type. Possible values: Mail, Text, Email, Phone, Collections, Other. Sortable: Yes. Filter Operators: eq, ne, in, nin

Headers
string
required
Defaults to application/vnd.totality.v1+json

Must be application/json.

string
required
Defaults to application/json

Must be application/json.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Choose an example:
application/json