Campaigns

List the people in a campaign

The people in a campaign with where each one is: pending (being checked), queued, active, replied, bounced, completed or suppressed. status=held lists the people waiting at an email because a variable it uses has no value for them; each one carries hold with the variables, the email and a sentence.

CostWhat it doesKey scopes
FreeReads onlyargorant:read_counts
get/api/v1/campaigns/{campaign_id}/leads

Request

  • Base URL: https://app.argorant.com
  • URL: https://app.argorant.com/api/v1/campaigns/{campaign_id}/leads
  • Auth: HTTP bearer

Path parameters

campaign_idstring uuid required

The campaign id from create or list.

Query parameters

status'pending' | 'queued' | 'active' | 'replied' | 'bounced' | 'completed' | 'suppressed' | 'held'

Only this status.

qstring

Search name, email or company.

limitinteger

Rows per page, 1 to 500 (default 50).

cursorstring

The next_cursor of the previous page. Leave out for the first page.

offsetinteger

Rows to skip, as an alternative to cursor.

Headers

X-Request-Idstring

Your own id for this request, 8 to 64 letters, digits, dot, dash or underscore. Returned as X-Request-Id; one is made for you when you send none.

Response

OK

totalinteger nullable required

How many rows exist in total for this query.

limitinteger required

Rows per page in this answer.

offsetinteger required

Rows skipped before this page.

next_cursorstring nullable required

Pass as cursor to get the next page. null on the last page.

has_moreboolean required

true when another page exists.

total_is_estimateboolean

Present and true when total is a lower bound, for example when a list reached its upper size.

Changes

No recorded changes to this operation across all 1 revision of this API.