campaigns

List campaign leads

List the leads in a campaign, with optional filters.

get/v1/campaigns/{id}/leads

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/campaigns/{id}/leads
  • Auth: API key in header x-api-key

Path parameters

idstring required

Query parameters

campaignStatus'CREATED' | 'ACTIVE' | 'PAUSED' | 'ERROR' | 'ARCHIVED' | 'COMPLETED'

Filter by campaignStatus: the campaign's status when the lead was added. It does not reflect where the lead is in its sequence.

hasRepliedboolean

Filter to leads that have / have not replied

limitnumber

Maximum number of leads to return (1-100)

cursorstring

Cursor from a previous response, to fetch the next page

Response

nextCursorstring nullable required

Opaque cursor for the next page; null when there are no more results. Pass it back as the cursor query parameter.

Example response

{
  "data": [
    {
      "name": "Jane Doe",
      "linkedinProfile": "https://www.linkedin.com/in/jane-doe"
    }
  ]
}

Changes

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