Skip to main content
GET
/
providers
List Providers
curl --request GET \
  --url https://api.example.com/providers \
  --header 'Authorization: Bearer <token>'
{
  "providers": [
    {
      "id": "kSuB9Gf6aD4",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "version": 123,
      "apiType": "REST",
      "visibilityType": "PUBLIC",
      "baseURL": "<string>",
      "documentURL": "<string>",
      "iconURL": "<string>",
      "secretPrefix": "<string>",
      "name": "<string>",
      "description": "<string>",
      "tools": [
        {
          "id": "kSuB9Gf6aD4",
          "providerID": "kSuB9Gf6aD4",
          "method": "GET",
          "path": "/users/{id}",
          "name": "makePayment",
          "title": "Make Payment",
          "description": "<string>",
          "pathArgsJSONSchema": {},
          "queryArgsJSONSchema": {},
          "reqBodyJSONSchema": {},
          "headers": [
            {
              "key": "<string>",
              "value": "<string>"
            }
          ],
          "oauth2Scopes": [
            "<string>"
          ]
        }
      ],
      "oauth2Config": {
        "clientID": "<string>",
        "clientSecret": "<string>",
        "authURL": "<string>",
        "tokenURL": "<string>"
      }
    }
  ],
  "matchCount": 123,
  "nextToken": "<string>"
}

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Query Parameters

nameContains
string
baseURLContains
string
apiType
string
visibility
string
limit
integer
token
string

Response

200 - application/json

A list of providers

providers
object[]
matchCount
integer
nextToken
string