> ## Documentation Index
> Fetch the complete documentation index at: https://docs.staging.cope-demo.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List webhook endpoints



## OpenAPI

````yaml /api-reference/account-platform-webhooks-v1.openapi.json get /v1/webhooks/endpoints
openapi: 3.1.0
info:
  title: COPE Public API
  version: 1.0.0
servers:
  - url: https://api.cope.com
security: []
paths:
  /v1/webhooks/endpoints:
    get:
      summary: List webhook endpoints
      operationId: webhooks.endpoints.list
      parameters:
        - in: query
          name: limit
          required: false
          schema:
            default: 25
            maximum: 100
            minimum: 1
            type: integer
        - in: query
          name: cursor
          required: false
          schema:
            minLength: 1
            type: string
        - explode: true
          in: query
          name: event_type
          required: false
          schema:
            items:
              type: string
            type: array
          style: form
        - in: query
          name: status
          required: false
          schema:
            enum:
              - active
              - inactive
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebhookEndpointListResponse'
          description: Webhook resource list
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Unauthorized
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: Forbidden
        '422':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/Problem'
          description: >-
            `validation_failed`: a query parameter is invalid; `errors[].param`
            names it.
      security:
        - bearerAuth: []
components:
  schemas:
    WebhookEndpointListResponse:
      properties:
        data:
          items:
            $ref: '#/components/schemas/WebhookEndpoint'
          type: array
        page:
          $ref: '#/components/schemas/Page'
      required:
        - data
        - page
      type: object
    Problem:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          type: string
        errors:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              detail:
                type: string
              param:
                description: >-
                  The request field refused; absent when the refusal is about
                  the request as a whole.
                type: string
            required:
              - code
              - detail
            type: object
          type: array
        request_id:
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          format: uri
          type: string
      required:
        - type
        - title
        - status
        - code
        - errors
      type: object
    WebhookEndpoint:
      properties:
        active:
          type: boolean
        created_at:
          format: date-time
          type: string
        description:
          type:
            - string
            - 'null'
        disabled_reason:
          type:
            - string
            - 'null'
        event_types:
          items:
            type: string
          type: array
        id:
          pattern: ^whs_[A-Za-z0-9_-]+$
          type: string
        notification_email:
          format: email
          type: string
        updated_at:
          format: date-time
          type: string
        url:
          format: uri
          type: string
      required:
        - id
        - url
        - active
        - notification_email
        - event_types
        - created_at
        - updated_at
      type: object
    Page:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.