Skip to main content
GET
List campaign contacts

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Path Parameters

id
integer
required

Numeric campaign ID.

Query Parameters

limit
integer
default:25

Maximum number of contacts to return. Must be an integer from 1 to 50; other values return 400.

Required range: 1 <= x <= 50
offset
integer
default:0

Number of contacts to skip.

Required range: x >= 0
searchText
string

Case-insensitive partial match against the contact's name, title, company name, company domain, email addresses, or phone number.

Response

A page of contacts enrolled in the campaign.

success
boolean
Example:

true

data
object[]
pagination
object

Offset pagination metadata.