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

# List Providers

> Retrieves Providers filtered by category (Email, SMS, or OAuth) with pagination.



## OpenAPI

````yaml /es/openapi/v3-current/AM-identity.yaml get /v1/providers
openapi: 3.0.1
info:
  contact: {}
  description: This is a swagger documentation for the Identity API
  termsOfService: http://swagger.io/terms/
  title: Identity API
  version: 1.0.0
servers:
  - url: //localhost:4001/
security: []
paths:
  /v1/providers:
    get:
      tags:
        - Providers
      summary: List Providers
      description: >-
        Retrieves Providers filtered by category (Email, SMS, or OAuth) with
        pagination.
      parameters:
        - description: Provider category
          in: query
          name: category
          required: true
          schema:
            enum:
              - Email
              - SMS
              - OAuth
            type: string
        - description: Page number
          in: query
          name: page
          schema:
            default: 1
            type: integer
        - description: Items per page
          in: query
          name: limit
          schema:
            default: 10
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/inline_response_200_2'
          description: OK
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Bad Request
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Not Found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pkg.HTTPError'
          description: Internal Server Error
      security:
        - BearerAuth: []
components:
  schemas:
    inline_response_200_2:
      example:
        Pagination:
          total: 10
          limit: 10
          page: 1
          items: '{}'
        items:
          - disableSsl: true
            templateCode: templateCode
            title: title
            type: SendGrid
            content: content
            createdAt: '2021-09-01T00:00:00.000Z'
            intranetEndpoint: intranetEndpoint
            endpoint: endpoint
            appId: appId
            host: host
            customUserInfoUrl: customUserInfoUrl
            id: 00000000-0000-0000-0000-000000000000
            clientId: clientId
            signName: signName
            method: method
            receiver: receiver
            issuerUrl: issuerUrl
            customTokenUrl: customTokenUrl
            clientId2: clientId2
            customAuthUrl: customAuthUrl
            providerUrl: providerUrl
            port: 0
            regionId: regionId
            domain: domain
            name: SMTP Corp
            subType: subType
            scopes: scopes
            category: Email
          - disableSsl: true
            templateCode: templateCode
            title: title
            type: SendGrid
            content: content
            createdAt: '2021-09-01T00:00:00.000Z'
            intranetEndpoint: intranetEndpoint
            endpoint: endpoint
            appId: appId
            host: host
            customUserInfoUrl: customUserInfoUrl
            id: 00000000-0000-0000-0000-000000000000
            clientId: clientId
            signName: signName
            method: method
            receiver: receiver
            issuerUrl: issuerUrl
            customTokenUrl: customTokenUrl
            clientId2: clientId2
            customAuthUrl: customAuthUrl
            providerUrl: providerUrl
            port: 0
            regionId: regionId
            domain: domain
            name: SMTP Corp
            subType: subType
            scopes: scopes
            category: Email
      properties:
        Pagination:
          $ref: '#/components/schemas/Pagination'
        items:
          items:
            $ref: '#/components/schemas/ProviderResponse'
          type: array
      type: object
    pkg.HTTPError:
      properties:
        code:
          type: string
        entityType:
          type: string
        err:
          type: object
        message:
          type: string
        title:
          type: string
      type: object
    Pagination:
      description: >-
        Pagination is the struct designed to store the pagination data of an
        entity list.
      example:
        total: 10
        limit: 10
        page: 1
        items: '{}'
      properties:
        items:
          type: object
        limit:
          example: 10
          type: integer
        page:
          example: 1
          type: integer
        total:
          example: 10
          type: integer
      type: object
    ProviderResponse:
      description: ProviderResponse payload
      example:
        disableSsl: true
        templateCode: templateCode
        title: title
        type: SendGrid
        content: content
        createdAt: '2021-09-01T00:00:00.000Z'
        intranetEndpoint: intranetEndpoint
        endpoint: endpoint
        appId: appId
        host: host
        customUserInfoUrl: customUserInfoUrl
        id: 00000000-0000-0000-0000-000000000000
        clientId: clientId
        signName: signName
        method: method
        receiver: receiver
        issuerUrl: issuerUrl
        customTokenUrl: customTokenUrl
        clientId2: clientId2
        customAuthUrl: customAuthUrl
        providerUrl: providerUrl
        port: 0
        regionId: regionId
        domain: domain
        name: SMTP Corp
        subType: subType
        scopes: scopes
        category: Email
      properties:
        appId:
          type: string
        category:
          example: Email
          type: string
        clientId:
          type: string
        clientId2:
          type: string
        content:
          type: string
        createdAt:
          example: '2021-09-01T00:00:00.000Z'
          type: string
        customAuthUrl:
          type: string
        customTokenUrl:
          type: string
        customUserInfoUrl:
          type: string
        disableSsl:
          type: boolean
        domain:
          type: string
        endpoint:
          type: string
        host:
          type: string
        id:
          example: 00000000-0000-0000-0000-000000000000
          type: string
        intranetEndpoint:
          type: string
        issuerUrl:
          type: string
        method:
          type: string
        name:
          example: SMTP Corp
          type: string
        port:
          type: integer
        providerUrl:
          type: string
        receiver:
          type: string
        regionId:
          type: string
        scopes:
          type: string
        signName:
          type: string
        subType:
          type: string
        templateCode:
          type: string
        title:
          type: string
        type:
          description: >-
            Type is the provider type exactly as stored in Casdoor. SMS
            providers

            created before the canonical "Twilio SMS" was adopted are still
            stored as

            "Twilio", so both values can appear here.
          example: SendGrid
          type: string
      type: object
  securitySchemes:
    BearerAuth:
      description: 'Bearer authentication. Send Authorization: Bearer <token>.'
      in: header
      name: Authorization
      type: apiKey

````