GET
/
api
/
teams
/
{teamId}
/
contacts
/
{contactId}
/
campaign-contacts

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_

contactId
string
required

Contact ID, starting with con_

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 this contact in a campaign, starting with cpc_.

createdAt
string

The date and time the contact was added to this campaign.

updatedAt
string

The date and time the contact was last updated in this campaign.

status
enum<string>

The status of the campaign contact.

Available options:
OPEN,
WON,
LOST
data
object

The data associated with the campaign contact added when using an integration.

campaignId
string

The unique ID of the campaign the campaign contact is associated with, starting with cpg_.

contactId
string

The unique ID of the contact the campaign contact is associated with, starting with con_.

campaign
object