Skip to main content
GET
Get contacts report by status

Authorizations

Authorization
string
header
required

Headers

x-sub-organization-id
string

Optional sub organization ID. Must belong to your main organization API key.

Path Parameters

campaignId
string
required

Id of the campaign as a string ObjectId value.

Query Parameters

archived
boolean

Archived filter for getting the report of archived contacts. Default is false.

Response

status
enum<string>
Available options:
error
message
string