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

# List available provider types

> Returns the catalog of available provider types with their display names, descriptions, and configuration schema fields (snake_case, with `type` and `required`). Providers with no configurable schema return only `provider`, `name`, and `description`.



## OpenAPI

````yaml /openapi-specs/openapi.documented.yml get /providers/catalog
openapi: 3.0.1
info:
  title: Courier
  description: The Courier REST API for sending and managing notifications across channels.
  version: 0.0.1
servers:
  - url: https://api.courier.com
    description: Production
security: []
paths:
  /providers/catalog:
    get:
      tags:
        - Providers
      summary: List available provider types
      description: >-
        Returns the catalog of available provider types with their display
        names, descriptions, and configuration schema fields (snake_case, with
        `type` and `required`). Providers with no configurable schema return
        only `provider`, `name`, and `description`.
      operationId: providers_catalog
      parameters:
        - name: keys
          in: query
          description: Comma-separated provider keys to filter by (e.g. `sendgrid,twilio`).
          required: false
          schema:
            type: string
        - name: name
          in: query
          description: Case-insensitive substring match against the provider display name.
          required: false
          schema:
            type: string
        - name: channel
          in: query
          description: >-
            Exact match (case-insensitive) against the provider channel taxonomy
            (e.g. `email`, `sms`, `push`).
          required: false
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ProvidersCatalogResponse'
              examples:
                Example:
                  value:
                    paging:
                      cursor: MTpFWUNFRkRRN0c1WERTRTU2
                      more: true
                    results:
                      - provider: string
                        name: Example Name
                        description: An example description.
                        channel: string
                        settings:
                          settings_key:
                            type: string
                            required: true
                            values:
                              - string
      security:
        - BearerAuth: []
      x-codeSamples:
        - lang: JavaScript
          source: |-
            import Courier from '@trycourier/courier';

            const client = new Courier({
              apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted
            });

            const catalogs = await client.providers.catalog.list();

            console.log(catalogs.paging);
        - lang: Python
          source: |-
            import os
            from courier import Courier

            client = Courier(
                api_key=os.environ.get("COURIER_API_KEY"),  # This is the default and can be omitted
            )
            catalogs = client.providers.catalog.list()
            print(catalogs.paging)
        - lang: Go
          source: "package main\n\nimport (\n\t\"context\"\n\t\"fmt\"\n\n\t\"github.com/trycourier/courier-go\"\n\t\"github.com/trycourier/courier-go/option\"\n)\n\nfunc main() {\n\tclient := courier.NewClient(\n\t\toption.WithAPIKey(\"My API Key\"),\n\t)\n\tcatalogs, err := client.Providers.Catalog.List(context.TODO(), courier.ProviderCatalogListParams{})\n\tif err != nil {\n\t\tpanic(err.Error())\n\t}\n\tfmt.Printf(\"%+v\\n\", catalogs.Paging)\n}\n"
        - lang: Java
          source: |-
            package com.courier.example;

            import com.courier.client.CourierClient;
            import com.courier.client.okhttp.CourierOkHttpClient;
            import com.courier.models.providers.catalog.CatalogListParams;
            import com.courier.models.providers.catalog.CatalogListResponse;

            public final class Main {
                private Main() {}

                public static void main(String[] args) {
                    CourierClient client = CourierOkHttpClient.fromEnv();

                    CatalogListResponse catalogs = client.providers().catalog().list();
                }
            }
        - lang: Ruby
          source: |-
            require "courier"

            courier = Courier::Client.new(api_key: "My API Key")

            catalogs = courier.providers.catalog.list

            puts(catalogs)
        - lang: PHP
          source: >-
            <?php


            require_once dirname(__DIR__) . '/vendor/autoload.php';


            use Courier\Client;

            use Courier\Core\Exceptions\APIException;


            $client = new Client(apiKey: getenv('COURIER_API_KEY') ?: 'My API
            Key');


            try {
              $catalogs = $client->providers->catalog->list(
                channel: 'channel', keys: 'keys', name: 'name'
              );

              var_dump($catalogs);
            } catch (APIException $e) {
              echo $e->getMessage();
            }
        - lang: C#
          source: |-
            using System;
            using TryCourier;
            using TryCourier.Models.Providers.Catalog;

            CourierClient client = new();

            CatalogListParams parameters = new();

            var catalogs = await client.Providers.Catalog.List(parameters);

            Console.WriteLine(catalogs);
        - lang: CLI
          source: |-
            courier providers:catalog list \
              --api-key 'My API Key'
components:
  schemas:
    ProvidersCatalogResponse:
      title: ProvidersCatalogResponse
      type: object
      description: >-
        Paginated list of available provider types with their configuration
        schemas.
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/ProvidersCatalogEntry'
      required:
        - paging
        - results
    Paging:
      title: Paging
      type: object
      properties:
        cursor:
          type: string
          nullable: true
        more:
          type: boolean
      required:
        - more
    ProvidersCatalogEntry:
      title: ProvidersCatalogEntry
      type: object
      description: >-
        A provider type from the catalog. Contains the key, display name,
        description, and a `settings` object describing configuration schema
        fields.
      properties:
        provider:
          type: string
          description: The provider key (e.g. "sendgrid", "twilio").
        name:
          type: string
          description: Human-readable display name.
        description:
          type: string
          description: Short description of the provider.
        channel:
          type: string
          description: >-
            Courier taxonomy channel (e.g. email, push, sms, direct_message,
            inbox, webhook).
        settings:
          type: object
          description: >-
            Map of setting field names (snake_case) to their schema descriptors.
            Each descriptor has `type` and `required`. Empty when the provider
            has no configurable schema.
          additionalProperties:
            $ref: '#/components/schemas/ProviderSchemaField'
      required:
        - provider
        - name
        - description
        - channel
        - settings
    ProviderSchemaField:
      title: ProviderSchemaField
      type: object
      description: Describes a single configuration field in the provider catalog.
      properties:
        type:
          type: string
          description: The field's data type (e.g. "string", "boolean", "enum").
        required:
          type: boolean
          description: Whether this field is required when configuring the provider.
        values:
          type: array
          items:
            type: string
          description: Allowed values when `type` is "enum".
      required:
        - type
        - required
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````