Skip to main content
GET
/
providers
/
{provider}
Get provider
curl --request GET \
  --url https://api.withampersand.com/v1/providers/{provider}
{
  "name": "<string>",
  "authType": "oauth2",
  "baseURL": "<string>",
  "defaultModule": "<string>",
  "support": {
    "bulkWrite": {
      "insert": true,
      "update": true,
      "upsert": true,
      "delete": true
    },
    "proxy": true,
    "read": true,
    "subscribe": true,
    "write": true,
    "delete": true,
    "search": {
      "operators": {
        "equals": true
      }
    },
    "subscribeSupport": {
      "create": true,
      "update": true,
      "delete": true,
      "passThrough": true
    }
  },
  "providerOpts": {},
  "basicOpts": {
    "apiKeyAsBasic": true,
    "apiKeyAsBasicOpts": {
      "fieldUsed": "username",
      "keyFormat": "api:%s"
    },
    "docsURL": "https://docs.example.com/api-key"
  },
  "customOpts": {
    "headers": [
      {
        "name": "X-Custom-Auth",
        "valueTemplate": "Bearer {{ .token }}"
      }
    ],
    "queryParams": [
      {
        "name": "custom_auth",
        "valueTemplate": "{{ .token }}"
      }
    ],
    "inputs": [
      {
        "name": "custom_auth_input",
        "displayName": "Custom Auth Input",
        "prompt": "See Authorization section of provider docs to obtain this value",
        "docsURL": "https://docs.example.com/custom-auth-input"
      }
    ]
  },
  "displayName": "Zendesk Chat",
  "postAuthInfoNeeded": true,
  "media": {
    "regular": {
      "iconURL": "https://example.com/icon.png",
      "logoURL": "https://example.com/logo.png"
    },
    "darkMode": {
      "iconURL": "https://example.com/icon.png",
      "logoURL": "https://example.com/logo.png"
    }
  },
  "labels": {},
  "modules": {},
  "metadata": {
    "input": [
      {
        "name": "<string>",
        "displayName": "<string>",
        "prompt": "<string>",
        "defaultValue": "<string>",
        "docsURL": "https://example.com/how-to-find-subdomain",
        "moduleDependencies": {}
      }
    ],
    "postAuthentication": [
      {
        "name": "<string>",
        "moduleDependencies": {}
      }
    ]
  }
}

Path Parameters

​
provider
string
required

The provider name (e.g. salesforce, hubspot).

Response

The requested provider.

​
name
string
required
​
authType
enum<string>
required

The type of authentication required by the provider.

Available options:
oauth2,
apiKey,
basic,
jwt,
custom,
none
​
baseURL
string
required

The base URL for making API requests.

​
defaultModule
string
required
​
support
Support · object
required

The supported features for the provider.

​
providerOpts
Provider Options · object
required

Additional provider-specific metadata.

​
oauth2Opts
OAuth2 Options · object

Configuration for OAuth2.0. Must be provided if authType is oauth2.

​
apiKeyOpts
API Key Options · object

Configuration for API key. Must be provided if authType is apiKey.

​
basicOpts
Basic Auth Options · object

Configuration for Basic Auth. Optional.

​
customOpts
Custom Auth Options · object

Configuration for custom auth. Optional.

​
authHealthCheck
Auth Health Check · object

A URL to check the health of a provider's credentials. It's used to see if the credentials are valid and if the provider is reachable.

​
displayName
string

The display name of the provider, if omitted, defaults to provider name.

Example:

"Zendesk Chat"

​
postAuthInfoNeeded
boolean

If true, we require additional information after auth to start making requests.

Example:

true

​
media
Media · object
​
labels
Labels · object
​
subscribeOpts
Subscribe Options · object
​
modules
Modules that this provider supports · object

The registry of provider modules.

​
metadata
Provider Metadata · object

Provider metadata that needs to be given by the user or fetched by the connector post authentication for the connector to work.