> ## 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 an enrichment

> One enrichment with its questions. Use it to wait for `questions_status` to reach `ready`.

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



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichments/{enrichment_id}
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}:
    get:
      tags:
        - Enrichments
      summary: Get an enrichment
      description: >-
        One enrichment with its questions. Use it to wait for `questions_status`
        to reach `ready`.


        **Scope:** `enrichment:read` or `enrichment:write` or
        `enrichment:campaigns`
      operationId: getEnrichment
      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
      responses:
        '200':
          description: The enrichment
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    const: true
                    type: boolean
                  message:
                    type: string
                  data:
                    type: object
                    properties:
                      enrichment_id:
                        type: string
                      external_id:
                        anyOf:
                          - type: string
                          - type: 'null'
                      name:
                        type: string
                      description:
                        type: string
                      status:
                        type: string
                        enum:
                          - active
                          - archived
                      questions_status:
                        type: string
                        enum:
                          - pending
                          - ready
                          - failed
                        description: >-
                          Translation and voice of the questions. Campaigns wait
                          for ready, then go out by themselves; failed is
                          retried when you create a campaign
                      delivery:
                        type: object
                        properties:
                          whatsapp:
                            type: boolean
                          voice_call:
                            type: boolean
                          sms:
                            type: boolean
                      schedule:
                        type: object
                        properties:
                          language:
                            type: string
                          start_time:
                            type: string
                          end_time:
                            type: string
                          days:
                            type: array
                            items:
                              type: string
                          timezone:
                            type: string
                          max_retries:
                            type: integer
                          retry_after_hours:
                            type: integer
                      question_count:
                        type: integer
                      counts:
                        type: object
                        properties:
                          campaigns:
                            type: integer
                          candidates:
                            type: integer
                          sent:
                            type: integer
                            description: Candidates whose WhatsApp invite went out
                          completed:
                            type: integer
                            description: >-
                              Candidates who finished, including those who
                              declined
                      is_external:
                        type: boolean
                        description: >-
                          true when created through the Partner API, false when
                          made in the Record playground
                      created_at:
                        type: string
                      updated_at:
                        type: string
                      questions:
                        type: array
                        items:
                          type: object
                          properties:
                            question_id:
                              type: string
                            order:
                              type: integer
                            question_text:
                              type: string
                            short_form:
                              type: string
                            type:
                              type: string
                              enum:
                                - yes_no
                                - voice
                            preferred_answer:
                              anyOf:
                                - type: string
                                - type: 'null'
                            required:
                              type: boolean
              example:
                success: true
                data:
                  enrichment_id: WF_EN_261121094822026AEDRUB86TQVSML
                  external_id: enr-chennai-warehouse
                  name: Warehouse talent pool - Chennai
                  description: ''
                  status: active
                  questions_status: ready
                  delivery:
                    whatsapp: true
                    voice_call: true
                    sms: true
                  schedule:
                    language: english
                    start_time: '10:00'
                    end_time: '18:00'
                    days:
                      - mon
                      - tue
                      - wed
                      - thu
                      - fri
                      - sat
                    timezone: Asia/Kolkata
                    max_retries: 3
                    retry_after_hours: 4
                  question_count: 2
                  counts:
                    campaigns: 0
                    candidates: 0
                    sent: 0
                    completed: 0
                  is_external: true
                  created_at: '2026-11-10T10:15:30.000Z'
                  updated_at: '2026-11-10T10:15:30.000Z'
                  questions:
                    - question_id: eqq_cc9800817588972e
                      order: 0
                      question_text: Are you open to a new job right now?
                      short_form: Open to work
                      type: yes_no
                      preferred_answer: 'yes'
                      required: true
                    - question_id: eqq_7a31f0c2d95b84e6
                      order: 1
                      question_text: >-
                        Tell us about the work you do and where you want to
                        work.
                      short_form: Work and location
                      type: voice
                      preferred_answer: null
                      required: true
        '404':
          description: '`NOT_FOUND`: No such enrichment in your organisation and mode.'
          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"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichments/WF_EN_261121094822026AEDRUB86TQVSML")

            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.