{
"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"
}
Provider
Get provider
Returns information about a single provider. No authentication is required.
GET
/
providers
/
{provider}
Get provider
curl --request GET \
--url https://api.ampersand.ai/v1/providers/{provider}
{
"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"
}
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.
Show child attributes
oauth2Opts
OAuth2 Options · object
Configuration for OAuth2.0. Must be provided if authType is oauth2.
Show child attributes
apiKeyOpts
API Key Options · object
Configuration for API key. Must be provided if authType is apiKey.
Show child attributes
basicOpts
Basic Auth Options · object
Configuration for Basic Auth. Optional.
Show child attributes
customOpts
Custom Auth Options · object
Configuration for custom auth. Optional.
Show child attributes
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.
Show child attributes
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
Show child attributes
labels
Labels · object
Show child attributes
subscribeRequirements
Subscribe Requirements · object
Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.
Show child attributes
modules
Modules that this provider supports · object
The registry of provider modules.
Show child attributes
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.
Show child attributes
providerAppMetadata
Provider App Metadata · object
Describes the provider-app-level fields that the Ampersand dashboard should collect from the builder when creating a ProviderApp for this provider. These descriptors tell the dashboard which form fields to render; the submitted values are stored in ProviderApp.metadata.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Ampersand","colors":{"primary":"#1F71D6","light":"#F3F89B","dark":"#2B2B2B"},"logo":{"light":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b","dark":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/dark.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=e83684af7f0f30de3c40d300c6e38ecf","href":"https://www.ampersand.ai"},"favicon":"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/favicon.svg?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=a58cf520454ff09433cb78f5ce10b2f2","api":{"openapi":["platform.json","read.json","write.json","search.json"]},"background":{"color":{"light":"#FDFBF9","dark":"#121212"}},"navbar":{"links":[{"href":"https://dashboard.withampersand.com/sign-in?trk=docs","label":"Sign in"}],"primary":{"type":"button","label":"Start building now","href":"https://dashboard.withampersand.com/sign-up?trk=docs"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/withampersand","twitter":"https://twitter.com/withampersand"}},"seo":{"indexing":"all"},"fonts":{"heading":{"family":"Helvetica Neue","weight":600,"source":"fonts/HelveticaNeue/HelveticaNeueMedium.woff2","format":"woff2"},"body":{"family":"Helvetica Neue","weight":500,"source":"fonts/HelveticaNeue/HelveticaNeueRoman.woff2","format":"woff2"}},"styling":{"codeblocks":"dark","latex":false},"integrations":{"gtm":{"tagId":"GTM-KKG4NLZD"}},"contextual":{"options":["copy","view"],"display":"header"},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"ampersand-24eb5c1a","hasAudioNarration":false,"actualSubdomain":"ampersand-24eb5c1a","customDomains":["docs.ampersand.ai"],"gitSource":{"type":"github","owner":"amp-labs","repo":"docs","deployBranch":"main","contentDirectory":"src","isPrivate":false,"mountPath":"","label":""},"feedback":{"thumbs":true,"edits":true,"issues":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6afba4d88ec88c31b27205a9","clientVersion":"0.0.4167","searchFilterCounts":[{"language":"default","tag":"Integrations","count":434},{"language":"default","tag":"All providers","count":203},{"language":"default","tag":"API Reference","count":91},{"language":"default","tag":"PLATFORM API","count":82},{"language":"default","tag":"Guides","count":37},{"language":"default","tag":"Customer guides","count":13},{"language":"default","tag":"Destinations","count":13},{"language":"default","tag":"Destination","count":12},{"language":"default","tag":"Org","count":12},{"language":"default","tag":"Installation","count":7}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"troubleshooting.css","content":".amp-ts{margin-top:1.5rem;letter-spacing:-0.0125rem}.amp-ts [hidden]{display:none!important}.amp-ts-controls{display:flex;flex-wrap:wrap;gap:10px;align-items:center}.amp-ts input.amp-ts-search{flex:1;min-width:240px;height:38px;padding:0 12px;border-radius:12px;border:1px solid var(--amp-border);background:var(--amp-surface-2);color:var(--amp-fg);font-size:15px;outline:none;transition:border-color 120ms ease}.amp-ts input.amp-ts-search:focus{border-color:var(--amp-accent)}.amp-ts input.amp-ts-search::placeholder{color:var(--amp-faint)}.amp-ts-chips{display:flex;flex-wrap:wrap;gap:8px}.amp-ts button.amp-ts-chip{height:32px;padding:0 12px;border:1px solid var(--amp-border);border-radius:12px;background:var(--amp-surface);color:var(--amp-muted);font-size:14px;font-family:inherit;cursor:pointer;transition:border-color 120ms ease, color 120ms ease}.amp-ts button.amp-ts-chip:hover{border-color:var(--amp-border-hover);color:var(--amp-fg)}.amp-ts button.amp-ts-chip.is-active{border-color:var(--amp-accent);color:var(--amp-accent)}.amp-ts-list{margin-top:6px}.amp-ts a.amp-ts-row{display:grid;grid-template-columns:minmax(0, 1fr) auto;align-items:center;gap:16px;padding:14px 4px;border-bottom:1px solid var(--amp-border-2);color:inherit;text-decoration:none;border-radius:0}.amp-ts a.amp-ts-row:hover .amp-ts-title{color:var(--amp-accent)}.amp-ts-title{font-size:16px;font-weight:500;color:var(--amp-fg);transition:color 120ms ease}.amp-ts-title code{font-size:13px}.amp-ts-desc{margin-top:4px;font-size:15px;line-height:1.6;color:var(--amp-muted)}.amp-ts-tag{font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2);white-space:nowrap}.amp-ts-count{margin-top:12px;font-family:var(--amp-mono);font-size:12px;color:var(--amp-muted-2)}"},{"filePath":"fonts.css","content":"@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueThin.woff2\") format(\"woff2\");font-weight:100;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueLight.woff2\") format(\"woff2\");font-weight:300;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueRoman.woff2\") format(\"woff2\");font-weight:400;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueMedium.woff2\") format(\"woff2\");font-weight:500 600;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBold.woff2\") format(\"woff2\");font-weight:700;font-style:normal;font-display:swap}@font-face{font-family:\"Helvetica Neue\";src:url(\"/fonts/HelveticaNeue/HelveticaNeueBlack.woff2\") format(\"woff2\");font-weight:900;font-style:normal;font-display:swap}"},{"filePath":"provider-grid.css","content":"html[data-current-path=\"/provider-guides/overview\"] #header{display:none}html[data-current-path=\"/provider-guides/overview\"] .mdx-content{max-width:none;margin-top:0}.amp-intg{max-width:1180px;margin:0 auto;color:var(--amp-fg);line-height:1.5}.amp-intg *{box-sizing:border-box}.amp-intg a{color:inherit;text-decoration:none}.amp-find-status,.amp-orbit-core i,.amp-node-label,.amp-intg-card-code,.amp-intg-card-cta{font-family:var(--amp-mono)}.amp-find-status,.amp-intg-head-sub{color:var(--amp-muted-2)}.amp-intg-eyebrow,.amp-intg-title-accent,.amp-intg-card-code,.amp-intg-card-cta{color:var(--amp-accent)}.amp-find-input,.amp-node a,.amp-node-label,.amp-cat-chips a,.amp-intg-card{border:1px solid var(--amp-border);background:var(--amp-surface)}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible,.amp-intg-card:hover{border-color:var(--amp-border-hover)}.amp-node a:focus-visible,.amp-cat-head:focus-visible{outline:2px solid var(--amp-accent)}.amp-intg-hero{display:grid;grid-template-columns:minmax(0, 1fr) minmax(0, 1.05fr);gap:56px;align-items:center;padding:40px 0 8px}.amp-intg-eyebrow{font-size:14px;font-weight:500;margin-bottom:12px}.amp-intg h1.amp-intg-title{margin:0;font-size:36px;line-height:44px;letter-spacing:-0.025em;font-weight:600;text-wrap:pretty}.amp-intg p.amp-intg-lede{margin:20px 0 0;font-size:16px;line-height:1.6;color:var(--amp-muted);max-width:46ch;text-wrap:pretty}.amp-find{margin-top:28px;max-width:360px}.amp-find-input{width:100%;height:40px;padding:0 12px;border-radius:8px;color:inherit;font:inherit;font-size:14px;outline:none;transition:border-color 120ms ease}.amp-find-input:focus{border-color:var(--amp-accent)}.amp-find-input::placeholder{color:var(--amp-faint)}.amp-find-status{margin-top:10px;font-size:11.5px;min-height:16px}.amp-orbit{position:relative;width:min(100%, 540px);aspect-ratio:1;margin:0 auto;container-type:inline-size}.amp-orbit::before,.amp-orbit::after{content:\"\";position:absolute;left:50%;top:50%;border-radius:50%;border:1px solid var(--amp-border-2);transform:translate(-50%, -50%);pointer-events:none}.amp-orbit::before{width:52cqw;height:52cqw}.amp-orbit::after{width:86cqw;height:86cqw;border-style:dashed}.amp-orbit-core{position:absolute;left:50%;top:50%;width:15cqw;height:15cqw;transform:translate(-50%, -50%);display:flex;flex-direction:column;align-items:center;justify-content:center;border-radius:50%;background:var(--amp-accent);box-shadow:0 10px 30px var(--amp-accent-soft);transition:transform 200ms ease, box-shadow 200ms ease}.amp-intg a.amp-orbit-core{color:#fff}html.dark .amp-intg a.amp-orbit-core{color:var(--amp-surface)}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%) scale(1.06);box-shadow:0 14px 36px var(--amp-accent-soft)}.amp-orbit-core b{font-size:4.2cqw;font-weight:600;line-height:1}.amp-orbit-core i{font-size:2.1cqw;font-style:normal;opacity:0.88;line-height:1.5}.amp-node{position:absolute;left:50%;top:50%;transform:translate(-50%, -50%)\n rotate(var(--a))\n translate(var(--r))\n rotate(calc(-1 * var(--a)))}.amp-node a{position:relative;display:grid;place-items:center;width:var(--sz);height:var(--sz);border-radius:50%;transition:transform 200ms cubic-bezier(0.34, 1.4, 0.64, 1), border-color 200ms ease}.amp-node--lg{--sz: 15cqw}.amp-node--sm{--sz: 9.5cqw}.amp-node img{width:62%;height:62%;object-fit:contain;border-radius:6px;background:#ffffff;padding:3%;pointer-events:none}.amp-node a:hover,.amp-node a:focus-visible{border-color:var(--amp-accent)}.amp-node--sm a:hover{transform:scale(1.12)}.amp-node a:focus-visible{outline-offset:3px}.amp-node:has(a:hover),.amp-node:has(a:focus-visible){z-index:3}.amp-node-label{position:absolute;top:calc(100% + 7px);left:50%;transform:translateX(-50%) translateY(3px);padding:3px 9px;border-radius:6px;font-size:11.5px;white-space:nowrap;opacity:0;pointer-events:none;transition:opacity 160ms ease, transform 160ms ease}.amp-node a:hover .amp-node-label,.amp-node a:focus-visible .amp-node-label{opacity:1;transform:translateX(-50%) translateY(0)}.amp-intg-section{padding-top:56px}.amp-intg-section--last{padding-bottom:72px}.amp-intg-head{display:flex;align-items:baseline;gap:14px;padding-bottom:18px;border-bottom:1px solid var(--amp-border-2)}.amp-intg h2.amp-intg-head-title{margin:0;font-size:15px;font-weight:600}.amp-intg-head-sub{font-size:13.5px}.amp-cats{margin-top:8px}.amp-cat{border-bottom:1px solid var(--amp-border-3)}.amp-cat-head{display:grid;grid-template-columns:10px minmax(0, 1fr);align-items:center;gap:14px;padding:17px 4px;cursor:pointer;user-select:none}.amp-cat-head:hover .amp-cat-name,.amp-cat-head:hover .amp-intg-head-title{color:var(--amp-accent)}.amp-cat-head:focus-visible{outline-offset:2px;border-radius:4px}.amp-cat-caret{width:0;height:0;border-left:5px solid var(--amp-faint);border-top:4px solid transparent;border-bottom:4px solid transparent;transition:transform 160ms ease}.amp-cat[data-open=\"true\"] .amp-cat-caret{transform:rotate(90deg);border-left-color:var(--amp-accent)}.amp-cat-name{font-size:14.5px;font-weight:500;letter-spacing:-0.005em;transition:color 120ms ease}.amp-cat:not([data-open=\"true\"]) .amp-cat-chips{display:none}.amp-cat-chips{display:flex;flex-wrap:wrap;gap:8px;padding:2px 4px 22px 24px}.amp-cat--section{border-bottom:0}.amp-intg-head.amp-cat-head{display:flex;align-items:baseline;padding:0 0 18px}.amp-cat--section .amp-cat-caret{align-self:center}.amp-cat--section .amp-cat-chips{padding-top:20px}.amp-cat-chips a{display:inline-flex;align-items:center;height:32px;padding:0 12px;border-radius:7px;font-size:13px;color:var(--amp-fg-2);white-space:nowrap;transition:border-color 120ms ease, color 120ms ease}.amp-cat-chips a:hover,.amp-cat-chips a:focus-visible{color:var(--amp-fg)}.amp-intg-cards{display:grid;grid-template-columns:repeat(auto-fit, minmax(260px, 1fr));gap:16px;margin-top:20px}.amp-intg-card{display:block;padding:20px;border-radius:10px;transition:border-color 120ms ease}.amp-intg-card-code{font-size:13.5px}.amp-intg-card-title{margin-top:10px;font-size:15px;font-weight:600;letter-spacing:-0.01em}.amp-intg-card-desc{margin-top:7px;font-size:14px;line-height:1.55;color:var(--amp-muted)}.amp-intg-card-cta{margin-top:14px;font-size:11.5px}@media (max-width: 960px){.amp-intg-hero{grid-template-columns:minmax(0, 1fr);gap:36px}.amp-intg h1.amp-intg-title{font-size:30px;line-height:38px}}@media (max-width: 640px){.amp-intg h1.amp-intg-title{font-size:27px;line-height:34px}.amp-intg-head{flex-direction:column;align-items:flex-start;gap:6px}.amp-cat-chips{padding-left:4px}}@media (prefers-reduced-motion: no-preference){.amp-node a{animation:amp-bob 6s ease-in-out infinite;animation-delay:var(--d, 0s)}.amp-node a:hover,.amp-node a:focus-visible{animation-play-state:paused}.amp-orbit::after{animation:amp-spin 90s linear infinite}}@keyframes amp-bob{0%,100%{translate:0 0}50%{translate:0 -5px}}@keyframes amp-spin{from{transform:translate(-50%, -50%) rotate(0deg)}to{transform:translate(-50%, -50%) rotate(360deg)}}@media (prefers-reduced-motion: reduce){.amp-node a{animation:none;transition:border-color 160ms ease}.amp-node--sm a:hover{transform:none}.amp-orbit::after{animation:none}.amp-cat-caret{transition:none}.amp-orbit-core:hover,.amp-orbit-core:focus-visible{transform:translate(-50%, -50%)}}.amp-cat[hidden],.amp-cat-chips a[hidden]{display:none!important}"},{"filePath":"shared-variables.css","content":":root{--amp-fg: rgb(var(--gray-900));--amp-fg-2: rgb(var(--gray-700));--amp-muted: rgb(var(--gray-600));--amp-muted-2: rgb(var(--gray-500));--amp-faint: rgb(var(--gray-400));--amp-accent: rgb(var(--primary));--amp-accent-hover: rgb(var(--primary-dark));--amp-accent-soft: rgb(var(--primary) / 0.16);--amp-surface: rgb(var(--background-light));--amp-surface-2: rgb(var(--gray-950) / 0.04);--amp-border: rgb(var(--gray-950) / 0.1);--amp-border-2: rgb(var(--gray-950) / 0.07);--amp-border-3: rgb(var(--gray-950) / 0.05);--amp-border-hover: rgb(var(--gray-950) / 0.22);--amp-mono: var(--font-family-mono-custom, var(--font-jetbrains-mono, ui-monospace)),\n \"SF Mono\", SFMono-Regular, Menlo, monospace}html.dark{--amp-fg: rgb(var(--gray-100));--amp-fg-2: rgb(var(--gray-300));--amp-muted: rgb(var(--gray-400));--amp-muted-2: rgb(var(--gray-400));--amp-faint: rgb(var(--gray-500));--amp-accent: rgb(var(--primary-light));--amp-accent-hover: rgb(var(--primary-light));--amp-accent-soft: rgb(var(--primary-light) / 0.22);--amp-surface: rgb(var(--background-dark));--amp-surface-2: rgb(255 255 255 / 0.05);--amp-border: rgb(255 255 255 / 0.13);--amp-border-2: rgb(255 255 255 / 0.09);--amp-border-3: rgb(255 255 255 / 0.07);--amp-border-hover: rgb(255 255 255 / 0.3)}"}],"page":{"pagePath":"reference/provider/get-provider","slug":"/reference/provider/get-provider","pageMetadata":{"openapi":"platform get /providers/{provider}","title":"Get provider","description":"Returns information about a single provider. No authentication is required.\n","href":"/reference/provider/get-provider"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns information about a single provider. No authentication is required.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":"dark","config":{},"pageMetadata":{"openapi":"platform get /providers/{provider}","title":"Get provider","description":"Returns information about a single provider. No authentication is required.\n","href":"/reference/provider/get-provider"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/ampersand-24eb5c1a/918af64092960fd7/troubleshooting.js","/_mintlify/custom/ampersand-24eb5c1a/0bf41ceae2eadd8d/provider-grid.js","/_mintlify/custom/ampersand-24eb5c1a/8d356ec11ed170d1/analytics.js"],"openApiReferenceData":{"operation":{"summary":"Get provider","description":"Returns information about a single provider. No authentication is required.\n","operationId":"getProvider","tags":["Provider"],"security":[],"parameters":["d9e7d3ce-3b83-4dec-8ad1-1a1268e374b2"],"responses":{"200":"53fc2e6c-ced1-42ee-a3ea-de33e9207ca2","default":"6b81dc78-2ca4-458d-9b59-dd7c5bdb5fbe"},"method":"get","type":"path","servers":["a45d937e-d53b-40fa-a6c9-c692a08fd546"],"path":"/providers/{provider}","baseUrlOptions":["https://api.ampersand.ai/v1"],"title":"Get provider","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"d9e7d3ce-3b83-4dec-8ad1-1a1268e374b2":{"name":"provider","in":"path","required":true,"description":"The provider name (e.g. `salesforce`, `hubspot`).","example":"hubspot","schema":{"type":"string","isRequired":true,"description":"The provider name (e.g. `salesforce`, `hubspot`).","uniqueKey":"","typeLabel":"string"}}},"responses":{"53fc2e6c-ced1-42ee-a3ea-de33e9207ca2":{"description":"The requested provider.","content":{"application/json":{"schema":{"title":"Provider Info","type":"object","required":["name","baseURL","authType","support","defaultModule"],"properties":{"name":{"type":"string","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"authType":{"title":"Auth Type","description":"The type of authentication required by the provider.","type":"string","enum":["oauth2","apiKey","basic","jwt","custom","none"],"x-oapi-codegen-extra-tags":{"validate":"required"},"isRequired":true,"uniqueKey":"authType","typeLabel":"enum\u003cstring>"},"baseURL":{"description":"The base URL for making API requests.","type":"string","x-oapi-codegen-extra-tags":{"validate":"required"},"isRequired":true,"uniqueKey":"baseURL","typeLabel":"string"},"defaultModule":{"type":"string","isRequired":true,"uniqueKey":"defaultModule","typeLabel":"string"},"support":{"title":"Support","type":"object","description":"The supported features for the provider.","x-oapi-codegen-extra-tags":{"validate":"required"},"required":["bulkWrite","proxy","read","subscribe","write","delete","search"],"properties":{"bulkWrite":{"title":"Bulk Write Support","type":"object","x-oapi-codegen-extra-tags":{"validate":"required"},"required":["insert","update","upsert","delete"],"properties":{"insert":{"type":"boolean","isRequired":true,"uniqueKey":"support.bulkWrite.insert","typeLabel":"boolean"},"update":{"type":"boolean","isRequired":true,"uniqueKey":"support.bulkWrite.update","typeLabel":"boolean"},"upsert":{"type":"boolean","isRequired":true,"uniqueKey":"support.bulkWrite.upsert","typeLabel":"boolean"},"delete":{"type":"boolean","isRequired":true,"uniqueKey":"support.bulkWrite.delete","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"support.bulkWrite","typeLabel":"Bulk Write Support · object"},"proxy":{"type":"boolean","isRequired":true,"uniqueKey":"support.proxy","typeLabel":"boolean"},"read":{"type":"boolean","isRequired":true,"uniqueKey":"support.read","typeLabel":"boolean"},"subscribe":{"type":"boolean","isRequired":true,"uniqueKey":"support.subscribe","typeLabel":"boolean"},"write":{"type":"boolean","isRequired":true,"uniqueKey":"support.write","typeLabel":"boolean"},"delete":{"type":"boolean","isRequired":true,"uniqueKey":"support.delete","typeLabel":"boolean"},"search":{"title":"Search Support","type":"object","required":["operators"],"properties":{"operators":{"title":"Supported Operators for Search Action","type":"object","required":["equals"],"properties":{"equals":{"type":"boolean","isRequired":true,"uniqueKey":"support.search.operators.equals","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"support.search.operators","typeLabel":"Supported Operators for Search Action · object"}},"isRequired":true,"uniqueKey":"support.search","typeLabel":"Search Support · object"},"subscribeSupport":{"title":"Subscribe Support","type":"object","properties":{"create":{"type":"boolean","uniqueKey":"support.subscribeSupport.create","typeLabel":"boolean"},"update":{"type":"boolean","uniqueKey":"support.subscribeSupport.update","typeLabel":"boolean"},"delete":{"type":"boolean","uniqueKey":"support.subscribeSupport.delete","typeLabel":"boolean"},"passThrough":{"type":"boolean","uniqueKey":"support.subscribeSupport.passThrough","typeLabel":"boolean"}},"uniqueKey":"support.subscribeSupport","typeLabel":"Subscribe Support · object"},"batchWrite":{"required":["delete","create","update","upsert"],"properties":{"delete":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"support.batchWrite.delete.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"support.batchWrite.delete.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"support.batchWrite.delete.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"support.batchWrite.delete.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"support.batchWrite.delete","typeLabel":"object"},"create":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"support.batchWrite.create.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"support.batchWrite.create.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"support.batchWrite.create.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"support.batchWrite.create.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"support.batchWrite.create","typeLabel":"object"},"update":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"support.batchWrite.update.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"support.batchWrite.update.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"support.batchWrite.update.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"support.batchWrite.update.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"support.batchWrite.update","typeLabel":"object"},"upsert":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"support.batchWrite.upsert.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"support.batchWrite.upsert.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"support.batchWrite.upsert.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"support.batchWrite.upsert.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"support.batchWrite.upsert","typeLabel":"object"}},"type":"object","uniqueKey":"support.batchWrite","typeLabel":"object"}},"isRequired":true,"uniqueKey":"support","typeLabel":"Support · object"},"oauth2Opts":{"title":"OAuth2 Options","type":"object","description":"Configuration for OAuth2.0. Must be provided if authType is oauth2.","required":["grantType","tokenURL","explicitScopesRequired","explicitWorkspaceRequired","tokenMetadataFields"],"properties":{"grantType":{"type":"string","enum":["authorizationCode","authorizationCodePKCE","clientCredentials","password"],"isRequired":true,"uniqueKey":"oauth2Opts.grantType","typeLabel":"enum\u003cstring>"},"tokenURL":{"type":"string","example":"https://login.salesforce.com/services/oauth2/token","description":"The token URL.","x-oapi-codegen-extra-tags":{"validate":"required"},"isRequired":true,"uniqueKey":"oauth2Opts.tokenURL","typeLabel":"string"},"explicitScopesRequired":{"type":"boolean","description":"Whether scopes are required to be known ahead of the OAuth flow.","example":true,"isRequired":true,"uniqueKey":"oauth2Opts.explicitScopesRequired","typeLabel":"boolean"},"explicitWorkspaceRequired":{"type":"boolean","description":"Whether the workspace is required to be known ahead of the OAuth flow.","example":true,"isRequired":true,"uniqueKey":"oauth2Opts.explicitWorkspaceRequired","typeLabel":"boolean"},"tokenMetadataFields":{"title":"Token Metadata Fields","type":"object","description":"Fields to be used to extract token metadata from the token response.","properties":{"workspaceRefField":{"type":"string","example":"account-id","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.workspaceRefField","typeLabel":"string"},"consumerRefField":{"type":"string","example":"user-id","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.consumerRefField","typeLabel":"string"},"scopesField":{"type":"string","example":"scopes","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.scopesField","typeLabel":"string"},"otherFields":{"type":"array","title":"Token Metadata Fields - Other fields","description":"Additional fields to extract and transform from the token response","items":{"type":"object","required":["name","displayName","path"],"properties":{"name":{"type":"string","description":"The internal name of the field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","description":"The human-readable name of the field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields.items.[INDEX].displayName","typeLabel":"string"},"path":{"type":"string","description":"The path to the field in the token response (accepts dot notation for nested fields)","example":"owner.siteId","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields.items.[INDEX].path","typeLabel":"string"},"capture":{"type":"string","description":"A regex expression to capture the value that we need from the path. There must be only one capture group named 'result' in the expression. If not provided, will cause an error.","example":"https:\\/\\/(?\u003cresult>[^.]+)\\.docusign\\.net","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields.items.[INDEX].capture","typeLabel":"string"}},"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oauth2Opts.tokenMetadataFields.otherFields","typeLabel":"Token Metadata Fields - Other fields · object[]"}},"isRequired":true,"uniqueKey":"oauth2Opts.tokenMetadataFields","typeLabel":"Token Metadata Fields · object"},"authURL":{"type":"string","example":"https://login.salesforce.com/services/oauth2/authorize","description":"The authorization URL.","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.authURL","typeLabel":"string"},"audience":{"type":"array","items":{"type":"string","uniqueKey":"oauth2Opts.audience.items.[INDEX]","typeLabel":"string"},"example":["https://api.mparticle.com"],"description":"A list of URLs that represent the audience for the token, which is needed for some client credential grant flows.","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.audience","typeLabel":"string[]"},"scopeMappings":{"type":"object","description":"Maps input scopes to their full OAuth scope values with template variable support. Scopes not in this map are passed through unchanged. Needed for some providers.","additionalProperties":{"type":"string","uniqueKey":"oauth2Opts.scopeMappings.additionalProperties","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"example":{"default":"https://{{.workspace}}.api.com/default"},"uniqueKey":"oauth2Opts.scopeMappings","typeLabel":"object"},"docsURL":{"type":"string","description":"URL with more information about where to retrieve Client ID and Client Secret, etc.","example":"https://docs.example.com/client-credentials","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.docsURL","typeLabel":"string"},"authURLParams":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oauth2Opts.authURLParams.additionalProperties","typeLabel":"string"},"x-go-type-skip-optional-pointer":true,"example":{"access_type":"offline","duration":"permanent"},"uniqueKey":"oauth2Opts.authURLParams","typeLabel":"object"},"accessTokenOpts":{"title":"Oauth2 Access Token Options","type":"object","description":"Configuration that defines how an OAuth 2.0 access token is attached to\noutbound API requests. When provided, this configuration overrides the\ndefault access-token handling behavior for the connector.\n","required":["attachmentType"],"properties":{"attachmentType":{"type":"string","description":"How the access token should be attached to requests.","enum":["accessTokenHeaderAttachment"],"x-oapi-codegen-extra-tags":{"validate":"required"},"isRequired":true,"uniqueKey":"oauth2Opts.accessTokenOpts.attachmentType","typeLabel":"enum\u003cstring>"},"header":{"title":"Access Token Header Options","type":"object","description":"Configuration for access token in header. Must be provided if type is in-header.","required":["name"],"properties":{"name":{"type":"string","example":"X-Access-Token","description":"The name of the header to be used for the access token.","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"oauth2Opts.accessTokenOpts.header.name","typeLabel":"string"},"valuePrefix":{"type":"string","example":"Bearer ","description":"The prefix to be added to the access token value when it is sent in the header.","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.accessTokenOpts.header.valuePrefix","typeLabel":"string"}},"uniqueKey":"oauth2Opts.accessTokenOpts.header","typeLabel":"Access Token Header Options · object"},"docsURL":{"type":"string","description":"URL with more information about how access token is used.","example":"https://docs.example.com/oauth2-access-token-usage","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.accessTokenOpts.docsURL","typeLabel":"string"}},"uniqueKey":"oauth2Opts.accessTokenOpts","typeLabel":"Oauth2 Access Token Options · object"},"keepAliveIntervalHours":{"type":"integer","description":"How many hours between proactive token keep-alive refreshes for this provider.\nToken-manager adds a random stagger offset on top. If absent, defaults to 24.\n","example":120,"x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.keepAliveIntervalHours","typeLabel":"integer"},"scopeQueryParam":{"type":"string","description":"The query parameter name used to pass OAuth scopes in the authorization URL.\nDefaults to \"scope\" when not specified. Some providers use a different\nparameter name, such as \"user_scope\" for Slack user scopes.\n","example":"user_scope","x-go-type-skip-optional-pointer":true,"uniqueKey":"oauth2Opts.scopeQueryParam","typeLabel":"string"}},"uniqueKey":"oauth2Opts","typeLabel":"OAuth2 Options · object"},"apiKeyOpts":{"title":"API Key Options","type":"object","description":"Configuration for API key. Must be provided if authType is apiKey.","required":["attachmentType"],"properties":{"attachmentType":{"type":"string","description":"How the API key should be attached to requests.","enum":["query","header"],"x-oapi-codegen-extra-tags":{"validate":"required"},"isRequired":true,"uniqueKey":"apiKeyOpts.attachmentType","typeLabel":"enum\u003cstring>"},"query":{"title":"API Key Query Options","type":"object","description":"Configuration for API key in query parameter. Must be provided if type is in-query.","required":["name"],"properties":{"name":{"type":"string","example":"api_key","description":"The name of the query parameter to be used for the API key.","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"apiKeyOpts.query.name","typeLabel":"string"}},"uniqueKey":"apiKeyOpts.query","typeLabel":"API Key Query Options · object"},"header":{"title":"API Key Header Options","type":"object","description":"Configuration for API key in header. Must be provided if type is in-header.","required":["name"],"properties":{"name":{"type":"string","example":"X-Api-Key","description":"The name of the header to be used for the API key.","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"apiKeyOpts.header.name","typeLabel":"string"},"valuePrefix":{"type":"string","example":"Bearer ","description":"The prefix to be added to the API key value when it is sent in the header.","x-go-type-skip-optional-pointer":true,"uniqueKey":"apiKeyOpts.header.valuePrefix","typeLabel":"string"}},"uniqueKey":"apiKeyOpts.header","typeLabel":"API Key Header Options · object"},"docsURL":{"type":"string","description":"URL with more information about how to get or use an API key.","example":"https://docs.example.com/api-key","x-go-type-skip-optional-pointer":true,"uniqueKey":"apiKeyOpts.docsURL","typeLabel":"string"}},"uniqueKey":"apiKeyOpts","typeLabel":"API Key Options · object"},"basicOpts":{"title":"Basic Auth Options","type":"object","description":"Configuration for Basic Auth. Optional.","properties":{"apiKeyAsBasic":{"type":"boolean","example":true,"description":"If true, the provider uses an API key which then gets encoded as a basic auth user:pass string.","x-go-type-skip-optional-pointer":true,"uniqueKey":"basicOpts.apiKeyAsBasic","typeLabel":"boolean"},"apiKeyAsBasicOpts":{"title":"API Key as Basic Options","type":"object","description":"when this object is present, it means that this provider uses Basic Auth to actually collect an API key","properties":{"fieldUsed":{"type":"string","enum":["username","password"],"example":"username","description":"whether the API key should be used as the username or password.","x-go-type-skip-optional-pointer":true,"x-enum-varnames":["UsernameField","PasswordField"],"uniqueKey":"basicOpts.apiKeyAsBasicOpts.fieldUsed","typeLabel":"enum\u003cstring>"},"keyFormat":{"type":"string","example":"api:%s","description":"How to transform the API key in to a basic auth user:pass string. The %s is replaced with the API key value.","x-go-type-skip-optional-pointer":true,"uniqueKey":"basicOpts.apiKeyAsBasicOpts.keyFormat","typeLabel":"string"}},"uniqueKey":"basicOpts.apiKeyAsBasicOpts","typeLabel":"API Key as Basic Options · object"},"docsURL":{"type":"string","description":"URL with more information about how to get or use an API key.","example":"https://docs.example.com/api-key","x-go-type-skip-optional-pointer":true,"uniqueKey":"basicOpts.docsURL","typeLabel":"string"}},"uniqueKey":"basicOpts","typeLabel":"Basic Auth Options · object"},"customOpts":{"title":"Custom Auth Options","type":"object","description":"Configuration for custom auth. Optional.","properties":{"headers":{"type":"array","items":{"title":"Custom Auth Header","type":"object","description":"A custom header to be used for authentication. Automatically added by the backend.","required":["name","valueTemplate"],"properties":{"name":{"type":"string","example":"X-Custom-Auth","description":"The name of the header.","isRequired":true,"uniqueKey":"customOpts.headers.items.[INDEX].name","typeLabel":"string"},"valueTemplate":{"type":"string","example":"Bearer {{ .token }}","description":"The value of the header, represented as a Golang text/template expression. Only the backend will interpret this.","x-oapi-codegen-extra-tags":{"skipSubstitutions":"true"},"isRequired":true,"uniqueKey":"customOpts.headers.items.[INDEX].valueTemplate","typeLabel":"string"}},"uniqueKey":"customOpts.headers.items.[INDEX]","typeLabel":"Custom Auth Header · object"},"description":"A list of custom headers to be used for authentication. The backend will add these headers.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.headers","typeLabel":"Custom Auth Header · object[]"},"queryParams":{"type":"array","items":{"title":"Custom Auth Query Parameter","type":"object","description":"A custom query parameter to be used for authentication. Automatically added by the backend.","required":["name","valueTemplate"],"properties":{"name":{"type":"string","example":"custom_auth","description":"The name of the query parameter.","isRequired":true,"uniqueKey":"customOpts.queryParams.items.[INDEX].name","typeLabel":"string"},"valueTemplate":{"type":"string","example":"{{ .token }}","description":"The value of the query parameter, represented as a Golang text/template expression. Only the backend will interpret this.","x-oapi-codegen-extra-tags":{"skipSubstitutions":"true"},"isRequired":true,"uniqueKey":"customOpts.queryParams.items.[INDEX].valueTemplate","typeLabel":"string"}},"uniqueKey":"customOpts.queryParams.items.[INDEX]","typeLabel":"Custom Auth Query Parameter · object"},"description":"A list of custom query parameters to be used for authentication. The backend will add these query parameters.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.queryParams","typeLabel":"Custom Auth Query Parameter · object[]"},"inputs":{"type":"array","items":{"title":"Custom Auth Input","type":"object","description":"A custom input field for authentication. This is used by the frontend to dynamically render input fields for custom auth. The backend will not interpret this. It will however receive the value of this field before making a request (in the connection secrets).","required":["name","displayName"],"properties":{"name":{"type":"string","example":"custom_auth_input","description":"The internal identifier for the custom auth input field.","isRequired":true,"uniqueKey":"customOpts.inputs.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","example":"Custom Auth Input","description":"The human-readable name for the custom auth input field.","isRequired":true,"uniqueKey":"customOpts.inputs.items.[INDEX].displayName","typeLabel":"string"},"prompt":{"type":"string","example":"See Authorization section of provider docs to obtain this value","description":"Some helpful text or context to be displayed to the user when asking for this input.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.inputs.items.[INDEX].prompt","typeLabel":"string"},"docsURL":{"type":"string","example":"https://docs.example.com/custom-auth-input","description":"URL with details about this authentication mechanism and how to use it. Might be specific to this field, or a general URL for the provider. Optional.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.inputs.items.[INDEX].docsURL","typeLabel":"string"},"fieldType":{"type":"string","enum":["fieldTypeText","fieldTypePassword","fieldTypeSelect"],"example":"fieldTypePassword","description":"How the frontend should render this input. \"fieldTypeText\" is an unmasked field (not sensitive), \"fieldTypePassword\" is a masked field (sensitive), and \"fieldTypeSelect\" is a dropdown populated from options. Defaults to \"fieldTypePassword\" when omitted.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.inputs.items.[INDEX].fieldType","typeLabel":"enum\u003cstring>"},"options":{"type":"array","items":{"title":"Custom Auth Input Option","type":"object","description":"A selectable option for a custom auth input whose fieldType is \"select\".","required":["value","label"],"properties":{"value":{"type":"string","example":"prod","description":"The value stored when this option is selected.","isRequired":true,"uniqueKey":"customOpts.inputs.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Production","description":"The human-readable label shown for this option.","isRequired":true,"uniqueKey":"customOpts.inputs.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"uniqueKey":"customOpts.inputs.items.[INDEX].options.items.[INDEX]","typeLabel":"Custom Auth Input Option · object"},"description":"The dropdown options, used only when fieldType is \"select\".","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.inputs.items.[INDEX].options","typeLabel":"Custom Auth Input Option · object[]"}},"uniqueKey":"customOpts.inputs.items.[INDEX]","typeLabel":"Custom Auth Input · object"},"description":"A list of custom input fields for authentication. The frontend will render these input fields and the backend will receive the values of these fields before making a request.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.inputs","typeLabel":"Custom Auth Input · object[]"},"providerInputs":{"type":"array","items":{"title":"Custom Auth Input","type":"object","description":"A custom input field for authentication. This is used by the frontend to dynamically render input fields for custom auth. The backend will not interpret this. It will however receive the value of this field before making a request (in the connection secrets).","required":["name","displayName"],"properties":{"name":{"type":"string","example":"custom_auth_input","description":"The internal identifier for the custom auth input field.","isRequired":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","example":"Custom Auth Input","description":"The human-readable name for the custom auth input field.","isRequired":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].displayName","typeLabel":"string"},"prompt":{"type":"string","example":"See Authorization section of provider docs to obtain this value","description":"Some helpful text or context to be displayed to the user when asking for this input.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].prompt","typeLabel":"string"},"docsURL":{"type":"string","example":"https://docs.example.com/custom-auth-input","description":"URL with details about this authentication mechanism and how to use it. Might be specific to this field, or a general URL for the provider. Optional.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].docsURL","typeLabel":"string"},"fieldType":{"type":"string","enum":["fieldTypeText","fieldTypePassword","fieldTypeSelect"],"example":"fieldTypePassword","description":"How the frontend should render this input. \"fieldTypeText\" is an unmasked field (not sensitive), \"fieldTypePassword\" is a masked field (sensitive), and \"fieldTypeSelect\" is a dropdown populated from options. Defaults to \"fieldTypePassword\" when omitted.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].fieldType","typeLabel":"enum\u003cstring>"},"options":{"type":"array","items":{"title":"Custom Auth Input Option","type":"object","description":"A selectable option for a custom auth input whose fieldType is \"select\".","required":["value","label"],"properties":{"value":{"type":"string","example":"prod","description":"The value stored when this option is selected.","isRequired":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].options.items.[INDEX].value","typeLabel":"string"},"label":{"type":"string","example":"Production","description":"The human-readable label shown for this option.","isRequired":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].options.items.[INDEX].label","typeLabel":"string"}},"uniqueKey":"customOpts.providerInputs.items.[INDEX].options.items.[INDEX]","typeLabel":"Custom Auth Input Option · object"},"description":"The dropdown options, used only when fieldType is \"select\".","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.providerInputs.items.[INDEX].options","typeLabel":"Custom Auth Input Option · object[]"}},"uniqueKey":"customOpts.providerInputs.items.[INDEX]","typeLabel":"Custom Auth Input · object"},"description":"Input fields the builder configures on their provider app (e.g. client secrets, subscription keys) rather than the consumer. Routed to storage by fieldType. Optional.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.providerInputs","typeLabel":"Custom Auth Input · object[]"},"multiStep":{"type":"boolean","example":true,"description":"Whether this provider uses a multi-step custom auth flow (browser redirects and/or server-side credential-exchange calls) driven by the /custom-auth/connect endpoint, rather than static header/query-param injection. The step definitions and handlers live in the connectors library, not the catalog; this flag is the signal that lets clients tell \"multi-step custom\" apart from plain \"custom\" at a glance.","x-go-type-skip-optional-pointer":true,"uniqueKey":"customOpts.multiStep","typeLabel":"boolean"}},"uniqueKey":"customOpts","typeLabel":"Custom Auth Options · object"},"authHealthCheck":{"title":"Auth Health Check","type":"object","description":"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.","required":["url"],"properties":{"url":{"type":"string","description":"a no-op URL to check the health of the credentials. The URL MUST not mutate any state. If the provider doesn't have such an endpoint, then don't provide credentialsHealthCheck.","example":"https://api.example.com/health-check","isRequired":true,"uniqueKey":"authHealthCheck.url","typeLabel":"string"},"method":{"type":"string","description":"The HTTP method to use for the health check. If not set, defaults to GET.","example":"GET","x-go-type-skip-optional-pointer":true,"uniqueKey":"authHealthCheck.method","typeLabel":"string"},"successStatusCodes":{"type":"array","items":{"type":"integer","uniqueKey":"authHealthCheck.successStatusCodes.items.[INDEX]","typeLabel":"integer"},"description":"The HTTP status codes that indicate a successful health check. If not set, defaults to 200 and 204.","example":[200,204],"x-go-type-skip-optional-pointer":true,"uniqueKey":"authHealthCheck.successStatusCodes","typeLabel":"integer[]"}},"uniqueKey":"authHealthCheck","typeLabel":"Auth Health Check · object"},"displayName":{"type":"string","example":"Zendesk Chat","description":"The display name of the provider, if omitted, defaults to provider name.","x-go-type-skip-optional-pointer":true,"uniqueKey":"displayName","typeLabel":"string"},"postAuthInfoNeeded":{"type":"boolean","example":true,"description":"If true, we require additional information after auth to start making requests.","x-go-type-skip-optional-pointer":true,"uniqueKey":"postAuthInfoNeeded","typeLabel":"boolean"},"media":{"title":"Media","properties":{"regular":{"title":"Media Type Regular","type":"object","description":"Media for light/regular mode.","properties":{"iconURL":{"type":"string","example":"https://example.com/icon.png","description":"URL to the icon for the provider.","x-go-type-skip-optional-pointer":true,"uniqueKey":"media.regular.iconURL","typeLabel":"string"},"logoURL":{"type":"string","example":"https://example.com/logo.png","description":"URL to the logo for the provider.","x-go-type-skip-optional-pointer":true,"uniqueKey":"media.regular.logoURL","typeLabel":"string"}},"uniqueKey":"media.regular","typeLabel":"Media Type Regular · object"},"darkMode":{"title":"Media Type Dark Mode","type":"object","description":"Media to be used in dark mode.","properties":{"iconURL":{"type":"string","example":"https://example.com/icon.png","description":"URL to the icon for the provider that is to be used in dark mode.","x-go-type-skip-optional-pointer":true,"uniqueKey":"media.darkMode.iconURL","typeLabel":"string"},"logoURL":{"type":"string","example":"https://example.com/logo.png","description":"URL to the logo for the provider that is to be used in dark mode.","x-go-type-skip-optional-pointer":true,"uniqueKey":"media.darkMode.logoURL","typeLabel":"string"}},"uniqueKey":"media.darkMode","typeLabel":"Media Type Dark Mode · object"}},"type":"object","uniqueKey":"media","typeLabel":"Media · object"},"labels":{"title":"Labels","type":"object","additionalProperties":{"type":"string","uniqueKey":"labels.additionalProperties","typeLabel":"string"},"uniqueKey":"labels","typeLabel":"Labels · object"},"subscribeRequirements":{"title":"Subscribe Requirements","type":"object","description":"Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.","properties":{"registration":{"type":"boolean","description":"Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required.","uniqueKey":"subscribeRequirements.registration","typeLabel":"boolean"},"maintenance":{"type":"boolean","description":"Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active.","uniqueKey":"subscribeRequirements.maintenance","typeLabel":"boolean"},"postProcess":{"type":"boolean","description":"Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process.","uniqueKey":"subscribeRequirements.postProcess","typeLabel":"boolean"},"subscribeByAPI":{"type":"boolean","description":"Whether the provider supports programmatic subscription via API. If false, provider may still support webhooks via manual configuration in UI. ","uniqueKey":"subscribeRequirements.subscribeByAPI","typeLabel":"boolean"}},"uniqueKey":"subscribeRequirements","typeLabel":"Subscribe Requirements · object"},"modules":{"title":"Modules that this provider supports","type":"object","description":"The registry of provider modules.","additionalProperties":{"title":"Module Info","type":"object","required":["displayName","baseURL","support"],"properties":{"displayName":{"type":"string","isRequired":true,"uniqueKey":"modules.additionalProperties.displayName","typeLabel":"string"},"baseURL":{"type":"string","isRequired":true,"uniqueKey":"modules.additionalProperties.baseURL","typeLabel":"string"},"support":{"title":"Support","type":"object","description":"The supported features for the provider.","x-oapi-codegen-extra-tags":{"validate":"required"},"required":["bulkWrite","proxy","read","subscribe","write","delete","search"],"properties":{"bulkWrite":{"title":"Bulk Write Support","type":"object","x-oapi-codegen-extra-tags":{"validate":"required"},"required":["insert","update","upsert","delete"],"properties":{"insert":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.bulkWrite.insert","typeLabel":"boolean"},"update":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.bulkWrite.update","typeLabel":"boolean"},"upsert":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.bulkWrite.upsert","typeLabel":"boolean"},"delete":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.bulkWrite.delete","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"modules.additionalProperties.support.bulkWrite","typeLabel":"Bulk Write Support · object"},"proxy":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.proxy","typeLabel":"boolean"},"read":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.read","typeLabel":"boolean"},"subscribe":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.subscribe","typeLabel":"boolean"},"write":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.write","typeLabel":"boolean"},"delete":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.delete","typeLabel":"boolean"},"search":{"title":"Search Support","type":"object","required":["operators"],"properties":{"operators":{"title":"Supported Operators for Search Action","type":"object","required":["equals"],"properties":{"equals":{"type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.search.operators.equals","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"modules.additionalProperties.support.search.operators","typeLabel":"Supported Operators for Search Action · object"}},"isRequired":true,"uniqueKey":"modules.additionalProperties.support.search","typeLabel":"Search Support · object"},"subscribeSupport":{"title":"Subscribe Support","type":"object","properties":{"create":{"type":"boolean","uniqueKey":"modules.additionalProperties.support.subscribeSupport.create","typeLabel":"boolean"},"update":{"type":"boolean","uniqueKey":"modules.additionalProperties.support.subscribeSupport.update","typeLabel":"boolean"},"delete":{"type":"boolean","uniqueKey":"modules.additionalProperties.support.subscribeSupport.delete","typeLabel":"boolean"},"passThrough":{"type":"boolean","uniqueKey":"modules.additionalProperties.support.subscribeSupport.passThrough","typeLabel":"boolean"}},"uniqueKey":"modules.additionalProperties.support.subscribeSupport","typeLabel":"Subscribe Support · object"},"batchWrite":{"required":["delete","create","update","upsert"],"properties":{"delete":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.delete.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.delete.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.delete.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"modules.additionalProperties.support.batchWrite.delete.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.delete","typeLabel":"object"},"create":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.create.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.create.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.create.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"modules.additionalProperties.support.batchWrite.create.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.create","typeLabel":"object"},"update":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.update.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.update.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.update.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"modules.additionalProperties.support.batchWrite.update.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.update","typeLabel":"object"},"upsert":{"required":["supported"],"properties":{"supported":{"description":"Whether this type of batch write operation is supported","type":"boolean","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.upsert.supported","typeLabel":"boolean"},"defaultRecordLimit":{"description":"The default number of records supported in a batch","type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.upsert.defaultRecordLimit","typeLabel":"integer"},"objectRecordLimits":{"description":"Defines object-level overrides for batch record limits. Keys represent object names, and values specify the maximum number of records per batch for those objects.","type":"object","additionalProperties":{"type":"integer","uniqueKey":"modules.additionalProperties.support.batchWrite.upsert.objectRecordLimits.additionalProperties","typeLabel":"integer"},"uniqueKey":"modules.additionalProperties.support.batchWrite.upsert.objectRecordLimits","typeLabel":"object"}},"type":"object","isRequired":true,"uniqueKey":"modules.additionalProperties.support.batchWrite.upsert","typeLabel":"object"}},"type":"object","uniqueKey":"modules.additionalProperties.support.batchWrite","typeLabel":"object"}},"isRequired":true,"uniqueKey":"modules.additionalProperties.support","typeLabel":"Support · object"},"subscribeRequirements":{"title":"Subscribe Requirements","type":"object","description":"Declares which auxiliary steps a provider requires to support subscriptions, beyond the per-object subscribe call itself.","properties":{"registration":{"type":"boolean","description":"Whether the provider requires a one-time registration step that is shared across all subscribed objects. The subscribe method is object-scoped, so if a separate API call is needed beyond per-object configuration (e.g., registering a single webhook/endpoint that all object subscriptions hang off of), registration is required.","uniqueKey":"modules.additionalProperties.subscribeRequirements.registration","typeLabel":"boolean"},"maintenance":{"type":"boolean","description":"Whether the subscription requires periodic maintenance. Some providers expire subscriptions/watches after a fixed TTL, so the subscription must be renewed on a schedule to remain active.","uniqueKey":"modules.additionalProperties.subscribeRequirements.maintenance","typeLabel":"boolean"},"postProcess":{"type":"boolean","description":"Whether subscribing requires a third-party setup step that the connector instance itself cannot perform. Examples: Salesforce requires AWS EventBridge configuration; Gmail requires a Google Pub/Sub topic to be configured. Any configuration that must happen outside the connector falls into post-process.","uniqueKey":"modules.additionalProperties.subscribeRequirements.postProcess","typeLabel":"boolean"},"subscribeByAPI":{"type":"boolean","description":"Whether the provider supports programmatic subscription via API. If false, provider may still support webhooks via manual configuration in UI. ","uniqueKey":"modules.additionalProperties.subscribeRequirements.subscribeByAPI","typeLabel":"boolean"}},"uniqueKey":"modules.additionalProperties.subscribeRequirements","typeLabel":"Subscribe Requirements · object"}},"uniqueKey":"modules.additionalProperties","typeLabel":"Module Info · object"},"uniqueKey":"modules","typeLabel":"Modules that this provider supports · object"},"metadata":{"title":"Provider Metadata","type":"object","description":"Provider metadata that needs to be given by the user or fetched by the connector post authentication for the connector to work.","properties":{"input":{"type":"array","description":"Metadata provided as manual input","items":{"title":"Metadata Item (as input)","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The internal identifier for the metadata field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"metadata.input.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","description":"The human-readable name for the field","x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.input.items.[INDEX].displayName","typeLabel":"string"},"prompt":{"type":"string","description":"Human-readable description that can contain instructions on how to collect metadata","x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.input.items.[INDEX].prompt","typeLabel":"string"},"defaultValue":{"type":"string","description":"Default value for this metadata item","x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.input.items.[INDEX].defaultValue","typeLabel":"string"},"docsURL":{"type":"string","description":"URL with more information about how to locate this value","example":"https://example.com/how-to-find-subdomain","x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.input.items.[INDEX].docsURL","typeLabel":"string"},"moduleDependencies":{"description":"Which modules require this metadata item (see ModuleDependencies for naming clarification).","title":"Module Dependencies","type":"object","additionalProperties":{"title":"Module Dependency","type":"object","description":"Dependency for a single module.","properties":{},"uniqueKey":"metadata.input.items.[INDEX].moduleDependencies.additionalProperties","typeLabel":"Module Dependency · object"},"uniqueKey":"metadata.input.items.[INDEX].moduleDependencies","typeLabel":"Module Dependencies · object"}},"uniqueKey":"metadata.input.items.[INDEX]","typeLabel":"Metadata Item (as input) · object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.input","typeLabel":"Metadata Item (as input) · object[]"},"postAuthentication":{"type":"array","description":"Metadata fetched by the connector post authentication","items":{"title":"Metadata Item (fetched post authentication)","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The internal identifier for the metadata field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"metadata.postAuthentication.items.[INDEX].name","typeLabel":"string"},"moduleDependencies":{"description":"Which modules require this metadata item (see ModuleDependencies for naming clarification).","title":"Module Dependencies","type":"object","additionalProperties":{"title":"Module Dependency","type":"object","description":"Dependency for a single module.","properties":{},"uniqueKey":"metadata.postAuthentication.items.[INDEX].moduleDependencies.additionalProperties","typeLabel":"Module Dependency · object"},"uniqueKey":"metadata.postAuthentication.items.[INDEX].moduleDependencies","typeLabel":"Module Dependencies · object"}},"uniqueKey":"metadata.postAuthentication.items.[INDEX]","typeLabel":"Metadata Item (fetched post authentication) · object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"metadata.postAuthentication","typeLabel":"Metadata Item (fetched post authentication) · object[]"}},"uniqueKey":"metadata","typeLabel":"Provider Metadata · object"},"providerAppMetadata":{"title":"Provider App Metadata","type":"object","description":"Describes the provider-app-level fields that the Ampersand dashboard should collect from the builder when creating a ProviderApp for this provider. These descriptors tell the dashboard which form fields to render; the submitted values are stored in ProviderApp.metadata.","properties":{"authQueryParams":{"type":"array","description":"Descriptors for fields stored in ProviderApp.metadata.authQueryParams (e.g., optional_scope for HubSpot).","items":{"title":"Metadata Item (as input)","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The internal identifier for the metadata field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","description":"The human-readable name for the field","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].displayName","typeLabel":"string"},"prompt":{"type":"string","description":"Human-readable description that can contain instructions on how to collect metadata","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].prompt","typeLabel":"string"},"defaultValue":{"type":"string","description":"Default value for this metadata item","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].defaultValue","typeLabel":"string"},"docsURL":{"type":"string","description":"URL with more information about how to locate this value","example":"https://example.com/how-to-find-subdomain","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].docsURL","typeLabel":"string"},"moduleDependencies":{"description":"Which modules require this metadata item (see ModuleDependencies for naming clarification).","title":"Module Dependencies","type":"object","additionalProperties":{"title":"Module Dependency","type":"object","description":"Dependency for a single module.","properties":{},"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].moduleDependencies.additionalProperties","typeLabel":"Module Dependency · object"},"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX].moduleDependencies","typeLabel":"Module Dependencies · object"}},"uniqueKey":"providerAppMetadata.authQueryParams.items.[INDEX]","typeLabel":"Metadata Item (as input) · object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.authQueryParams","typeLabel":"Metadata Item (as input) · object[]"},"providerParams":{"type":"array","description":"Descriptors for fields stored in ProviderApp.metadata.providerParams (e.g., packageInstallURL for Salesforce, gcpProjectId for Gmail).","items":{"title":"Metadata Item (as input)","type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The internal identifier for the metadata field","x-go-type-skip-optional-pointer":true,"isRequired":true,"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].name","typeLabel":"string"},"displayName":{"type":"string","description":"The human-readable name for the field","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].displayName","typeLabel":"string"},"prompt":{"type":"string","description":"Human-readable description that can contain instructions on how to collect metadata","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].prompt","typeLabel":"string"},"defaultValue":{"type":"string","description":"Default value for this metadata item","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].defaultValue","typeLabel":"string"},"docsURL":{"type":"string","description":"URL with more information about how to locate this value","example":"https://example.com/how-to-find-subdomain","x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].docsURL","typeLabel":"string"},"moduleDependencies":{"description":"Which modules require this metadata item (see ModuleDependencies for naming clarification).","title":"Module Dependencies","type":"object","additionalProperties":{"title":"Module Dependency","type":"object","description":"Dependency for a single module.","properties":{},"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].moduleDependencies.additionalProperties","typeLabel":"Module Dependency · object"},"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX].moduleDependencies","typeLabel":"Module Dependencies · object"}},"uniqueKey":"providerAppMetadata.providerParams.items.[INDEX]","typeLabel":"Metadata Item (as input) · object"},"x-go-type-skip-optional-pointer":true,"uniqueKey":"providerAppMetadata.providerParams","typeLabel":"Metadata Item (as input) · object[]"}},"uniqueKey":"providerAppMetadata","typeLabel":"Provider App Metadata · object"}},"uniqueKey":"","typeLabel":"Provider Info · object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","authType":"oauth2","baseURL":"\u003cstring>","defaultModule":"\u003cstring>","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},"batchWrite":{"delete":{"supported":true,"defaultRecordLimit":123,"objectRecordLimits":{}},"create":{"supported":true,"defaultRecordLimit":123,"objectRecordLimits":{}},"update":{"supported":true,"defaultRecordLimit":123,"objectRecordLimits":{}},"upsert":{"supported":true,"defaultRecordLimit":123,"objectRecordLimits":{}}}},"oauth2Opts":{"grantType":"authorizationCode","tokenURL":"https://login.salesforce.com/services/oauth2/token","explicitScopesRequired":true,"explicitWorkspaceRequired":true,"tokenMetadataFields":{"workspaceRefField":"account-id","consumerRefField":"user-id","scopesField":"scopes","otherFields":[{"name":"\u003cstring>","displayName":"\u003cstring>","path":"owner.siteId","capture":"https:\\/\\/(?\u003cresult>[^.]+)\\.docusign\\.net"}]},"authURL":"https://login.salesforce.com/services/oauth2/authorize","audience":["https://api.mparticle.com"],"scopeMappings":{"default":"https://{{.workspace}}.api.com/default"},"docsURL":"https://docs.example.com/client-credentials","authURLParams":{"access_type":"offline","duration":"permanent"},"accessTokenOpts":{"attachmentType":"accessTokenHeaderAttachment","header":{"name":"X-Access-Token","valuePrefix":"Bearer "},"docsURL":"https://docs.example.com/oauth2-access-token-usage"},"keepAliveIntervalHours":120,"scopeQueryParam":"user_scope"},"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"},"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","fieldType":"fieldTypePassword","options":[{"value":"prod","label":"Production"}]}],"providerInputs":[{"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","fieldType":"fieldTypePassword","options":[{"value":"prod","label":"Production"}]}],"multiStep":true},"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":{},"subscribeRequirements":{"registration":true,"maintenance":true,"postProcess":true,"subscribeByAPI":true},"modules":{},"metadata":{"input":[{"name":"\u003cstring>","displayName":"\u003cstring>","prompt":"\u003cstring>","defaultValue":"\u003cstring>","docsURL":"https://example.com/how-to-find-subdomain","moduleDependencies":{}}],"postAuthentication":[{"name":"\u003cstring>","moduleDependencies":{}}]},"providerAppMetadata":{"authQueryParams":[{"name":"\u003cstring>","displayName":"\u003cstring>","prompt":"\u003cstring>","defaultValue":"\u003cstring>","docsURL":"https://example.com/how-to-find-subdomain","moduleDependencies":{}}],"providerParams":[{"name":"\u003cstring>","displayName":"\u003cstring>","prompt":"\u003cstring>","defaultValue":"\u003cstring>","docsURL":"https://example.com/how-to-find-subdomain","moduleDependencies":{}}]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6b81dc78-2ca4-458d-9b59-dd7c5bdb5fbe":{"description":"Error","content":{"application/problem+json":{"schema":{"type":"object","title":"API Problem","description":"A Problem Details object (RFC 9457).\n\nAdditional properties specific to the problem type may be present.\n","example":{"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"},"properties":{"type":{"type":"string","format":"uri","description":"An absolute URI that identifies the problem type","default":"about:blank","uniqueKey":"type","typeLabel":"string\u003curi>"},"href":{"type":"string","format":"uri","description":"An absolute URI that, when dereferenced, provides human-readable documentation for the problem type (e.g. using HTML).","uniqueKey":"href","typeLabel":"string\u003curi>"},"title":{"type":"string","description":"A short summary of the problem type. Written in English and readable for engineers (usually not suited for non technical stakeholders and not localized).","example":"Service Unavailable","uniqueKey":"title","typeLabel":"string"},"status":{"type":"integer","format":"int32","description":"The HTTP status code generated by the origin server for this occurrence of the problem.","minimum":400,"maximum":600,"exclusiveMaximum":true,"example":503,"uniqueKey":"status","typeLabel":"integer\u003cint32>"},"detail":{"type":"string","description":"A human-readable explanation specific to this occurrence of the problem","uniqueKey":"detail","typeLabel":"string"},"instance":{"type":"string","format":"uri","description":"An absolute URI that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","uniqueKey":"instance","typeLabel":"string\u003curi>"},"subsystem":{"type":"string","description":"The subsystem that generated the problem","example":"api","uniqueKey":"subsystem","typeLabel":"string"},"time":{"type":"string","format":"date-time","description":"The time the problem occurred, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"time","typeLabel":"string\u003cdate-time>"},"requestId":{"type":"string","description":"A unique identifier for the request, useful for debugging","example":"89eb1ffb-2a54-4105-aaae-7bf990f1aa69#87715","uniqueKey":"requestId","typeLabel":"string"},"causes":{"type":"array","items":{"type":"string","description":"A brief description of something which caused the problem","example":"database connection failed","uniqueKey":"causes.items.[INDEX]","typeLabel":"string"},"example":["database connection failed","database query failed","unable to fetch user"],"description":"A list of problems that caused this problem. This can be used to represent multiple\nroot causes. There is no guaranteed ordering of the causes.\n","uniqueKey":"causes","typeLabel":"string[]"},"remedy":{"type":"string","description":"A brief description of how to resolve the problem","example":"Shorten your input to be under 100 characters","uniqueKey":"remedy","typeLabel":"string"},"supportEmail":{"type":"string","format":"email","description":"An email address to contact for support","example":"support@withampersand.com","uniqueKey":"supportEmail","typeLabel":"string\u003cemail>"},"supportPhone":{"type":"string","description":"A phone number to contact for support","example":"+1-555-555-5555","uniqueKey":"supportPhone","typeLabel":"string"},"supportUrl":{"type":"string","format":"uri","description":"A URL to contact for support","example":"mailto:support@withampersand.com","uniqueKey":"supportUrl","typeLabel":"string\u003curi>"},"retryable":{"type":"boolean","description":"Whether the request can be retried","example":false,"uniqueKey":"retryable","typeLabel":"boolean"},"retryAfter":{"type":"string","format":"date-time","description":"A timestamp after which the request can be retried, formatted as RFC-3339","example":"2024-04-22T18:55:28.456076Z","uniqueKey":"retryAfter","typeLabel":"string\u003cdate-time>"},"context":{"type":"object","description":"Additional context for the problem","additionalProperties":true,"example":{"name":"Rick Sanchez"},"uniqueKey":"context","typeLabel":"object"}},"uniqueKey":"","typeLabel":"API Problem · object"},"examples":{"Example":{"title":"Example","value":{"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"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"a45d937e-d53b-40fa-a6c9-c692a08fd546":{"url":"https://api.ampersand.ai/v1"}}},"originalFileLocation":"platform.json"},"subdomain":"ampersand-24eb5c1a","siteName":"Ampersand","title":"Get provider - Ampersand","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-03-18T05:59:51.145Z","originalFileLocation":"reference/provider/get-provider.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Returns information about a single provider. No authentication is required.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Get provider - Ampersand\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns information about a single provider. No authentication is required.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Ampersand\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.ampersand.ai/reference/provider/get-provider\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Provider\u0026amp;title=Get+provider\u0026amp;description=Returns+information+about+a+single+provider.+No+authentication+is+required.%0A\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=a3cdcdb0acea131db51883ab5728db9cb681f2b385ecc83bf6838b503d81ff73\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Get provider - Ampersand\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns information about a single provider. No authentication is required.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://ampersand-24eb5c1a.mintlify.site/_mintlify/api/og/v2?division=Provider\u0026amp;title=Get+provider\u0026amp;description=Returns+information+about+a+single+provider.+No+authentication+is+required.%0A\u0026amp;theme=9c317003eb22ad486143ef26\u0026amp;signature=a3cdcdb0acea131db51883ab5728db9cb681f2b385ecc83bf6838b503d81ff73\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/ampersand-24eb5c1a/IC0DrawDowD95AhT/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Ampersand\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1F71D6\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.ampersand.ai/reference/provider/get-provider\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/provider/get-provider.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.ampersand.ai/#organization\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/ampersand-24eb5c1a/RG8xjLJNYe4ES7r7/logos/light.png?fit=max\u0026auto=format\u0026n=RG8xjLJNYe4ES7r7\u0026q=85\u0026s=7799b7c055eff93e5275bfee4335494b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.ampersand.ai#website\",\"name\":\"Ampersand\",\"url\":\"https://docs.ampersand.ai\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.ampersand.ai/reference/provider/get-provider#webpage\",\"url\":\"https://docs.ampersand.ai/reference/provider/get-provider\",\"name\":\"Get provider\",\"description\":\"Returns information about a single provider. No authentication is required.\",\"dateModified\":\"2026-03-18T05:59:51.145Z\",\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.ampersand.ai/reference/provider/get-provider#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.ampersand.ai/reference/provider/get-provider#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"PLATFORM API\",\"item\":\"https://docs.ampersand.ai/reference/oauth/generate-oauth-authorization-url\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Provider\",\"item\":\"https://docs.ampersand.ai/reference/provider/list-providers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Get provider\",\"item\":\"https://docs.ampersand.ai/reference/provider/get-provider\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.ampersand.ai/reference/provider/get-provider#apireference\",\"headline\":\"Get provider\",\"name\":\"Get provider\",\"description\":\"Returns information about a single provider. No authentication is required.\",\"url\":\"https://docs.ampersand.ai/reference/provider/get-provider\",\"mainEntityOfPage\":{\"@id\":\"https://docs.ampersand.ai/reference/provider/get-provider#webpage\"},\"dateModified\":\"2026-03-18T05:59:51.145Z\",\"publisher\":{\"@id\":\"https://docs.ampersand.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.ampersand.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Ampersand\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Ampersand\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/provider/get-provider.md","siteName":"Ampersand","nav":{"global":null,"tabs":[{"tab":"Guides","pages":[{"title":"Guides","href":"/overview"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Ampersand REST APIs: Write, Read, Platform, and Proxy","sidebarTitle":"Overview","href":"/api/overview"},{"title":"Access via API key","href":"/api/key-auth"},{"title":"Access via JWT","href":"/api/jwt-auth"}]},{"group":"WRITE API","pages":[{"group":"Write","pages":[{"openapi":"write post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Write records","href":"/reference/write/write-records"}]}]},{"group":"READ API","pages":[{"group":"Read","pages":[{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}","title":"Trigger a read","href":"/reference/read/trigger-a-read"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:pause","title":"Pause reads for an installation","href":"/reference/read/pause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}:unpause","title":"Unpause reads for an installation","href":"/reference/read/unpause-reads-for-an-installation"},{"openapi":"read post /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}:deliverResults","title":"Deliver results","href":"/reference/read/deliver-results"}]}]},{"group":"SEARCH API","pages":[{"group":"Search","pages":[{"openapi":"search post /projects/{projectIdOrName}/integrations/{integrationId}","title":"Search records","href":"/reference/search/search-records"}]}]},{"group":"PLATFORM API","pages":[{"group":"OAuth","pages":[{"openapi":"platform post /oauth-connect","title":"Generate OAuth authorization URL","href":"/reference/oauth/generate-oauth-authorization-url"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}:oauth-update","title":"Generate OAuth authorization URL for existing connection","href":"/reference/oauth/generate-oauth-authorization-url-for-existing-connection"}]},{"group":"Connection","pages":[{"openapi":"platform post /custom-auth/connect","title":"Start or continue a multi-step custom auth flow","href":"/reference/connection/start-or-continue-a-multi-step-custom-auth-flow"},{"openapi":"platform get /projects/{projectIdOrName}/connections","title":"List connections","href":"/reference/connection/list-connections"},{"openapi":"platform post /projects/{projectIdOrName}/connections:generate","title":"Generate a new connection","href":"/reference/connection/generate-a-new-connection"},{"openapi":"platform get /projects/{projectIdOrName}/connections/{connectionId}","title":"Get a connection","href":"/reference/connection/get-a-connection"},{"openapi":"platform delete /projects/{projectIdOrName}/connections/{connectionId}","title":"Delete a connection","href":"/reference/connection/delete-a-connection"},{"openapi":"platform patch /projects/{projectIdOrName}/connections/{connectionId}","title":"Update a connection.","href":"/reference/connection/update-a-connection"}]},{"group":"Project","pages":[{"openapi":"platform get /projects","title":"List projects","href":"/reference/project/list-projects"},{"openapi":"platform post /projects","title":"Create a new project","href":"/reference/project/create-a-new-project"},{"openapi":"platform get /projects/{projectIdOrName}","title":"Get a project","href":"/reference/project/get-a-project"},{"openapi":"platform patch /projects/{projectIdOrName}","title":"Update a project","href":"/reference/project/update-a-project"}]},{"group":"Provider App","pages":[{"openapi":"platform get /projects/{projectIdOrName}/provider-apps","title":"List provider apps","href":"/reference/provider-app/list-provider-apps"},{"openapi":"platform post /projects/{projectIdOrName}/provider-apps","title":"Create a new provider app","href":"/reference/provider-app/create-a-new-provider-app"},{"openapi":"platform delete /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Delete a provider app.","href":"/reference/provider-app/delete-a-provider-app"},{"openapi":"platform patch /projects/{projectIdOrName}/provider-apps/{providerAppId}","title":"Update a provider app","href":"/reference/provider-app/update-a-provider-app"}]},{"group":"Integration","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations","title":"List integrations","href":"/reference/integration/list-integrations"},{"openapi":"platform post /projects/{projectIdOrName}/integrations","title":"Create a new integration.","href":"/reference/integration/create-a-new-integration"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Get an integration by ID or name","href":"/reference/integration/get-an-integration-by-id-or-name"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationIdOrName}","title":"Delete an integration","href":"/reference/integration/delete-an-integration"},{"openapi":"platform put /projects/{projectIdOrName}/integrations:batch","title":"Batch upsert a group of integrations","href":"/reference/integration/batch-upsert-a-group-of-integrations"}]},{"group":"Revision","pages":[{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/revisions","title":"Create a new revision.","href":"/reference/revision/create-a-new-revision"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/revisions/{revisionId}:hydrate","title":"Get a hydrated revision","href":"/reference/revision/get-a-hydrated-revision"}]},{"group":"Installation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"List installations for an integration","href":"/reference/installation/list-installations-for-an-integration"},{"openapi":"platform post /projects/{projectIdOrName}/integrations/{integrationId}/installations","title":"Create a new installation","href":"/reference/installation/create-a-new-installation"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Get an installation","href":"/reference/installation/get-an-installation"},{"openapi":"platform delete /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Delete an installation","href":"/reference/installation/delete-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}","title":"Update an installation","href":"/reference/installation/update-an-installation"},{"openapi":"platform patch /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/config-content","title":"Update an installation object","href":"/reference/installation/update-an-installation-object"},{"openapi":"platform get /projects/{projectIdOrName}/installations","title":"List installations for a project","href":"/reference/installation/list-installations-for-a-project"}]},{"group":"Objects \u0026 Fields","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata","title":"Get object metadata via installation","href":"/reference/objects-\u0026-fields/get-object-metadata-via-installation"},{"openapi":"platform get /projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata","title":"Get object metadata via connection","href":"/reference/objects-\u0026-fields/get-object-metadata-via-connection"},{"openapi":"platform put /projects/{projectIdOrName}/integrations/{integrationId}/object-metadata","title":"Upsert custom fields for installation","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-installation"},{"openapi":"platform put /projects/{projectIdOrName}/providers/{provider}/object-metadata","title":"Upsert custom fields for connection","href":"/reference/objects-\u0026-fields/upsert-custom-fields-for-connection"}]},{"group":"Operation","pages":[{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/operations","title":"List operations","href":"/reference/operation/list-operations"},{"openapi":"platform get /projects/{projectIdOrName}/integrations/{integrationId}/installations/{installationId}/objects/{objectName}/backfill-progress","title":"Get backfill progress","href":"/reference/operation/get-backfill-progress"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}","title":"Get an operation","href":"/reference/operation/get-an-operation"},{"openapi":"platform get /projects/{projectIdOrName}/operations/{operationId}/logs","title":"List logs for an operation","href":"/reference/operation/list-logs-for-an-operation"}]},{"group":"Provider","pages":[{"openapi":"platform get /providers","title":"List providers","description":"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.\n","href":"/reference/provider/list-providers"},{"openapi":"platform get /providers/{provider}","title":"Get provider","href":"/reference/provider/get-provider"}]},{"group":"API Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/api-keys","title":"List API keys","description":null,"href":"/reference/api-key/list-api-keys"},{"openapi":"platform post /projects/{projectIdOrName}/api-keys","title":"Create a new API key","href":"/reference/api-key/create-a-new-api-key"},{"openapi":"platform get /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Get an API key","href":"/reference/api-key/get-an-api-key"},{"openapi":"platform delete /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Delete an API key","href":"/reference/api-key/delete-an-api-key"},{"openapi":"platform patch /projects/{projectIdOrName}/api-keys/{apiKey}","title":"Update an API key","href":"/reference/api-key/update-an-api-key"}]},{"group":"Destination","pages":[{"openapi":"platform get /projects/{projectIdOrName}/destinations","title":"List destinations","href":"/reference/destination/list-destinations"},{"openapi":"platform post /projects/{projectIdOrName}/destinations","title":"Create a new destination","href":"/reference/destination/create-a-new-destination"},{"openapi":"platform get /projects/{projectIdOrName}/destinations/{destination}","title":"Get a destination","href":"/reference/destination/get-a-destination"},{"openapi":"platform delete /projects/{projectIdOrName}/destinations/{destination}","title":"Delete a destination","href":"/reference/destination/delete-a-destination"},{"openapi":"platform patch /projects/{projectIdOrName}/destinations/{destination}","title":"Update a destination","href":"/reference/destination/update-a-destination"},{"openapi":"platform get /projects/{projectIdOrName}/topics","title":"List topics","href":"/reference/destination/list-topics"},{"openapi":"platform post /projects/{projectIdOrName}/topics","title":"Create a topic","href":"/reference/destination/create-a-topic"},{"openapi":"platform delete /projects/{projectIdOrName}/topics/{topicId}","title":"Delete a topic","href":"/reference/destination/delete-a-topic"},{"openapi":"platform patch /projects/{projectIdOrName}/topics/{topicId}","title":"Update a topic","href":"/reference/destination/update-a-topic"},{"openapi":"platform get /projects/{projectIdOrName}/topic-destination-routes","title":"List topic destination routes","href":"/reference/destination/list-topic-destination-routes"},{"openapi":"platform post /projects/{projectIdOrName}/topic-destination-routes","title":"Create a topic destination route","href":"/reference/destination/create-a-topic-destination-route"},{"openapi":"platform delete /projects/{projectIdOrName}/topic-destination-routes/{routeId}","title":"Delete a topic destination route","href":"/reference/destination/delete-a-topic-destination-route"}]},{"group":"Upload URL","pages":[{"openapi":"platform get /generate-upload-url","title":"Generate a signed URL to upload a zip file to.","href":"/reference/upload-url/generate-a-signed-url-to-upload-a-zip-file-to"}]},{"group":"Org","pages":[{"openapi":"platform post /orgs","title":"Create a new organization","href":"/reference/org/create-a-new-organization"},{"openapi":"platform get /orgs/{orgId}","title":"Get an organization","href":"/reference/org/get-an-organization"},{"openapi":"platform patch /orgs/{orgId}","title":"Update an organization","href":"/reference/org/update-an-organization"},{"openapi":"platform get /orgs/{orgId}/builders","title":"List builders for an organization","href":"/reference/org/list-builders-for-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites","title":"List invites for an organization","href":"/reference/org/list-invites-for-an-organization"},{"openapi":"platform post /orgs/{orgId}/invites","title":"Invite a user to an organization","href":"/reference/org/invite-a-user-to-an-organization"},{"openapi":"platform get /orgs/{orgId}/invites/{inviteId}","title":"Get an invite","href":"/reference/org/get-an-invite"},{"openapi":"platform delete /orgs/{orgId}/invites/{inviteId}","title":"Revoke an invite","href":"/reference/org/revoke-an-invite"},{"openapi":"platform post /orgs/{orgId}/memberships","title":"Add user to an organization","href":"/reference/org/add-user-to-an-organization"},{"openapi":"platform get /claimed-domains","title":"Check if a domain is claimed","href":"/reference/org/check-if-a-domain-is-claimed"},{"openapi":"platform post /claimed-domains","title":"Claim a domain","href":"/reference/org/claim-a-domain"},{"openapi":"platform get /orgs/{orgId}/claimed-domains","title":"List organization's claimed domains","href":"/reference/org/list-organizations-claimed-domains"}]},{"group":"User","pages":[{"openapi":"platform get /my-info","title":"Get information about the current user","href":"/reference/user/get-information-about-the-current-user"},{"openapi":"platform post /invites:accept","title":"Accept an invite","href":"/reference/user/accept-an-invite"}]},{"group":"Billing Account","pages":[{"openapi":"platform get /orgs/{orgId}/billingAccount","title":"Get the billing account for an organization","href":"/reference/billing-account/get-the-billing-account-for-an-organization"},{"openapi":"platform post /billingAccounts/{billingAccountId}/portalSession","title":"Create a portal session for a billing account","href":"/reference/billing-account/create-a-portal-session-for-a-billing-account"}]},{"group":"Notification","pages":[{"openapi":"platform get /projects/{projectIdOrName}/notification-event-topic-routes","title":"List notification event-topic routes","href":"/reference/notification/list-notification-event-topic-routes"},{"openapi":"platform post /projects/{projectIdOrName}/notification-event-topic-routes","title":"Create a notification event-topic route","href":"/reference/notification/create-a-notification-event-topic-route"},{"openapi":"platform delete /projects/{projectIdOrName}/notification-event-topic-routes/{routeId}","title":"Delete a notification event-topic route","href":"/reference/notification/delete-a-notification-event-topic-route"}]},{"group":"JWT Key","pages":[{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys","title":"List JWT keys","href":"/reference/jwt-key/list-jwt-keys"},{"openapi":"platform post /projects/{projectIdOrName}/jwt-keys","title":"Create a new JWT key","href":"/reference/jwt-key/create-a-new-jwt-key"},{"openapi":"platform get /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Get a specific JWT key","href":"/reference/jwt-key/get-a-specific-jwt-key"},{"openapi":"platform delete /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Delete a JWT key","href":"/reference/jwt-key/delete-a-jwt-key"},{"openapi":"platform patch /projects/{projectIdOrName}/jwt-keys/{keyId}","title":"Update a JWT key","href":"/reference/jwt-key/update-a-jwt-key"}]}]}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/provider-guides/overview"}]},{"tab":"Troubleshooting","pages":[{"title":"Troubleshooting","href":"/troubleshooting-guides/overview"}]}]},"basePath":"","title":"Get provider - Ampersand","buildId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","deploymentId":"dpl_9RFrWkXdFTJCytfx6jAofvAaEXr6","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-BgGj2PGS.js","utils-BhNOqRKb.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BAgRNUZo.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-CGkb0TPw.js","snippetPresets-ChLkL1a6.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-Ef10Jrbx.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DlVCnjU8.js","shallow-BA55zJxQ.js","getApiPlaygroundDisplay-DR09dKtp.js","CodeSnippet-BZ8J8Kll.js","CodeSnippets-CcguVheG.js","Page-C7x-eUfk.js","getPastedJson-D5UqeqBp.js","icon-DpD0l99C.js","MethodPill-Wg2NXsp_.js","DuplicateIcon-CCSyX8lh.js","createIcon-C4Ukv9HX.js","DynamicMarkdown-RhjEuCHC.js","SectionHeading-DL1MykRq.js","axios-vUo_bRtp.js","Markdown-BwQ4RMdp.js","dist-CiVXVcSh.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-Dic2Jtb2.js"]}