Seamless icon

Seamless

Interact with Seamless.ai

Campaign → Get Contacts

AI-generated

Summary

Retrieves a list of contacts belonging to a specific Seamless campaign.

Inputs

  • authentication (required) — OAuth2 or API Key credential type.
  • campaignId (required) — The campaign to operate on. Can be selected from a list, provided as a numeric ID, or provided as an identifier slug.
  • returnAll — Whether to return all results or only up to a given limit.
  • limit — Max number of results to return. Only active when Return All is disabled.
  • offset — Pagination offset (default 0). Only active when Return All is disabled.
  • searchText — Search contacts within the campaign.

Output shape

a list of items

When Return All is false, uses limit and offset for pagination.

Examples

Example 1: Retrieve all contacts for a campaign using a numeric ID

Select campaign by ID (e.g., 12345), enable Return All.

Example 2: Retrieve the first 50 contacts from a campaign using a slug

Select campaign by Identifier (e.g., my-campaign-slug), disable Return All, set Limit to 50.

Example 3: Search for contacts with a specific text within the campaign

Select campaign by Identifier, disable Return All, set Limit to 50, enter Search Text.

Links

Discussion