> ## 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. # Get a candidate journey > What Record has done with this candidate so far: invite, reply, reminders, SMS and each voice call, then what is waiting. **Scope:** `results:read` ## OpenAPI ````yaml /blue-collar-api/api-reference/openapi.json get /candidates/{candidate_id}/journey 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: /candidates/{candidate_id}/journey: get: tags: - Results summary: Get a candidate journey description: >- What Record has done with this candidate so far: invite, reply, reminders, SMS and each voice call, then what is waiting. **Scope:** `results:read` operationId: getCandidateJourney parameters: - name: candidate_id in: path required: true schema: type: string pattern: ^[A-Za-z0-9_-]{4,64}$ example: a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01 responses: '200': description: The candidate's journey content: application/json: schema: type: object properties: success: const: true type: boolean message: type: string data: type: object properties: candidate_id: type: string campaign_id: type: string status: type: string enum: - pending - completed - declined - failed description: >- The candidate's status now: the same value the result record carries reason: anyOf: - type: string enum: - undeliverable - no_response - type: 'null' description: Why the status is failed; null otherwise steps: type: array items: type: object properties: key: type: string enum: - queued - whatsapp_sent - whatsapp_delivered - whatsapp_failed - tapped_yes - tapped_no - link_opened - reminder_sent - no_reply - link_not_opened - sms_sent - sms_failed - call - call_queued - call_next - completed description: Stable. Every voice call is `call` label: type: string description: Display text; do not match on it state: type: string enum: - done - failed - pending - scheduled description: >- done, failed, pending (waiting on the candidate or on us) or scheduled (planned) at: anyOf: - type: string - type: 'null' description: >- When it happened, or when it is due; null when Record has no time for it detail: anyOf: - type: string - type: 'null' description: >- In the order they happen: what was done first, then what is waiting last_activity_at: anyOf: - type: string - type: 'null' description: >- The last thing the candidate themselves did (replied, answered, finished) responded_at: anyOf: - type: string - type: 'null' description: When they first said yes on WhatsApp next_step: anyOf: - type: string enum: - voice_call - reminder - type: 'null' description: What Record does next; null when nothing is due link_opened: type: boolean example: success: true data: candidate_id: a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01 campaign_id: asmnt_9f2c41d7a8b3e65f status: pending reason: null steps: - key: whatsapp_sent label: WhatsApp message sent state: done at: '2026-10-05T09:30:00.000Z' detail: null - key: whatsapp_delivered label: Delivered state: done at: '2026-10-05T09:30:00.000Z' detail: null - key: tapped_yes label: Tapped Yes state: done at: '2026-10-05T09:41:00.000Z' detail: link sent in the next message - key: link_not_opened label: Link not opened yet state: pending at: '2026-10-05T13:30:00.000Z' detail: Reminder 1 goes out - key: call label: Call not answered state: failed at: '2026-10-05T10:00:00.000Z' detail: Attempt 1 of 3 - key: call_queued label: Voice call queued state: pending at: '2026-10-05T14:00:00.000Z' detail: Attempt 2 of 3 - key: call_next label: Next call, if no answer state: scheduled at: '2026-10-05T18:00:00.000Z' detail: null last_activity_at: '2026-10-05T09:41:00.000Z' responded_at: '2026-10-05T09:41:00.000Z' next_step: voice_call link_opened: false '404': description: '`NOT_FOUND`: No such `candidate_id` for this key.' content: application/json: schema: $ref: '#/components/schemas/Error' security: - ApiKey: [] SecretKey: [] x-codeSamples: - lang: bash label: cURL source: >- pcall GET "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey" - lang: javascript label: JavaScript source: >- const res = await call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey"); const { data } = await res.json(); - lang: python label: Python source: >- res = call("GET", "/api/v1/partner/candidates/a3f1c9d2-7b44-4e0a-9c1d-5e6f7a8b9c01/journey") 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.