Skip to main content
GET
/
providers
/
catalog
JavaScript
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);
{
  "paging": {
    "more": true,
    "cursor": "<string>"
  },
  "results": [
    {
      "provider": "<string>",
      "name": "<string>",
      "description": "<string>",
      "channel": "<string>",
      "settings": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

keys
string

Comma-separated provider keys to filter by (e.g. sendgrid,twilio).

name
string

Case-insensitive substring match against the provider display name.

channel
string

Exact match (case-insensitive) against the provider channel taxonomy (e.g. email, sms, push).

Response

200 - application/json

Paginated list of available provider types with their configuration schemas.

paging
Paging · object
required
results
ProvidersCatalogEntry · object[]
required