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

# List providers

> Beta route. This endpoint is backed either by the in-process mock provider-network adapter or by a hybrid adapter that reads provider inventory from the core partner API while retaining Onstacks-local beta plumbing for unsupported objects. Inspect `X-Onstacks-Provider-Network-Mode` to determine the active backing mode.



## OpenAPI

````yaml /openapi.yaml get /v1/providers
openapi: 3.1.0
info:
  title: Onstacks Backend API
  version: 0.1.0
  summary: >-
    Public API contract for workspace wallet, transfer, provider routing, API
    key, and webhook flows.
servers:
  - url: https://api.onstacks.io
security: []
tags:
  - name: Health
  - name: Workspace
  - name: Wallets
  - name: Transfers
  - name: Corridors
  - name: Providers
  - name: Quotes
paths:
  /v1/providers:
    get:
      tags:
        - Providers
      summary: List providers
      description: >-
        Beta route. This endpoint is backed either by the in-process mock
        provider-network adapter or by a hybrid adapter that reads provider
        inventory from the core partner API while retaining Onstacks-local beta
        plumbing for unsupported objects. Inspect
        `X-Onstacks-Provider-Network-Mode` to determine the active backing mode.
      parameters:
        - $ref: '#/components/parameters/EnvironmentQuery'
        - in: query
          name: corridor_id
          schema:
            type: string
            format: uuid
        - in: query
          name: destination_country
          schema:
            type: string
        - in: query
          name: destination_currency
          schema:
            type: string
        - in: query
          name: status
          schema:
            type: string
      responses:
        '200':
          description: Provider list
          headers:
            X-Onstacks-Provider-Network-Mode:
              $ref: '#/components/headers/ProviderNetworkMode'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProviderListResponse'
        '400':
          $ref: '#/components/responses/ValidationError'
        '401':
          $ref: '#/components/responses/Unauthorized'
      security:
        - apiKeyBearer: []
components:
  parameters:
    EnvironmentQuery:
      in: query
      name: environment
      description: >-
        Environment scope for environment-partitioned resources. Defaults to
        `sandbox` when omitted.
      required: false
      schema:
        $ref: '#/components/schemas/EnvironmentScope'
  headers:
    ProviderNetworkMode:
      description: >-
        Indicates the current backing adapter for provider-network routes.
        `mock` means the response is backed by non-production mock data and
        process-local quote state. `hybrid` means providers and quote execution
        are backed by the core provider API while corridor coverage and
        quote-request persistence still use Onstacks-local beta plumbing.
      schema:
        type: string
        enum:
          - mock
          - hybrid
          - core
  schemas:
    ProviderListResponse:
      type: object
      required:
        - data
        - error
        - request_id
      properties:
        data:
          type: object
          required:
            - items
          properties:
            items:
              type: array
              items:
                $ref: '#/components/schemas/Provider'
        error:
          type: 'null'
        request_id:
          type: string
    EnvironmentScope:
      type: string
      enum:
        - sandbox
        - live
      default: sandbox
    Provider:
      type: object
      required:
        - id
        - environment
        - code
        - name
        - status
        - supported_payout_methods
        - supports_auto_routing
      properties:
        id:
          type: string
          description: Opaque provider identifier from the provider registry
        environment:
          $ref: '#/components/schemas/EnvironmentScope'
        code:
          type: string
        name:
          type: string
        status:
          type: string
          enum:
            - active
            - inactive
            - degraded
            - unavailable
            - disabled
            - unknown
        provider_type:
          type: string
          description: Normalized provider category from the upstream provider registry
        supports_auto_routing:
          type: boolean
        reliability_score:
          type: number
          format: float
        speed_profile:
          type: string
        supported_payout_methods:
          type: array
          items:
            type: string
        supported_corridor_ids:
          type: array
          items:
            type: string
            format: uuid
        metadata:
          type: object
          additionalProperties: true
    ErrorEnvelope:
      type: object
      required:
        - data
        - error
        - request_id
      properties:
        data:
          type: 'null'
        error:
          $ref: '#/components/schemas/ApiError'
        request_id:
          type: string
    ApiError:
      type: object
      required:
        - code
        - message
      properties:
        code:
          type: string
        message:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    ValidationError:
      description: Request payload is invalid
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
    Unauthorized:
      description: Caller is not authenticated
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorEnvelope'
  securitySchemes:
    apiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: 'Workspace API key. Send it as `Authorization: Bearer <api_key>`.'

````