> ## 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

> Use this endpoint to list all communication providers configured in the system.



## OpenAPI

````yaml en/openapi/v3-current/AM-identity.yaml get /v1/providers
openapi: 3.1.0
info:
  title: Identity Plugin
  description: ''
  version: 2.4.5
servers:
  - url: https://identity.sandbox.lerian.net
security: []
tags:
  - name: Groups API
  - name: Applications API
  - name: Users API
  - name: MFA API
  - name: Providers API
  - name: Application Providers API
paths:
  /v1/providers:
    get:
      tags:
        - Providers API
      summary: List Providers
      description: >-
        Use this endpoint to list all communication providers configured in the
        system.
      parameters:
        - $ref: '#/components/parameters/ProviderCategoryQueryParam'
        - $ref: '#/components/parameters/PageQueryParam'
        - $ref: '#/components/parameters/LimitQueryParam'
      responses:
        '200':
          description: The list of all providers configured in the system.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/Pagination'
                  - type: object
                    properties:
                      items:
                        type: array
                        items:
                          $ref: '#/components/schemas/ProviderResponse'
              example:
                items:
                  - id: 019c96a0-1a10-7abc-d1e2-8c9d0e1f2a3b
                    name: sendgrid-primary
                    category: Email
                    type: SendGrid
                    host: smtp.sendgrid.net
                    port: 587
                    disableSsl: false
                    createdAt: '2025-04-08T08:01:30.000Z'
                  - id: 019c96a0-1b20-7bcd-e1f2-9d0e1f2a3b4c
                    name: twilio-sms
                    category: SMS
                    type: Twilio
                    disableSsl: false
                    createdAt: '2025-04-07T18:57:57.312Z'
                page: 1
                limit: 10
                total: 2
          headers: {}
        '404':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error1007:
                  $ref: '#/components/examples/Error1007'
          headers: {}
        '500':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorMessage'
              examples:
                Error0006:
                  $ref: '#/components/examples/Error0006'
          headers: {}
      security:
        - bearer: []
components:
  parameters:
    ProviderCategoryQueryParam:
      name: category
      in: query
      description: Filters providers by communication category.
      required: true
      schema:
        type: string
        enum:
          - Email
          - SMS
    PageQueryParam:
      name: page
      in: query
      description: The page number to retrieve.
      required: false
      schema:
        type: integer
        default: 1
        minimum: 1
    LimitQueryParam:
      name: limit
      in: query
      description: The maximum number of items to return per page. Cannot exceed 100.
      required: false
      schema:
        type: integer
        default: 10
        minimum: 1
        maximum: 100
  schemas:
    Pagination:
      description: Standard paginated response wrapper.
      type: object
      properties:
        items:
          type: array
          description: The list of items returned for the current page.
          items: {}
        page:
          type: integer
          description: The current page number.
          example: 1
        limit:
          type: integer
          description: The maximum number of items returned per page.
          example: 10
        total:
          type: integer
          description: The total number of items available across all pages.
          example: 2
    ProviderResponse:
      description: Information about a communication provider.
      type: object
      properties:
        id:
          type: string
          description: Unique identifier of the provider.
        name:
          type: string
          description: Name of the provider.
        category:
          type: string
          description: Provider category.
          enum:
            - Email
            - SMS
        type:
          type: string
          description: Provider implementation type.
          enum:
            - SendGrid
            - Twilio
        subType:
          type: string
          description: Provider sub-type, if applicable.
        method:
          type: string
          description: Authentication or delivery method.
        clientId:
          type: string
          description: Client ID or API key (secret is never returned).
        clientId2:
          type: string
          description: Secondary client ID, if applicable.
        host:
          type: string
          description: SMTP or API host address.
        port:
          type: integer
          description: SMTP port.
        disableSsl:
          type: boolean
          description: Indicates whether SSL/TLS is disabled.
        title:
          type: string
          description: Default email or SMS title/subject.
        content:
          type: string
          description: Default message content template.
        receiver:
          type: string
          description: Default receiver address for testing.
        regionId:
          type: string
          description: Cloud region ID (provider-specific).
        signName:
          type: string
          description: SMS signature name (provider-specific).
        templateCode:
          type: string
          description: SMS template code (provider-specific).
        appId:
          type: string
          description: Application ID (provider-specific).
        endpoint:
          type: string
          description: Provider API endpoint URL.
        intranetEndpoint:
          type: string
          description: Intranet endpoint for private network access.
        domain:
          type: string
          description: Provider domain.
        providerUrl:
          type: string
          description: Provider-specific URL.
        createdAt:
          type: string
          format: date-time
          description: Timestamp marking when the provider was created.
    ErrorMessage:
      description: The response message error.
      type: object
      properties:
        code:
          type: string
          description: A unique, stable identifier for the error.
        title:
          type: string
          description: A brief summary of the issue.
        message:
          type: string
          description: Detailed guidance for resolving the error.
  examples:
    Error1007:
      summary: Provider Not Found
      value:
        code: IDE-1007
        title: Provider Not Found
        message: The provided provider ID does not exist in our records.
    Error0006:
      summary: Internal Server Error
      value:
        code: IDE-0006
        title: Internal Server Error
        message: The server encountered an unexpected error. Please try again later.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
      description: The authorization token in the 'Bearer <token>' format.

````