Campaigns
List campaigns
Get all campaigns for a team.
GET
/
api
/
teams
/
{teamId}
/
campaigns
Authorizations
The API key used to authenticate requests, learn how to generate an API key on the Authentication page.
Path Parameters
Team ID, starting with tea_
Query Parameters
The number of items to return per page.
Required range:
x < 100
ID of the item to start the pagination after (not inclusive).
Search query to filter items by.
The field to order items by (e.g., createdAt
).
The direction to sort items by.
Available options:
asc
, desc
Response
200 - application/json
The unique ID of the contact, starting with con_
.
The date and time the contact was created.
The date and time the contact was last updated.
The status of the campaign.
Available options:
DRAFT
, RUNNING
, PAUSED
, ARCHIVED
, EXHAUSTING
, EXHAUSTED
The name of the campaign.
The goal of the campaign.
Available options:
SCHEDULE_MEETING
, CUSTOM_API_GOAL
, CLICK_LINK
, REPLY
The URL associated with the goal of the campaign.
The name of the offering associated with the campaign.
The description of the offering associated with the campaign.