List campaign leads

One row per lead with its status, outcome, latest call and extracted fields. Offset-paginated.

GET /campaigns/{id}/leads

List campaign leads

cURL

curl --request GET \
  --url https://api.pineyard.ai/campaigns/{id}/leads \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "id": "<string>",
      "contactId": "<string>",
      "callId": "<string>",
      "toNumber": "<string>",
      "name": "<string>",
      "status": "<string>",
      "outcome": "<string>",
      "durationMs": 123,
      "attemptCount": 123,
      "queuedAt": "<string>",
      "scheduledCallbackAt": "<string>",
      "fields": {},
      "doNotCall": true,
      "churnDepth": 123,
      "nextEligibleAt": "<string>",
      "referredFromCallId": "<string>",
      "everReached": true,
      "extraction": null,
      "workflowRunId": "<string>"
    }
  ],
  "total": 123
}

Required scope: intel.view

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Path Parameters

id · string · required

Query Parameters

limit · integer

Required range: 1 <= x <= 200

offset · integer | null

Required range: x >= 0

status · string

Response

200

application/json

OK

items · object[] · required

Show child attributes

total · number · required