List providers

Returns all supported SaaS providers and their capabilities. The response is a JSON object keyed by provider name (e.g. salesforce, hubspot). Each value describes the provider’s authentication type, supported operations, modules, and configuration options. No authentication is required.

GET /providers

List providers

cURL

curl --request GET \
  --url https://api.withampersand.com/v1/providers

import requests

url = "https://api.withampersand.com/v1/providers"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.withampersand.com/v1/providers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/providers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/providers"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.withampersand.com/v1/providers")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/providers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "salesforce": {
    "name": "salesforce",
    "displayName": "Salesforce",
    "authType": "oauth2",
    "baseURL": "https://{{.workspace}}.my.salesforce.com",
    "defaultModule": "crm",
    "support": {
      "read": true,
      "write": true,
      "delete": true,
      "subscribe": true,
      "proxy": true,
      "bulkWrite": {
        "insert": true,
        "update": true,
        "upsert": true,
        "delete": true
      },
      "search": {
        "operators": {
          "equals": true
        }
      }
    },
    "providerOpts": {}
  },
  "hubspot": {
    "name": "hubspot",
    "displayName": "HubSpot",
    "authType": "oauth2",
    "baseURL": "https://api.hubapi.com",
    "defaultModule": "",
    "support": {
      "read": true,
      "write": true,
      "delete": true,
      "subscribe": true,
      "proxy": true,
      "bulkWrite": {
        "insert": false,
        "update": false,
        "upsert": false,
        "delete": false
      },
      "search": {
        "operators": {
          "equals": true
        }
      }
    },
    "providerOpts": {}
  }
}

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Response

200

application/json

All available providers and their capabilities.

{key} · Provider Info · object

Show child attributes