> ## Documentation Index
> Fetch the complete documentation index at: https://openapi.webhookx.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List endpoints



## OpenAPI

````yaml https://raw.githubusercontent.com/webhookx-io/webhookx/refs/tags/v1.2.0/openapi.yml get /workspaces/{ws_id}/endpoints
openapi: 3.0.3
info:
  title: WebhookX Admin API
  contact:
    name: WebhookX
    url: https://github.com/webhookx-io/webhookx
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0.html
  version: 1.2.0
servers:
  - url: http://localhost:9601
security: []
paths:
  /workspaces/{ws_id}/endpoints:
    parameters:
      - $ref: '#/components/parameters/workspace_id'
    get:
      tags:
        - Endpoint
      summary: List endpoints
      parameters:
        - $ref: '#/components/parameters/page_no'
        - $ref: '#/components/parameters/page_size'
        - $ref: '#/components/parameters/limit'
        - $ref: '#/components/parameters/sort'
        - $ref: '#/components/parameters/after'
        - $ref: '#/components/parameters/before'
        - $ref: '#/components/parameters/name'
        - $ref: '#/components/parameters/enabled'
        - $ref: '#/components/parameters/created_at'
        - $ref: '#/components/parameters/metadata'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                oneOf:
                  - allOf:
                      - $ref: '#/components/schemas/OffsetPagination'
                      - type: object
                        properties:
                          data:
                            type: array
                            items:
                              $ref: '#/components/schemas/Endpoint'
                  - allOf:
                      - $ref: '#/components/schemas/CursorPagination'
                      - type: object
                        properties:
                          data:
                            type: array
                            items:
                              $ref: '#/components/schemas/Endpoint'
components:
  parameters:
    workspace_id:
      in: path
      name: ws_id
      required: true
      schema:
        type: string
        example: default
      description: The workspace id
    page_no:
      deprecated: true
      in: query
      name: page_no
      schema:
        type: integer
        default: 1
        minimum: 1
    page_size:
      deprecated: true
      in: query
      name: page_size
      schema:
        type: integer
        default: 20
        maximum: 1000
        minimum: 1
    limit:
      description: >-
        A limit on the number of objects to be returned. Limit can range between
        1 and 1000, and the default is 20.
      in: query
      name: limit
      schema:
        type: integer
        default: 20
        maximum: 1000
        minimum: 1
    sort:
      description: Only id.asc and id.desc are supported.
      in: query
      name: sort
      schema:
        type: string
        enum:
          - id.desc
          - id.asc
        default: id.desc
    after:
      description: A cursor for use in pagination.
      in: query
      name: after
      schema:
        type: string
    before:
      description: A cursor for use in pagination.
      in: query
      name: before
      schema:
        type: string
    name:
      description: name filter
      in: query
      name: name
      schema:
        type: string
    enabled:
      description: enabled filter
      in: query
      name: enabled
      schema:
        type: boolean
    created_at:
      description: created_at filter (unix time in milliseconds).
      in: query
      name: created_at
      explode: true
      style: deepObject
      schema:
        anyOf:
          - type: object
            properties:
              gt:
                type: integer
                format: int64
              gte:
                type: integer
                format: int64
              lt:
                type: integer
                format: int64
              lte:
                type: integer
                format: int64
          - type: integer
            format: int64
    metadata:
      description: ''
      in: query
      name: metadata
      explode: true
      style: deepObject
      schema:
        type: object
        additionalProperties:
          type: string
      example:
        key: value
  schemas:
    OffsetPagination:
      type: object
      properties:
        total:
          description: Total number of resources.
          type: integer
          example: 1
        data:
          description: List of resources
          type: array
          items:
            type: object
    Endpoint:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          nullable: true
        description:
          type: string
          nullable: true
        enabled:
          type: boolean
          default: true
        request:
          type: object
          default:
            method: POST
            headers: null
            timeout: 10000
          properties:
            url:
              type: string
              minLength: 1
              example: https://example.com
            method:
              type: string
              enum:
                - GET
                - POST
                - PUT
                - DELETE
                - PATCH
              default: POST
            headers:
              type: object
              nullable: true
              additionalProperties:
                type: string
              default: null
            timeout:
              type: integer
              minimum: 0
              maximum: 60000
              default: 10000
          required:
            - url
        retry:
          type: object
          default:
            strategy: fixed
            config:
              attempts:
                - 0
                - 60
                - 3600
          properties:
            strategy:
              type: string
              enum:
                - fixed
              default: fixed
            config:
              type: object
              default:
                attempts:
                  - 0
                  - 60
                  - 3600
              properties:
                attempts:
                  type: array
                  minItems: 1
                  items:
                    type: integer
                    minimum: 0
                  default:
                    - 0
                    - 60
                    - 3600
        events:
          type: array
          items:
            type: string
            example: foo.bar
          default: []
        metadata:
          $ref: '#/components/schemas/Metadata'
        rate_limit:
          $ref: '#/components/schemas/RateLimit'
        created_at:
          type: integer
          readOnly: true
        updated_at:
          type: integer
          readOnly: true
    CursorPagination:
      type: object
      properties:
        next:
          description: URI to next page when available.
          type: string
          nullable: true
        prev:
          description: URI to previous page when available.
          type: string
          nullable: true
        data:
          description: List of resources
          type: array
          items:
            type: object
    Metadata:
      type: object
      additionalProperties:
        type: string
      default: {}
    RateLimit:
      type: object
      nullable: true
      description: >-
        The rate limit that uses GCRA algorithm (a variant of the leaky bucket
        algorithm that supports bursts).
      properties:
        quota:
          type: integer
          minimum: 0
          description: Rate limiting quota that allowed in every period.
        period:
          type: integer
          minimum: 1
          description: Rate limiting period in seconds.
      required:
        - quota
        - period

````