Skip to main content
GET
/
providers
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 providers = await client.providers.list();

console.log(providers.paging);
{
  "paging": {
    "cursor": "MTpFWUNFRkRRN0c1WERTRTU2",
    "more": true
  },
  "results": [
    {
      "id": "prov_5e2b2615",
      "title": "Example Name",
      "provider": "string",
      "alias": "string",
      "settings": {},
      "created": 1,
      "updated": 1
    }
  ]
}

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Opaque cursor for fetching the next page.

Response

200 - application/json

Paginated list of provider configurations.

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