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

> List your organisation's enrichments, made here or on the Enrichment page of the playground (`is_external` says which), newest first.

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



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichments
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:
    get:
      tags:
        - Enrichments
      summary: List enrichments
      description: >-
        List your organisation's enrichments, made here or on the Enrichment
        page of the playground (`is_external` says which), newest first.


        **Scope:** `enrichment:read` or `enrichment:write` or
        `enrichment:campaigns`
      operationId: listEnrichments
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - active
              - archived
            default: active
          example: active
        - name: search
          in: query
          required: false
          description: Part of the name or the enrichment_id
          schema:
            type: string
            maxLength: 200
        - name: language
          in: query
          required: false
          description: Only enrichments with a campaign in this language
          schema:
            type: string
            enum:
              - english
              - tamil
              - hindi
              - kannada
              - telugu
              - malayalam
              - bengali
              - marathi
        - 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, newest 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:
                            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
                      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:
                    - enrichment_id: WF_EN_261121094822026AEDRUB86TQVSML
                      external_id: enr-chennai-warehouse
                      name: Warehouse talent pool - Chennai
                      description: ''
                      status: active
                      questions_status: pending
                      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'
                  count: 1
                  total: 1
                  next_cursor: null
                  has_more: false
        '400':
          description: '`VALIDATION_FAILED`: Bad `status`, `language` or `cursor`.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: pcall GET "/api/v1/partner/enrichments?status=active&limit=25"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichments?status=active&limit=25");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichments?status=active&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.