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

> Each endpoint with its status (`active`, `paused`, `auto_paused`), consecutive failures and last success.

**Scope:** `webhooks:manage`



## OpenAPI

````yaml /blue-collar-api/api-reference/openapi.json get /webhooks/endpoints
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:
  /webhooks/endpoints:
    get:
      tags:
        - Webhooks
      summary: List endpoints
      description: >-
        Each endpoint with its status (`active`, `paused`, `auto_paused`),
        consecutive failures and last success.


        **Scope:** `webhooks:manage`
      operationId: listWebhookEndpoints
      parameters: []
      responses:
        '200':
          description: Your endpoints
          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:
                            endpoint_id:
                              type: string
                            url:
                              type: string
                            description:
                              type: string
                            event_types:
                              type: array
                              items:
                                type: string
                            status:
                              type: string
                              enum:
                                - active
                                - paused
                                - auto_paused
                                - disabled
                              description: >-
                                auto_paused: Record stopped sending after 20
                                failures in a row. Fix the endpoint, then PATCH
                                status active
                            paused_reason:
                              anyOf:
                                - type: string
                                - type: 'null'
                            consecutive_failures:
                              type: integer
                            last_success_at:
                              anyOf:
                                - type: string
                                - type: 'null'
                            last_failure_at:
                              anyOf:
                                - type: string
                                - type: 'null'
                            created_at:
                              type: string
              example:
                success: true
                data:
                  items:
                    - endpoint_id: we_3f9a1c7e5b2d4086a1b3c5d7e9f01234
                      url: https://ats.example.com/hooks/record
                      description: Production ATS
                      event_types:
                        - candidate.result
                      status: active
                      paused_reason: null
                      consecutive_failures: 0
                      last_success_at: '2026-10-05T12:41:12.000Z'
                      last_failure_at: null
                      created_at: '2026-10-01T08:00:00.000Z'
      security:
        - ApiKey: []
          SecretKey: []
      x-codeSamples:
        - lang: bash
          label: cURL
          source: pcall GET "/api/v1/partner/webhooks/endpoints"
        - lang: javascript
          label: JavaScript
          source: |-
            const res = await call("GET", "/api/v1/partner/webhooks/endpoints");
            const { data } = await res.json();
        - lang: python
          label: Python
          source: |-
            res = call("GET", "/api/v1/partner/webhooks/endpoints")
            data = res.json()["data"]
components:
  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.