> ## 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 candidates

> Every candidate of an enrichment and where each stands. Phone numbers are returned in full. Filter by campaign, status or a part of the name or number.

**Scope:** `enrichment:read` or `enrichment:write` or `enrichment:campaigns`



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}/candidates
openapi: 3.1.0
info:
  title: Record Enrichment API
  version: 1.0.0
  description: >-
    Collect work, location, shift and salary details from your own candidate
    database. 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: Enrichment API
security: []
tags:
  - name: Enrichments
  - name: Enrichment campaigns
  - name: Enrichment candidates
  - name: Enrichment results
  - name: Enrichment credits
paths:
  /enrichments/{enrichment_id}/candidates:
    get:
      tags:
        - Enrichment candidates
      summary: List candidates
      description: >-
        Every candidate of an enrichment and where each stands. Phone numbers
        are returned in full. Filter by campaign, status or a part of the name
        or number.


        **Scope:** `enrichment:read` or `enrichment:write` or
        `enrichment:campaigns`
      operationId: listEnrichmentCandidates
      parameters:
        - name: enrichment_id
          in: path
          required: true
          schema:
            type: string
            pattern: ^WF_[A-Z]{2}_[A-Z0-9]{10,40}$
          example: WF_EN_261121094822026AEDRUB86TQVSML
        - name: campaign_id
          in: query
          required: false
          schema:
            type: string
            pattern: ^EC_[A-Za-z0-9_-]{6,60}$
          example: EC_261121095438377TFUX07WN2XT42V
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - completed
              - interested
              - in_progress
              - link_opened
              - sent
              - queued
              - not_interested
              - opted_out
              - failed
          example: completed
        - name: search
          in: query
          required: false
          description: Part of the name or phone number
          schema:
            type: string
            maxLength: 200
        - name: limit
          in: query
          required: false
          description: 1 to 100, default 25
          schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 25
          example: 25
        - name: cursor
          in: query
          required: false
          description: The next_cursor of the previous page
          schema:
            type: string
            maxLength: 512
      responses:
        '200':
          description: One page, most recently finished first
          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
                            phone_number:
                              type: string
                            status:
                              type: string
                              enum:
                                - completed
                                - interested
                                - in_progress
                                - link_opened
                                - sent
                                - queued
                                - not_interested
                                - opted_out
                                - failed
                            language:
                              anyOf:
                                - type: string
                                - type: 'null'
                            campaign_id:
                              type: string
                            is_completed:
                              type: boolean
                            completed_channel:
                              anyOf:
                                - type: string
                                - type: 'null'
                            answered_count:
                              type: integer
                            question_count:
                              type: integer
                            delivery_error:
                              anyOf:
                                - type: string
                                - type: 'null'
                            answers:
                              type: object
                              additionalProperties:
                                type: array
                                items:
                                  type: string
                              description: Answer text per question_id
                      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: 6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33
                      external_id: cand-1001
                      name: Ravi Kumar
                      phone_number: '+919876543210'
                      status: completed
                      language: english
                      campaign_id: EC_261121095438377TFUX07WN2XT42V
                      is_completed: true
                      completed_channel: whatsapp
                      answered_count: 2
                      question_count: 2
                      delivery_error: null
                      answers:
                        eqq_cc9800817588972e:
                          - 'Yes'
                        eqq_7a31f0c2d95b84e6:
                          - Forklift operator, 4 years, Chennai
                  count: 1
                  total: 1
                  next_cursor: null
                  has_more: false
        '400':
          description: '`VALIDATION_FAILED`: Bad `status`, `campaign_id` or `cursor`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: '`NOT_FOUND`: No such enrichment.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: >-
            pcall GET
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates?campaign_id=EC_261121095438377TFUX07WN2XT42V&status=completed&limit=25"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates?campaign_id=EC_261121095438377TFUX07WN2XT42V&status=completed&limit=25");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML/candidates?campaign_id=EC_261121095438377TFUX07WN2XT42V&status=completed&limit=25")

            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
                - 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.