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

# Where your enrichment credits were used

> One row for every candidate added to an enrichment campaign, newest first, in the wallet of the key you signed with. `credits` is negative when credits were spent and positive when they were given back. `summary.net_credits` adds up every row that matches your filters, not only the page you are on. An id from another organisation returns an empty list. This call changes nothing.

**Scope:** `enrichment:credits`



## OpenAPI

````yaml /enrichment-api/api-reference/openapi.json get /enrichment-credits/usage
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:
  /enrichment-credits/usage:
    get:
      tags:
        - Enrichment credits
      summary: Where your enrichment credits were used
      description: >-
        One row for every candidate added to an enrichment campaign, newest
        first, in the wallet of the key you signed with. `credits` is negative
        when credits were spent and positive when they were given back.
        `summary.net_credits` adds up every row that matches your filters, not
        only the page you are on. An id from another organisation returns an
        empty list. This call changes nothing.


        **Scope:** `enrichment:credits`
      operationId: listEnrichmentCreditUsage
      parameters:
        - name: enrichment_id
          in: query
          required: false
          description: Only credits spent in this enrichment
          schema:
            type: string
            minLength: 1
            maxLength: 100
          example: WF_EN_261121094822026AEDRUB86TQVSML
        - name: campaign_id
          in: query
          required: false
          description: Only credits spent in this campaign
          schema:
            type: string
            minLength: 1
            maxLength: 100
          example: EC_261121095438377TFUX07WN2XT42V
        - name: candidate_id
          in: query
          required: false
          description: Only credits spent on this candidate
          schema:
            type: string
            minLength: 1
            maxLength: 100
        - name: from
          in: query
          required: false
          description: Only rows from this moment on (included)
          schema:
            type: string
            format: date-time
          example: '2026-11-01T00:00:00.000Z'
        - name: to
          in: query
          required: false
          description: Only rows before this moment (not included)
          schema:
            type: string
            format: date-time
        - 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, with the net of everything that matches
          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:
                            usage_id:
                              type: string
                              description: Stable id of this row
                            type:
                              type: string
                              description: >-
                                debit when a candidate was added, refund or
                                adjustment for a correction
                            description:
                              type: string
                              description: What the credits were spent on
                            credits:
                              type: number
                              description: >-
                                Credits moved: negative when spent, positive
                                when given back
                            quantity:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Candidates this row covers
                            unit_price:
                              anyOf:
                                - type: number
                                - type: 'null'
                              description: Price per candidate at that time
                            balance_after:
                              type: number
                              description: The wallet's balance right after this row
                            enrichment_id:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: The enrichment the candidate belongs to
                            campaign_id:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: The campaign the candidate was added to
                            candidate_id:
                              anyOf:
                                - type: string
                                - type: 'null'
                              description: The candidate the credits were spent on
                            mode:
                              type: string
                              enum:
                                - live
                                - test
                              description: The wallet that was charged
                            created_at:
                              type: string
                              description: When the row was written
                            effective_at:
                              type: string
                              description: When the charge applies
                      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)
                      summary:
                        type: object
                        properties:
                          net_credits:
                            type: number
                            description: >-
                              The sum of `credits` over every row that matches
                              your filters, not only this page
              example:
                success: true
                data:
                  items:
                    - usage_id: LGR_0f1c2d3e4a5b6c7d
                      type: debit
                      description: Enrichment assigned
                      credits: -8
                      quantity: 1
                      unit_price: 8
                      balance_after: 492
                      enrichment_id: WF_EN_261121094822026AEDRUB86TQVSML
                      campaign_id: EC_261121095438377TFUX07WN2XT42V
                      candidate_id: 6f1d2c3e-8a4b-4c57-9d10-2b7e5a9c1f33
                      mode: live
                      created_at: '2026-11-10T11:00:30.000Z'
                      effective_at: '2026-11-10T11:00:30.000Z'
                  count: 1
                  total: 1
                  next_cursor: null
                  has_more: false
                  summary:
                    net_credits: -8
        '400':
          description: '`VALIDATION_FAILED`: Bad `from`, `to` 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/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25"
        - lang: javascript
          label: JavaScript
          source: >-
            const res = await call("GET",
            "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&limit=25");

            const { data } = await res.json();
        - lang: python
          label: Python
          source: >-
            res = call("GET",
            "/api/v1/partner/enrichment-credits/usage?enrichment_id=WF_EN_261121094822026AEDRUB86TQVSML&campaign_id=EC_261121095438377TFUX07WN2XT42V&from=2026-11-01T00%3A00%3A00.000Z&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.