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

# Get Providers

> Get providers with their configuration and metadata.

Query params:
- enabled_only: Filter to only enabled providers (default: False, returns all)
- cloud_only: Filter to only providers with cloud OAuth API (default: False)

Returns full provider details including name, icon_url, has_cloud_api, is_enabled.



## OpenAPI

````yaml https://api.openwearables.io/openapi.json get /api/v1/oauth/providers
openapi: 3.1.0
info:
  title: Open Wearables API
  version: 0.1.0
servers: []
security: []
paths:
  /api/v1/oauth/providers:
    get:
      tags:
        - 'External: Providers'
      summary: Get Providers
      description: >-
        Get providers with their configuration and metadata.


        Query params:

        - enabled_only: Filter to only enabled providers (default: False,
        returns all)

        - cloud_only: Filter to only providers with cloud OAuth API (default:
        False)


        Returns full provider details including name, icon_url, has_cloud_api,
        is_enabled.
      operationId: get_providers_api_v1_oauth_providers_get
      parameters:
        - name: enabled_only
          in: query
          required: false
          schema:
            type: boolean
            description: Return only enabled providers
            default: false
            title: Enabled Only
          description: Return only enabled providers
        - name: cloud_only
          in: query
          required: false
          schema:
            type: boolean
            description: Return only cloud (OAuth) providers
            default: false
            title: Cloud Only
          description: Return only cloud (OAuth) providers
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProviderSettingRead'
                title: Response Get Providers Api V1 Oauth Providers Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ProviderSettingRead:
      properties:
        provider:
          type: string
          title: Provider
          description: Provider identifier (e.g., 'apple', 'garmin')
        name:
          type: string
          title: Name
          description: Display name (e.g., 'Apple Health', 'Garmin')
        has_cloud_api:
          type: boolean
          title: Has Cloud Api
          description: Whether provider uses cloud OAuth API
        is_enabled:
          type: boolean
          title: Is Enabled
          description: Whether provider is enabled by admin
        icon_url:
          type: string
          title: Icon Url
          description: >-
            Relative URL to provider icon (e.g.,
            '/static/provider-icons/garmin.svg'). Resolve against the API base
            URL.
        live_sync_mode:
          anyOf:
            - $ref: '#/components/schemas/LiveSyncMode'
            - type: 'null'
          description: >-
            Current live sync mode ('pull' or 'webhook'). Null for SDK-only
            providers.
        live_sync_configurable:
          type: boolean
          title: Live Sync Configurable
          description: Whether the admin can switch live_sync_mode for this provider.
          default: false
      type: object
      required:
        - provider
        - name
        - has_cloud_api
        - is_enabled
        - icon_url
      title: ProviderSettingRead
      description: Provider setting with metadata.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    LiveSyncMode:
      type: string
      enum:
        - pull
        - webhook
      title: LiveSyncMode
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError

````