API Reference

Get Campaign Assignments

get
https://{your-totality-url}.com/api/campaign-assignments

Retrieve a paginated list of campaign assignments using optional filters and sorting. Permission: Read Campaign Assignments

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

The UUID of the campaign. Use the GET /api/campaigns endpoint to find available campaigns. Sortable: Yes. Filter Operators: eq, neq, in, nin

string

The UUID of the associated customer. Sortable: Yes. Filter Operators: eq, neq, in, nin

string

The campaign recipient's email address. Sortable: Yes. Filter Operators: eq, ne, nn, null, se, sw

string

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

string

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

integer

The offer amount presented to the recipient, in dollars. Sortable: Yes. Filter Operators: eq, gt, gte, lt, lte, ne, nn, null

string

The offer code for tracking redemptions. Sortable: Yes. Filter Operators: eq, ne, nn, null, se, sw

string

The recipient's postal or ZIP code. Sortable: Yes. Filter Operators: eq, ne, nn, null, se, sw

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

Updated about 1 month ago

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

Updated about 1 month ago