Get campaigns

Retrieve a list of campaigns with optional filtering, sorting, and pagination. Supports JSON:API specification with includes, filtering, sorting, and pagination.

Query Options:

  • 📦 Include Related Data - include=leads to include associated leads
  • 🔍 Filter Results - filter[status]=active or filter[updated_at][gte]=2024-01-01
  • ↕️ Sort - sort=-inserted_at (newest first) or sort=name
  • 📄 Paginate - page[limit]=25&page[offset]=50&page[count]=true
  • ✂️ Select Fields - fields[campaigns]=name,status,lead_count

Combine multiple parameters with &. Example:
?filter[status]=active&include=leads&sort=-inserted_at&page[limit]=10

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

Supports all JSON:API query parameters including:

Filtering - filter[field]=value
(e.g., filter[status]=active&filter[updated_at][gte]=2024-08-27T06:00:00.000Z)

Sorting - sort=field or sort=-field
(e.g., sort=-inserted_at)

Pagination - page[limit]=N&page[offset]=N&page[count]=true
(e.g., page[limit]=25&page[offset]=50)

Field Selection - fields[type]=field1,field2
(e.g., fields[campaign]=name,status)

Includes - include=relationship
Valid includes: leads
(e.g., include=leads)

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json