API ReferenceCampaignsList campaign leads
GET/v1/campaigns/:id/leads

List campaign leads

Lists the leads already in a campaign — the read counterpart to Add leads. Supports pagination and search.

Stablescope: read API KeyLearn about API scopes →

Request

AuthorizationBearer YOUR_API_KEY

Parameters

FieldTypeRequiredDescription
idstringRequiredCampaign ID.
limitnumberOptionalPage size, max 200, default 50.
cursorstringOptionalOpaque pagination cursor from the previous response's nextCursor.
searchstringOptionalFree-text search across lead fields.
statusstringOptionalFilter by send status.
curl "https://api.stynar.com/v1/campaigns/cmp_abc123/leads?limit=50" \
  -H "Authorization: Bearer esk_your_key_here"

Response

200 OK
200 response
{
  "leads": [
    {
      "leadId": "lead_1a2b3c",
      "status": "SENT",
      "fields": {
        "email": "jane@acme.com",
        "firstName": "Jane"
      }
    }
  ],
  "nextCursor": "eyJsZWFkSWQiOiJsZWFkXzFhMmIzYyJ9"
}

Response fields

Errors

StatusCodeMeaning
401 UnauthorizedUNAUTHORIZEDMissing, malformed, unknown, revoked, or expired key.
403 ForbiddenAPI_ACCESS_DISABLEDYour account doesn't currently have API access.
403 ForbiddenINSUFFICIENT_SCOPEThe key doesn't have the scope this endpoint requires.
404 Not FoundNOT_FOUNDUnknown route, or a resource that doesn't exist / isn't yours.
409 ConflictCONFLICTThe action can't be applied to the resource's current state.
429 Too Many RequestsRATE_LIMIT_EXCEEDEDPer-minute or per-second limit hit.
429 Too Many RequestsQUOTA_EXCEEDEDMonthly quota exhausted.
500 Internal Server ErrorINTERNAL_ERRORSomething broke on Stynar's end.
Full error reference →