Contacts

List Contacts

Lists contacts with filtering, search, and pagination. Supports filtering by team, campaign, and status.

get/contacts

Request

Base URL
https://api.supersend.io/v2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/supersend/apis/supersend-api/docs/contacts/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

TeamIdstring uuid

Filter by team ID

CampaignIdstring uuid

Filter by campaign ID

limitinteger

Number of items to return

offsetinteger

Number of items to skip

searchstring

Search by email, name, company

intereststring

Filter by contact status (interest). Comma-separated for multiple values. Values: interested, not_interested, meeting_request, meeting_booked, customer, future, follow_up. Use empty string or null to filter for contacts with no status.

Response

List of contacts

successboolean

request_idstring

Example response

{
  "success": true,
  "request_id": "req_abc123def456"
}

Changes

No recorded changes to this operation across all 6 revisions of this API.