GET
/
api
/
teams
/
{teamId}
/
campaigns

Authorizations

Bearer API key
string
headerrequired

The API key used to authenticate requests, learn how to generate an API key on the Authentication page.

Path Parameters

teamId
string
required

Team ID, starting with tea_

Query Parameters

take
integer
default: 25

The number of items to return per page.

startingAfter
string

ID of the item to start the pagination after (not inclusive).

q
string

Search query to filter items by.

orderBy
string

The field to order items by (e.g., createdAt).

sort
enum<string>

The direction to sort items by.

Available options:
asc,
desc

Response

200 - application/json
id
string

The unique ID of the contact, starting with con_.

createdAt
string

The date and time the contact was created.

updatedAt
string

The date and time the contact was last updated.

status
enum<string>

The status of the campaign.

Available options:
DRAFT,
RUNNING,
PAUSED,
ARCHIVED,
EXHAUSTING,
EXHAUSTED
name
string

The name of the campaign.

goal
enum<string>

The goal of the campaign.

Available options:
SCHEDULE_MEETING,
CUSTOM_API_GOAL,
CLICK_LINK,
REPLY
goalUrl
string

The URL associated with the goal of the campaign.

offeringName
string

The name of the offering associated with the campaign.

offeringDescription
string

The description of the offering associated with the campaign.

List campaign contactsCreate a goal completion