> ## Documentation Index > Fetch the complete documentation index at: https://docs.userecord.io/llms.txt > Use this file to discover all available pages before exploring further. # List campaign candidates > One row per candidate: `candidate_id`, interested or not, progress, verdict and score, plus `delivery` (queued, sent, failed) and `can_resend`, so you can see who needs their link sent again. Phone numbers are never returned. A key with only `campaigns:write` gets the rows with `verdict`, `total_score` and `report_url` left null. **Scope:** `results:read` or `campaigns:write` ## OpenAPI ````yaml /blue-collar-api/api-reference/openapi.json get /campaigns/{campaign_id}/candidates openapi: 3.1.0 info: title: Record Blue Collar API version: 1.0.0 description: >- Run Record candidate verification from your own system. You need two things: your **key id** and your **secret**. Everything else is generated. See Authentication for how. servers: - url: https://api-bc.userecord.io/api/v1/partner description: Blue Collar API security: [] tags: - name: Skills description: The skill taxonomy, read live a page at a time - name: Skill requests description: Ask Record to add a missing skill - name: Lookups description: >- Lookups for filling in a job mandate: places in India, the countries an abroad job can be in, and the employment types and shifts the playground offers - name: Workflows description: >- Your organisation's blue-collar workflows (read all; change and soft-delete only the ones you created) - name: Job mandates description: >- Your organisation's job mandates, addressed by Record's mandate_id (read all; change only the ones you created) - name: Campaigns description: Contact candidates for one of your jobs and verify them. Spends credits - name: Results description: >- What Record collected from each candidate: status (pending, completed, declined, failed) and an output of answers and verdicts - name: Events description: >- Pull your result events and acknowledge them: the safety net behind the webhook, and a way to receive results without exposing a URL - name: Webhooks description: >- Endpoints that Record POSTs result events to: signed, retried until you acknowledge, replayable - name: Analytics description: >- The workflow Overview analytics of the Record playground: funnel, channels, follow-ups, calls, drop-offs, languages (read-only, scope analytics:read) paths: /campaigns/{campaign_id}/candidates: get: tags: - Results summary: List campaign candidates description: >- One row per candidate: `candidate_id`, interested or not, progress, verdict and score, plus `delivery` (queued, sent, failed) and `can_resend`, so you can see who needs their link sent again. Phone numbers are never returned. A key with only `campaigns:write` gets the rows with `verdict`, `total_score` and `report_url` left null. **Scope:** `results:read` or `campaigns:write` operationId: listCampaignCandidates parameters: - name: campaign_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9_-]{4,64}$ example: asmnt_9f2c41d7a8b3e65f - name: status in: query required: false schema: type: string enum: - interested - not_interested - no_answer_yet - unreachable example: interested - name: progress in: query required: false schema: type: string enum: - not_yet_started - in_progress - completed - name: updated_since in: query required: false description: ISO 8601 date-time schema: type: string format: date-time - name: limit in: query required: false description: 1 to 200, default 100 schema: type: integer minimum: 1 maximum: 200 default: 100 example: 100 - name: cursor in: query required: false description: The next_cursor of the previous page schema: type: string maxLength: 512 responses: '200': description: One page content: application/json: schema: type: object properties: success: const: true type: boolean message: type: string data: type: object properties: items: type: array items: type: object properties: candidate_id: type: string external_id: anyOf: - type: string - type: 'null' name: type: string status: type: string enum: - interested - not_interested - no_answer_yet - unreachable progress: anyOf: - type: string enum: - not_yet_started - in_progress - completed - type: 'null' verdict: anyOf: - type: string - type: 'null' total_score: anyOf: - type: number - type: 'null' language: type: string sent_at: anyOf: - type: string - type: 'null' completed_at: anyOf: - type: string - type: 'null' updated_at: type: string report_url: anyOf: - type: string - type: 'null' description: >- Public, name-masked result page; treat it as a private link delivery: type: string enum: - queued - sent - failed description: >- queued: not contacted yet. sent: the link went out. failed: the link could not be delivered can_resend: type: boolean description: >- true when POST /campaigns/{campaign_id}/candidates/{candidate_id}/resend would send this candidate's link again (the campaign must also be running) count: type: integer description: How many items this page holds total: anyOf: - type: integer - type: 'null' description: >- How many items match your filters across all pages. null when that cannot be counted cheaply: a filter worked out per item (status, progress) on a list that is large next_cursor: anyOf: - type: string - type: 'null' description: >- Pass as `cursor` for the next page; null on the last page has_more: type: boolean description: >- true while there is a next page (with a status or progress filter that page can still come back empty) example: success: true data: items: - candidate_id: a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01 external_id: cand-88231 name: Ravi Kumar status: interested progress: completed verdict: Good Fit total_score: 78 language: ta sent_at: '2026-10-05T09:30:00.000Z' completed_at: '2026-10-05T12:41:10.000Z' updated_at: '2026-10-05T12:41:10.000Z' report_url: https://example.com/r/7Hk2p9 delivery: sent can_resend: false count: 1 total: 240 next_cursor: eyJpZCI6IjY2YTEifQ has_more: true '400': description: >- `VALIDATION_FAILED`: Unknown `status` / `progress`, bad date, or `limit` above 200. content: application/json: schema: $ref: '#/components/schemas/Error' '404': description: '`NOT_FOUND`: No such campaign.' content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKey: [] SecretKey: [] x-codeSamples: - lang: bash label: cURL source: >- pcall GET "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100" - lang: javascript label: JavaScript source: >- const res = await call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100"); const { data } = await res.json(); - lang: python label: Python source: >- res = call("GET", "/api/v1/partner/campaigns/asmnt_9f2c41d7a8b3e65f/candidates?status=interested&limit=100") data = res.json()["data"] components: schemas: Error: type: object properties: success: const: false type: boolean error: type: object properties: code: type: string enum: - VALIDATION_FAILED - LIMIT_EXCEEDED - UNAUTHORIZED - SCOPE_MISSING - FORBIDDEN - HTTPS_REQUIRED - NOT_FOUND - CONFLICT - WORKFLOW_IN_USE - INSUFFICIENT_CREDITS - IDEMPOTENCY_KEY_REQUIRED - IDEMPOTENCY_KEY_REUSED - IDEMPOTENCY_IN_PROGRESS - PAYLOAD_TOO_LARGE - UNSUPPORTED_MEDIA_TYPE - RATE_LIMITED - COOLDOWN - DAILY_CAP - SERVICE_DISABLED - SERVER_ERROR message: type: string details: type: array items: type: object properties: path: type: string message: type: string request_id: type: string description: Quote it to Record support securitySchemes: ApiKey: type: apiKey in: header name: x-api-key description: Your key id, `VFN_TEST_…` or `VFN_LIVE_…`. Sent on every request. SecretKey: type: apiKey in: header name: x-secret-key description: >- Your secret, `VFN_SK_…`. **Not a real header, and never sent to the API.** It is only a form field for Try it, which uses it to sign your request in your browser. In your own code you sign each request with the secret and send `x-api-key`, `x-timestamp` and `x-signature` (see Authentication). ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.