Provider
Get provider
Authentication
WRITE API
- Write
READ API
- Read
PLATFORM API
- OAuth
- Project
- Provider App
- Integration
- Revision
- Installation
- Objects & Fields
- Operation
- Provider
- API Key
- Connection
- Group
- Consumer
- Destination
- Upload URL
- Org
- User
- Billing Account
Provider
Get provider
GET
/
providers
/
{provider}
curl --request GET \
--url https://api.withampersand.com/v1/providers/{provider} \
--header 'X-Api-Key: <api-key>'
{
"name": "<string>",
"authType": "oauth2",
"baseURL": "<string>",
"oauth2Opts": {
"grantType": "authorizationCode",
"authURL": "https://login.salesforce.com/services/oauth2/authorize",
"tokenURL": "https://login.salesforce.com/services/oauth2/token",
"explicitScopesRequired": true,
"explicitWorkspaceRequired": true,
"audience": [
"https://api.mparticle.com"
],
"tokenMetadataFields": {
"workspaceRefField": "account-id",
"consumerRefField": "user-id",
"scopesField": "scopes",
"otherFields": [
{
"name": "<string>",
"displayName": "<string>",
"path": "owner.siteId",
"capture": "https:\\/\\/(?<result>[^.]+)\\.docusign\\.net"
}
]
},
"docsURL": "https://docs.example.com/client-credentials",
"authURLParams": {
"access_type": "offline",
"duration": "permanent"
}
},
"apiKeyOpts": {
"attachmentType": "query",
"query": {
"name": "api_key"
},
"header": {
"name": "X-Api-Key",
"valuePrefix": "Bearer "
},
"docsURL": "https://docs.example.com/api-key"
},
"basicOpts": {
"apiKeyAsBasic": true,
"apiKeyAsBasicOpts": {
"fieldUsed": "username",
"keyFormat": "api:%s"
},
"docsURL": "https://docs.example.com/api-key"
},
"support": {
"bulkWrite": {
"insert": true,
"update": true,
"upsert": true,
"delete": true
},
"proxy": true,
"read": true,
"subscribe": true,
"write": true,
"subscribeSupport": {
"create": true,
"update": true,
"delete": true,
"passThrough": true
}
},
"providerOpts": {},
"authHealthCheck": {
"url": "https://api.example.com/health-check",
"method": "GET",
"successStatusCodes": [
200,
204
]
},
"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": {},
"subscribeOpts": {
"subscriptionScope": "integration",
"targetURLScope": "integration",
"registrationTiming": "providerApp"
},
"modules": {},
"metadata": {
"input": [
{
"name": "<string>",
"displayName": "<string>",
"docsURL": "https://example.com/how-to-find-subdomain"
}
],
"postAuthentication": [
{
"name": "<string>"
}
]
}
}
Authorizations
Path Parameters
The API provider.
Response
200
application/json
ProviderInfo
The response is of type object
.
Was this page helpful?
curl --request GET \
--url https://api.withampersand.com/v1/providers/{provider} \
--header 'X-Api-Key: <api-key>'
{
"name": "<string>",
"authType": "oauth2",
"baseURL": "<string>",
"oauth2Opts": {
"grantType": "authorizationCode",
"authURL": "https://login.salesforce.com/services/oauth2/authorize",
"tokenURL": "https://login.salesforce.com/services/oauth2/token",
"explicitScopesRequired": true,
"explicitWorkspaceRequired": true,
"audience": [
"https://api.mparticle.com"
],
"tokenMetadataFields": {
"workspaceRefField": "account-id",
"consumerRefField": "user-id",
"scopesField": "scopes",
"otherFields": [
{
"name": "<string>",
"displayName": "<string>",
"path": "owner.siteId",
"capture": "https:\\/\\/(?<result>[^.]+)\\.docusign\\.net"
}
]
},
"docsURL": "https://docs.example.com/client-credentials",
"authURLParams": {
"access_type": "offline",
"duration": "permanent"
}
},
"apiKeyOpts": {
"attachmentType": "query",
"query": {
"name": "api_key"
},
"header": {
"name": "X-Api-Key",
"valuePrefix": "Bearer "
},
"docsURL": "https://docs.example.com/api-key"
},
"basicOpts": {
"apiKeyAsBasic": true,
"apiKeyAsBasicOpts": {
"fieldUsed": "username",
"keyFormat": "api:%s"
},
"docsURL": "https://docs.example.com/api-key"
},
"support": {
"bulkWrite": {
"insert": true,
"update": true,
"upsert": true,
"delete": true
},
"proxy": true,
"read": true,
"subscribe": true,
"write": true,
"subscribeSupport": {
"create": true,
"update": true,
"delete": true,
"passThrough": true
}
},
"providerOpts": {},
"authHealthCheck": {
"url": "https://api.example.com/health-check",
"method": "GET",
"successStatusCodes": [
200,
204
]
},
"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": {},
"subscribeOpts": {
"subscriptionScope": "integration",
"targetURLScope": "integration",
"registrationTiming": "providerApp"
},
"modules": {},
"metadata": {
"input": [
{
"name": "<string>",
"displayName": "<string>",
"docsURL": "https://example.com/how-to-find-subdomain"
}
],
"postAuthentication": [
{
"name": "<string>"
}
]
}
}