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

# List OAuth Providers

> Return every social-login provider this build knows about and whether each is enabled.

Returns every social-login provider the API understands with an `enabled`
flag. A provider is enabled only when both its client id and client secret are
configured on the server (`GOOGLE_CLIENT_ID`/`GOOGLE_CLIENT_SECRET`,
`GITHUB_CLIENT_ID`/`GITHUB_CLIENT_SECRET`). The dashboard calls this on the
login page to decide which social buttons to show; to begin a login, send the
browser to [`GET /auth/oauth/{provider}/start`](/api-reference/auth/oauth-start).

This endpoint is public and takes no authentication.

## Example Request

```bash theme={null}
curl https://api.recurso.dev/auth/oauth/providers
```

## Example Response

```json theme={null}
{
  "providers": [
    { "name": "google", "enabled": true },
    { "name": "github", "enabled": false }
  ]
}
```

## Fields

| Field                 | Type    | Description                                                                                                                                 |
| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `providers`           | array   | One entry per known provider, in a stable order (`google`, then `github`).                                                                  |
| `providers[].name`    | string  | Provider identifier — `google` or `github`. Use it as the `{provider}` path segment on the start endpoint.                                  |
| `providers[].enabled` | boolean | `true` when the provider's client id and secret are both configured. Disabled providers return `404` from the start and callback endpoints. |

<Note>
  The response is not wrapped in a `data` envelope — `providers` is the top-level
  key.
</Note>


## OpenAPI

````yaml GET /auth/oauth/providers
openapi: 3.1.0
info:
  title: Recurso API
  version: 1.0.0
  description: |
    The Recurso billing engine REST API.

    Authenticate by passing your API key as a bearer token:

        Authorization: Bearer <api_key>

    Obtain an API key by registering a tenant via `POST /auth/register`.
    All authenticated endpoints live under the `/v1` prefix. Mutating
    endpoints support idempotency via the `Idempotency-Key` header.
  license:
    name: MIT
    identifier: MIT
servers:
  - url: https://billing.example.com
    description: >-
      Example deployment — substitute the base URL of your own Recurso
      deployment.
security:
  - bearerAuth: []
tags:
  - name: System
    description: Health, version, and API metadata
  - name: Auth
    description: Tenant registration
  - name: Plans
    description: Product catalog plans
  - name: Customers
    description: Customer management
  - name: Subscriptions
    description: Subscription lifecycle
  - name: Invoices
    description: Invoices, PDFs, and Indian GST e-invoicing
  - name: Coupons
    description: Discounts
  - name: Usage
    description: Metered usage events
  - name: Credit Notes
    description: Customer credits
  - name: Quotes
    description: Quote-to-invoice lifecycle
  - name: Webhooks
    description: Webhook endpoint management and event feed
  - name: Analytics
    description: Revenue analytics
  - name: Checkout
    description: Public hosted checkout for invoices
  - name: Payments
    description: Payment order creation
  - name: Inbound Webhooks
    description: Receivers for payment-gateway callbacks (Razorpay, Stripe)
  - name: Customer Portal
    description: Customer-facing portal — magic-link auth and session-scoped data
  - name: Developer
    description: API key management
  - name: Account
    description: Tenant account settings
  - name: Finance
    description: Ledger accounts, entries, reconciliation, and revenue recognition
  - name: Settings
    description: Tax (GST) and e-invoicing (IRP) configuration
  - name: Consents
    description: Consent records for RBI-compliant recurring billing
  - name: Referrals
    description: Customer referral program
  - name: Gifts
    description: Gift subscriptions
  - name: Mandates
    description: UPI Autopay mandates
  - name: Offline Payments
    description: Virtual accounts and manually recorded payments
  - name: Organizations
    description: Multi-entity organizations grouping several tenants
  - name: Accounting
    description: QuickBooks / Xero accounting integrations
  - name: Churn
    description: Churn risk scoring and alerts
  - name: Cancel Flows
    description: Configurable retention flows shown at cancellation time
  - name: Dunning
    description: Dunning analytics and multi-channel dunning campaigns
paths:
  /auth/oauth/providers:
    get:
      tags:
        - Auth
      summary: List social-login providers and whether each is enabled
      description: >
        Returns every provider this build understands with an `enabled` flag. A
        provider is enabled only when its client id AND secret env vars are set
        (GOOGLE_CLIENT_ID/GOOGLE_CLIENT_SECRET,
        GITHUB_CLIENT_ID/GITHUB_CLIENT_SECRET). The dashboard uses this to
        show/hide the social buttons.
      operationId: listOAuthProviders
      responses:
        '200':
          description: Provider list.
          content:
            application/json:
              schema:
                type: object
                properties:
                  providers:
                    type: array
                    items:
                      $ref: '#/components/schemas/OAuthProviderStatus'
      security: []
components:
  schemas:
    OAuthProviderStatus:
      type: object
      properties:
        name:
          type: string
          enum:
            - google
            - github
        enabled:
          type: boolean
      required:
        - name
        - enabled
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API key
      description: >-
        Tenant API key obtained from `POST /auth/register` or `POST
        /v1/developer/keys`.

````