# Ampersand ## Docs - [Access via JWT](https://docs.withampersand.com/api/jwt-auth.md) - [Access via API key](https://docs.withampersand.com/api/key-auth.md) - [Overview](https://docs.withampersand.com/api/overview.md) - [Overview](https://docs.withampersand.com/cli/overview.md) - [Reference](https://docs.withampersand.com/cli/reference.md) - [Concepts](https://docs.withampersand.com/concepts.md) - [BigQuery](https://docs.withampersand.com/customer-guides/bigquery.md) - [Google (workspace delegation)](https://docs.withampersand.com/customer-guides/google-workspace-delegation.md) - [Housecall Pro](https://docs.withampersand.com/customer-guides/housecallPro.md) - [HubSpot](https://docs.withampersand.com/customer-guides/hubspot.md) - [Loxo](https://docs.withampersand.com/customer-guides/loxo.md) - [Marketo](https://docs.withampersand.com/customer-guides/marketo.md) - [NetSuite](https://docs.withampersand.com/customer-guides/netsuite.md) - [Overview](https://docs.withampersand.com/customer-guides/overview.md) - [Salesforce](https://docs.withampersand.com/customer-guides/salesforce.md) - [Salesforce (JWT authentication)](https://docs.withampersand.com/customer-guides/salesforce-jwt.md) - [Snowflake](https://docs.withampersand.com/customer-guides/snowflake.md) - [Update a connection](https://docs.withampersand.com/customer-guides/update-connection.md) - [Kinesis destinations](https://docs.withampersand.com/destinations/kinesis.md) - [Overview](https://docs.withampersand.com/destinations/overview.md) - [Webhook destinations](https://docs.withampersand.com/destinations/webhooks.md) - [Dev and prod environments](https://docs.withampersand.com/dev-and-prod-environments.md) - [Prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components.md) - [Headless UI library](https://docs.withampersand.com/headless.md) - [Manage customer schemas](https://docs.withampersand.com/manage-customer-schemas.md) - [Manifest schema reference](https://docs.withampersand.com/manifest-reference.md) - [Notification payloads](https://docs.withampersand.com/notifications/notification-payloads.md) - [Overview](https://docs.withampersand.com/notifications/overview.md) - [Object and field mapping](https://docs.withampersand.com/object-and-field-mapping.md) - [Overview](https://docs.withampersand.com/overview.md) - [Acuity Scheduling](https://docs.withampersand.com/provider-guides/acuityScheduling.md) - [Aha!](https://docs.withampersand.com/provider-guides/aha.md) - [Aircall](https://docs.withampersand.com/provider-guides/aircall.md) - [Airtable](https://docs.withampersand.com/provider-guides/airtable.md) - [Amplemarket](https://docs.withampersand.com/provider-guides/amplemarket.md) - [Amplitude](https://docs.withampersand.com/provider-guides/amplitude.md) - [Anthropic](https://docs.withampersand.com/provider-guides/anthropic.md) - [Apollo](https://docs.withampersand.com/provider-guides/apollo.md) - [Asana](https://docs.withampersand.com/provider-guides/asana.md) - [Ashby](https://docs.withampersand.com/provider-guides/ashby.md) - [Atlassian](https://docs.withampersand.com/provider-guides/atlassian.md) - [Attio](https://docs.withampersand.com/provider-guides/attio.md) - [Avoma](https://docs.withampersand.com/provider-guides/avoma.md) - [AWeber](https://docs.withampersand.com/provider-guides/aweber.md) - [AWS](https://docs.withampersand.com/provider-guides/aws.md) - [Bentley](https://docs.withampersand.com/provider-guides/bentley.md) - [BigQuery](https://docs.withampersand.com/provider-guides/bigquery.md) - [Bird (MessageBird)](https://docs.withampersand.com/provider-guides/bird.md) - [Bitbucket](https://docs.withampersand.com/provider-guides/bitbucket.md) - [Blackbaud](https://docs.withampersand.com/provider-guides/blackbaud.md) - [Blueshift](https://docs.withampersand.com/provider-guides/blueshift.md) - [Blueshift (EU)](https://docs.withampersand.com/provider-guides/blueshiftEU.md) - [Box](https://docs.withampersand.com/provider-guides/box.md) - [Braintree](https://docs.withampersand.com/provider-guides/braintree.md) - [Braze](https://docs.withampersand.com/provider-guides/braze.md) - [Breakcold](https://docs.withampersand.com/provider-guides/breakcold.md) - [Brevo](https://docs.withampersand.com/provider-guides/brevo.md) - [Bynder](https://docs.withampersand.com/provider-guides/bynder.md) - [Calendly](https://docs.withampersand.com/provider-guides/calendly.md) - [Campaign Monitor](https://docs.withampersand.com/provider-guides/campaignMonitor.md) - [Capsule](https://docs.withampersand.com/provider-guides/capsule.md) - [ChargeOver](https://docs.withampersand.com/provider-guides/chargeOver.md) - [Chargebee](https://docs.withampersand.com/provider-guides/chargebee.md) - [ChartMogul](https://docs.withampersand.com/provider-guides/chartMogul.md) - [ChiliPiper](https://docs.withampersand.com/provider-guides/chilipiper.md) - [Chorus](https://docs.withampersand.com/provider-guides/chorus.md) - [Clari](https://docs.withampersand.com/provider-guides/clari.md) - [Clari Copilot](https://docs.withampersand.com/provider-guides/clariCopilot.md) - [ClickUp](https://docs.withampersand.com/provider-guides/clickup.md) - [Close](https://docs.withampersand.com/provider-guides/close.md) - [CloudTalk](https://docs.withampersand.com/provider-guides/cloudtalk.md) - [Coda](https://docs.withampersand.com/provider-guides/coda.md) - [ConnectWise](https://docs.withampersand.com/provider-guides/connectWise.md) - [Constant Contact](https://docs.withampersand.com/provider-guides/constantContact.md) - [Copper](https://docs.withampersand.com/provider-guides/copper.md) - [Coupa](https://docs.withampersand.com/provider-guides/coupa.md) - [Crunchbase](https://docs.withampersand.com/provider-guides/crunchbase.md) - [Customer.io Journeys App](https://docs.withampersand.com/provider-guides/customerJourneysApp.md) - [Customer.io Journeys Track](https://docs.withampersand.com/provider-guides/customerJourneysTrack.md) - [Delighted](https://docs.withampersand.com/provider-guides/delighted.md) - [DevRev](https://docs.withampersand.com/provider-guides/devrev.md) - [Discord](https://docs.withampersand.com/provider-guides/discord.md) - [Discourse](https://docs.withampersand.com/provider-guides/discourse.md) - [Dixa](https://docs.withampersand.com/provider-guides/dixa.md) - [Docusign](https://docs.withampersand.com/provider-guides/docusign.md) - [Domo](https://docs.withampersand.com/provider-guides/domo.md) - [Drift](https://docs.withampersand.com/provider-guides/drift.md) - [Dropbox](https://docs.withampersand.com/provider-guides/dropbox.md) - [Dropbox Sign](https://docs.withampersand.com/provider-guides/dropboxsign.md) - [Dynamics 365 Business Central](https://docs.withampersand.com/provider-guides/dynamicsBusinessCentral.md) - [Dynamics 365 CRM](https://docs.withampersand.com/provider-guides/dynamicsCRM.md) - [EmailBison](https://docs.withampersand.com/provider-guides/emailBison.md) - [Fathom](https://docs.withampersand.com/provider-guides/fathom.md) - [Figma](https://docs.withampersand.com/provider-guides/figma.md) - [Fireflies](https://docs.withampersand.com/provider-guides/fireflies.md) - [Flatfile](https://docs.withampersand.com/provider-guides/flatfile.md) - [Formstack](https://docs.withampersand.com/provider-guides/formstack.md) - [Four/Four](https://docs.withampersand.com/provider-guides/fourFour.md) - [Freshchat](https://docs.withampersand.com/provider-guides/freshchat.md) - [Freshdesk](https://docs.withampersand.com/provider-guides/freshdesk.md) - [Front](https://docs.withampersand.com/provider-guides/front.md) - [G2](https://docs.withampersand.com/provider-guides/g2.md) - [Geckoboard](https://docs.withampersand.com/provider-guides/geckoboard.md) - [GetResponse](https://docs.withampersand.com/provider-guides/getResponse.md) - [GitHub](https://docs.withampersand.com/provider-guides/github.md) - [GitLab](https://docs.withampersand.com/provider-guides/gitlab.md) - [GoTo](https://docs.withampersand.com/provider-guides/goTo.md) - [Gong](https://docs.withampersand.com/provider-guides/gong.md) - [Google](https://docs.withampersand.com/provider-guides/google.md) - [Google (workspace delegation)](https://docs.withampersand.com/provider-guides/google-workspace-delegation.md) - [Gorgias](https://docs.withampersand.com/provider-guides/gorgias.md) - [Granola](https://docs.withampersand.com/provider-guides/granola.md) - [Groove](https://docs.withampersand.com/provider-guides/groove.md) - [Guru](https://docs.withampersand.com/provider-guides/guru.md) - [HappyFox](https://docs.withampersand.com/provider-guides/happyfox.md) - [Help Scout Mailbox](https://docs.withampersand.com/provider-guides/helpScoutMailbox.md) - [HeyReach](https://docs.withampersand.com/provider-guides/heyreach.md) - [HighLevel](https://docs.withampersand.com/provider-guides/highlevel.md) - [Hightouch](https://docs.withampersand.com/provider-guides/hightouch.md) - [Hive](https://docs.withampersand.com/provider-guides/hive.md) - [Housecall Pro](https://docs.withampersand.com/provider-guides/housecallPro.md) - [HubSpot](https://docs.withampersand.com/provider-guides/hubspot.md) - [Hunter](https://docs.withampersand.com/provider-guides/hunter.md) - [Insightly](https://docs.withampersand.com/provider-guides/insightly.md) - [Instantly](https://docs.withampersand.com/provider-guides/instantly.md) - [Intercom](https://docs.withampersand.com/provider-guides/intercom.md) - [Ironclad](https://docs.withampersand.com/provider-guides/ironclad.md) - [Iterable](https://docs.withampersand.com/provider-guides/iterable.md) - [Jira](https://docs.withampersand.com/provider-guides/jira.md) - [Jobber](https://docs.withampersand.com/provider-guides/jobber.md) - [Join.me](https://docs.withampersand.com/provider-guides/joinMe.md) - [Jotform](https://docs.withampersand.com/provider-guides/jotform.md) - [JustCall](https://docs.withampersand.com/provider-guides/justCall.md) - [Kaseya VSAX](https://docs.withampersand.com/provider-guides/kaseyaVSAX.md) - [Keap](https://docs.withampersand.com/provider-guides/keap.md) - [Kit](https://docs.withampersand.com/provider-guides/kit.md) - [Klaviyo](https://docs.withampersand.com/provider-guides/klaviyo.md) - [Lemlist](https://docs.withampersand.com/provider-guides/lemlist.md) - [Lever](https://docs.withampersand.com/provider-guides/lever.md) - [Linear](https://docs.withampersand.com/provider-guides/linear.md) - [LinkedIn](https://docs.withampersand.com/provider-guides/linkedin.md) - [Livestorm](https://docs.withampersand.com/provider-guides/livestorm.md) - [Loxo](https://docs.withampersand.com/provider-guides/loxo.md) - [Mailgun](https://docs.withampersand.com/provider-guides/mailgun.md) - [Marketo](https://docs.withampersand.com/provider-guides/marketo.md) - [Meta](https://docs.withampersand.com/provider-guides/meta.md) - [Microsoft](https://docs.withampersand.com/provider-guides/microsoft.md) - [Miro](https://docs.withampersand.com/provider-guides/miro.md) - [Mixmax](https://docs.withampersand.com/provider-guides/mixmax.md) - [Mixpanel](https://docs.withampersand.com/provider-guides/mixpanel.md) - [Monday](https://docs.withampersand.com/provider-guides/monday.md) - [Mural](https://docs.withampersand.com/provider-guides/mural.md) - [NetSuite](https://docs.withampersand.com/provider-guides/netsuite.md) - [NetSuite (M2M)](https://docs.withampersand.com/provider-guides/netsuite-m2m.md) - [Notion](https://docs.withampersand.com/provider-guides/notion.md) - [Nutshell](https://docs.withampersand.com/provider-guides/nutshell.md) - [Odoo](https://docs.withampersand.com/provider-guides/odoo.md) - [Okta](https://docs.withampersand.com/provider-guides/okta.md) - [OpenAI](https://docs.withampersand.com/provider-guides/openAI.md) - [Outplay](https://docs.withampersand.com/provider-guides/outplay.md) - [Outreach](https://docs.withampersand.com/provider-guides/outreach.md) - [Overview](https://docs.withampersand.com/provider-guides/overview.md) - [Paddle](https://docs.withampersand.com/provider-guides/paddle.md) - [Paddle Sandbox](https://docs.withampersand.com/provider-guides/paddleSandbox.md) - [PhoneBurner](https://docs.withampersand.com/provider-guides/phoneBurner.md) - [Pinterest](https://docs.withampersand.com/provider-guides/pinterest.md) - [Pipedrive](https://docs.withampersand.com/provider-guides/pipedrive.md) - [Pipeliner](https://docs.withampersand.com/provider-guides/pipeliner.md) - [Podium](https://docs.withampersand.com/provider-guides/podium.md) - [Productboard](https://docs.withampersand.com/provider-guides/productBoard.md) - [Pylon](https://docs.withampersand.com/provider-guides/pylon.md) - [QuickBooks](https://docs.withampersand.com/provider-guides/quickbooks.md) - [Ramp](https://docs.withampersand.com/provider-guides/ramp.md) - [Rebilly](https://docs.withampersand.com/provider-guides/rebilly.md) - [Recurly](https://docs.withampersand.com/provider-guides/recurly.md) - [RevenueCat](https://docs.withampersand.com/provider-guides/revenuecat.md) - [RingCentral](https://docs.withampersand.com/provider-guides/ringCentral.md) - [Sage Intacct](https://docs.withampersand.com/provider-guides/sageIntacct.md) - [Salesfinity](https://docs.withampersand.com/provider-guides/salesfinity.md) - [Salesflare](https://docs.withampersand.com/provider-guides/salesflare.md) - [Salesforce](https://docs.withampersand.com/provider-guides/salesforce.md) - [Salesforce (JWT authentication)](https://docs.withampersand.com/provider-guides/salesforce-jwt.md) - [Salesloft](https://docs.withampersand.com/provider-guides/salesloft.md) - [Segment](https://docs.withampersand.com/provider-guides/segment.md) - [Seismic](https://docs.withampersand.com/provider-guides/seismic.md) - [Sellsy](https://docs.withampersand.com/provider-guides/sellsy.md) - [SendGrid](https://docs.withampersand.com/provider-guides/sendGrid.md) - [ServiceNow](https://docs.withampersand.com/provider-guides/serviceNow.md) - [Shopify](https://docs.withampersand.com/provider-guides/shopify.md) - [Slack](https://docs.withampersand.com/provider-guides/slack.md) - [Smartlead](https://docs.withampersand.com/provider-guides/smartlead.md) - [Smartsheet](https://docs.withampersand.com/provider-guides/smartsheet.md) - [Snapchat Ads](https://docs.withampersand.com/provider-guides/snapchatAds.md) - [Snowflake](https://docs.withampersand.com/provider-guides/snowflake.md) - [SolarWinds Service Desk](https://docs.withampersand.com/provider-guides/solarwindsServiceDesk.md) - [Stripe](https://docs.withampersand.com/provider-guides/stripe.md) - [SuperSend](https://docs.withampersand.com/provider-guides/superSend.md) - [Survey Monkey](https://docs.withampersand.com/provider-guides/surveyMonkey.md) - [Talkdesk](https://docs.withampersand.com/provider-guides/talkdesk.md) - [Teamleader](https://docs.withampersand.com/provider-guides/teamleader.md) - [Teamwork](https://docs.withampersand.com/provider-guides/teamwork.md) - [Timely](https://docs.withampersand.com/provider-guides/timely.md) - [Tipalti](https://docs.withampersand.com/provider-guides/tipalti.md) - [Vtiger](https://docs.withampersand.com/provider-guides/vtiger.md) - [Webex](https://docs.withampersand.com/provider-guides/webex.md) - [Webflow](https://docs.withampersand.com/provider-guides/webflow.md) - [Whereby](https://docs.withampersand.com/provider-guides/whereby.md) - [WordPress](https://docs.withampersand.com/provider-guides/wordpress.md) - [Wrike](https://docs.withampersand.com/provider-guides/wrike.md) - [Xero](https://docs.withampersand.com/provider-guides/xero.md) - [Zendesk Support](https://docs.withampersand.com/provider-guides/zendeskSupport.md) - [Zoho](https://docs.withampersand.com/provider-guides/zoho.md) - [Zoom](https://docs.withampersand.com/provider-guides/zoom.md) - [Proxy actions](https://docs.withampersand.com/proxy-actions.md) - [Quickstart](https://docs.withampersand.com/quickstart.md) - [Read actions](https://docs.withampersand.com/read-actions.md) - [Create a new API key](https://docs.withampersand.com/reference/api-key/create-a-new-api-key.md) - [Delete an API key](https://docs.withampersand.com/reference/api-key/delete-an-api-key.md) - [Get an API key](https://docs.withampersand.com/reference/api-key/get-an-api-key.md) - [List API keys](https://docs.withampersand.com/reference/api-key/list-api-keys.md) - [Update an API key](https://docs.withampersand.com/reference/api-key/update-an-api-key.md) - [Create a portal session for a billing account](https://docs.withampersand.com/reference/billing-account/create-a-portal-session-for-a-billing-account.md) - [Get the billing account for an organization](https://docs.withampersand.com/reference/billing-account/get-the-billing-account-for-an-organization.md) - [Delete a connection](https://docs.withampersand.com/reference/connection/delete-a-connection.md) - [Generate a new connection](https://docs.withampersand.com/reference/connection/generate-a-new-connection.md): All auth schemes are supported, but for OAuth2 Authorization Code, it is recommended that you use the [/oauth-connect endpoint](https://docs.withampersand.com/reference/oauth/get-url-for-oauth-flow) instead, unless you already have the refresh token and are importing it into Ampersand. - [Get a connection](https://docs.withampersand.com/reference/connection/get-a-connection.md) - [List connections](https://docs.withampersand.com/reference/connection/list-connections.md) - [Update a connection.](https://docs.withampersand.com/reference/connection/update-a-connection.md): Rotate credentials or update metadata (such as the provider workspace reference) for an existing connection. - [Create a new destination](https://docs.withampersand.com/reference/destination/create-a-new-destination.md) - [Create a topic](https://docs.withampersand.com/reference/destination/create-a-topic.md) - [Create a topic destination route](https://docs.withampersand.com/reference/destination/create-a-topic-destination-route.md) - [Delete a destination](https://docs.withampersand.com/reference/destination/delete-a-destination.md) - [Delete a topic](https://docs.withampersand.com/reference/destination/delete-a-topic.md) - [Delete a topic destination route](https://docs.withampersand.com/reference/destination/delete-a-topic-destination-route.md) - [Get a destination](https://docs.withampersand.com/reference/destination/get-a-destination.md) - [List destinations](https://docs.withampersand.com/reference/destination/list-destinations.md) - [List topic destination routes](https://docs.withampersand.com/reference/destination/list-topic-destination-routes.md) - [List topics](https://docs.withampersand.com/reference/destination/list-topics.md) - [Update a destination](https://docs.withampersand.com/reference/destination/update-a-destination.md) - [Update a topic](https://docs.withampersand.com/reference/destination/update-a-topic.md) - [Create a new installation](https://docs.withampersand.com/reference/installation/create-a-new-installation.md): Install an integration for a specific group. The group must already have a SaaS connection — either provide its `connectionId`, or omit it to use the group's default. To create a connection, use the [OAuth Connect endpoint](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-… - [Delete an installation](https://docs.withampersand.com/reference/installation/delete-an-installation.md): Delete an Installation. This will also delete the associated Connection if it is not used by any other Installations. - [Get an installation](https://docs.withampersand.com/reference/installation/get-an-installation.md): Retrieves a single installation by ID, including its connection details, config, and health status. - [List installations for a project](https://docs.withampersand.com/reference/installation/list-installations-for-a-project.md): Lists all installations across every integration in a project, giving you a complete view of all active customer integrations. To narrow results to a single integration, use listInstallations instead. - [List installations for an integration](https://docs.withampersand.com/reference/installation/list-installations-for-an-integration.md): Lists all installations for a specific integration within a project. To list installations across all integrations, use listInstallationsForProject instead. - [Update an installation](https://docs.withampersand.com/reference/installation/update-an-installation.md): Update an installation using field masks. Note: subscribe config changes trigger a subscription change in the provider's system, which typically takes 1-2 minutes but may take up to 10 minutes. - [Update an installation object](https://docs.withampersand.com/reference/installation/update-an-installation-object.md): Updates a single object's configuration within an installation using JSON Patch syntax. - [Batch upsert a group of integrations](https://docs.withampersand.com/reference/integration/batch-upsert-a-group-of-integrations.md): This endpoint is used by the Ampersand CLI to batch upsert integrations. We recommend using the [CLI's deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly. - [Create a new integration.](https://docs.withampersand.com/reference/integration/create-a-new-integration.md) - [Delete an integration](https://docs.withampersand.com/reference/integration/delete-an-integration.md): Delete an integration and all its installations. - [Get an integration by ID or name](https://docs.withampersand.com/reference/integration/get-an-integration-by-id-or-name.md) - [List integrations](https://docs.withampersand.com/reference/integration/list-integrations.md) - [Create a new JWT key](https://docs.withampersand.com/reference/jwt-key/create-a-new-jwt-key.md): Creates a new JWT key for the specified project with RSA public key for token verification - [Delete a JWT key](https://docs.withampersand.com/reference/jwt-key/delete-a-jwt-key.md): Permanently deletes a JWT key from the specified project - [Get a specific JWT key](https://docs.withampersand.com/reference/jwt-key/get-a-specific-jwt-key.md): Retrieves a specific JWT key by its ID within the specified project - [List JWT keys](https://docs.withampersand.com/reference/jwt-key/list-jwt-keys.md): Retrieves all JWT keys for the specified project, with optional filtering for active keys only - [Update a JWT key](https://docs.withampersand.com/reference/jwt-key/update-a-jwt-key.md): Updates specific fields of a JWT key using field masks. Currently supports updating the 'active' status and 'name' field. - [Create a notification event-topic route](https://docs.withampersand.com/reference/notification/create-a-notification-event-topic-route.md) - [Delete a notification event-topic route](https://docs.withampersand.com/reference/notification/delete-a-notification-event-topic-route.md) - [List notification event-topic routes](https://docs.withampersand.com/reference/notification/list-notification-event-topic-routes.md) - [Generate OAuth authorization URL](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url.md): Generate a URL for the browser to render to kick off OAuth flow. You can use this endpoint as an alternative to the [prebuilt UI components](https://docs.withampersand.com/embeddable-ui-components). - [Generate OAuth authorization URL for existing connection](https://docs.withampersand.com/reference/oauth/generate-oauth-authorization-url-for-existing-connection.md): Generate a URL for the browser to render to kick off an OAuth flow that updates an existing connection. Use this when the connection's credentials need to be refreshed. To start an OAuth flow without specifying a connection ID, use the [/oauth-connect endpoint](https://docs.withampersand.com/referen… - [Get object metadata via connection](https://docs.withampersand.com/reference/objects-&-fields/get-object-metadata-via-connection.md): Retrieves metadata about an object in a customer's SaaS instance, including its fields. A connection must exist for the given `groupRef` and `provider`. For Salesforce, nested fields may be included using JSONPath bracket notation (e.g. `$['billingaddress']['city']`). - [Get object metadata via installation](https://docs.withampersand.com/reference/objects-&-fields/get-object-metadata-via-installation.md): Retrieves metadata about an object in a customer's SaaS instance, including its fields. An installation must exist for the given `groupRef` and `integrationId`. The `objectName` can be either the mapped name from your integration config or the native provider name. For Salesforce, nested fields may… - [Upsert custom fields for connection](https://docs.withampersand.com/reference/objects-&-fields/upsert-custom-fields-for-connection.md): Create or update fields in the SaaS instance tied to a connection. Only HubSpot and Salesforce are supported currently. - [Upsert custom fields for installation](https://docs.withampersand.com/reference/objects-&-fields/upsert-custom-fields-for-installation.md): Create or update fields in the SaaS instance tied to an installation. Only HubSpot and Salesforce are supported currently. - [Get an operation](https://docs.withampersand.com/reference/operation/get-an-operation.md): Retrieve a single operation by ID. An operation represents an async read, write, or subscribe action for an installation. Use this endpoint to poll for status, inspect the result summary, or fetch metadata such as backfill progress or write outcome details. - [Get backfill progress](https://docs.withampersand.com/reference/operation/get-backfill-progress.md): Retrieve backfill progress (records processed, estimated total) for an object. Use to track progress of an initial data sync. - [List logs for an operation](https://docs.withampersand.com/reference/operation/list-logs-for-an-operation.md) - [List operations](https://docs.withampersand.com/reference/operation/list-operations.md) - [Add user to an organization](https://docs.withampersand.com/reference/org/add-user-to-an-organization.md): Adds a builder to an organization. Two authorization modes - Org owner inviting another user, or self-joining via claimed domain (authenticated user's email domain should be claimed by this organization). - [Check if a domain is claimed](https://docs.withampersand.com/reference/org/check-if-a-domain-is-claimed.md): Returns claimed domain information if authenticated user is an owner of the organization that claimed the domain, or if the user's email domain matches the claimed domain. - [Claim a domain](https://docs.withampersand.com/reference/org/claim-a-domain.md): Claim a domain for an organization. Accepts email, domain, or URL. - [Create a new organization](https://docs.withampersand.com/reference/org/create-a-new-organization.md) - [Get an invite](https://docs.withampersand.com/reference/org/get-an-invite.md) - [Get an organization](https://docs.withampersand.com/reference/org/get-an-organization.md) - [Invite a user to an organization](https://docs.withampersand.com/reference/org/invite-a-user-to-an-organization.md) - [List builders for an organization](https://docs.withampersand.com/reference/org/list-builders-for-an-organization.md) - [List invites for an organization](https://docs.withampersand.com/reference/org/list-invites-for-an-organization.md) - [List organization's claimed domains](https://docs.withampersand.com/reference/org/list-organizations-claimed-domains.md): Get all domains claimed by a specific organization - [Revoke an invite](https://docs.withampersand.com/reference/org/revoke-an-invite.md) - [Update an organization](https://docs.withampersand.com/reference/org/update-an-organization.md) - [Create a new project](https://docs.withampersand.com/reference/project/create-a-new-project.md): Creates a new project within an organization. A project is a container for provider apps, integrations, and connections. - [Get a project](https://docs.withampersand.com/reference/project/get-a-project.md): Get a project by its ID or name. - [List projects](https://docs.withampersand.com/reference/project/list-projects.md): Lists projects your credentials can access. - [Update a project](https://docs.withampersand.com/reference/project/update-a-project.md): Update a project's mutable fields using field masks. Currently, the updatable fields are `appName` (the display name shown to end users) and `name` (the unique project identifier). - [Create a new provider app](https://docs.withampersand.com/reference/provider-app/create-a-new-provider-app.md) - [Delete a provider app.](https://docs.withampersand.com/reference/provider-app/delete-a-provider-app.md) - [List provider apps](https://docs.withampersand.com/reference/provider-app/list-provider-apps.md) - [Update a provider app](https://docs.withampersand.com/reference/provider-app/update-a-provider-app.md) - [Get provider](https://docs.withampersand.com/reference/provider/get-provider.md): Returns information about a single provider. No authentication is required. - [List providers](https://docs.withampersand.com/reference/provider/list-providers.md): 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. - [Deliver results](https://docs.withampersand.com/reference/read/deliver-results.md): This endpoint is deprecated. If you wish you trigger a read (including backfills), use the [trigger a read](https://docs.withampersand.com/reference/read/trigger-a-read) endpoint instead. - [Pause reads for an installation](https://docs.withampersand.com/reference/read/pause-reads-for-an-installation.md): Pauses all scheduled reads for an installation. If reads are already paused, this will be a no-op. Accepts specific objects to pause reads for in the request body. - [Trigger a read](https://docs.withampersand.com/reference/read/trigger-a-read.md): Triggers reading data from a SaaS instance. See [Trigger a read](https://docs.withampersand.com/define-integrations/read-actions#trigger-a-read) for details. If you want scheduled reads or automatic backfills instead, you [can define them in the manifest](https://docs.withampersand.com/read-actions#… - [Unpause reads for an installation](https://docs.withampersand.com/reference/read/unpause-reads-for-an-installation.md): Unpauses all scheduled reads for an installation. If no reads were paused, this will be a no-op. Accepts specific objects to unpause reads for in the request body. - [Create a new revision.](https://docs.withampersand.com/reference/revision/create-a-new-revision.md): We recommend using the [CLI's deploy command](https://docs.withampersand.com/cli/overview#deploy-integrations) rather than this API endpoint directly, unless you have an advanced use case. - [Get a hydrated revision](https://docs.withampersand.com/reference/revision/get-a-hydrated-revision.md): Returns the integration revision enriched with live field metadata from the consumer's connected SaaS instance, such as available fields, display names, and type for each object defined in the integration. - [Search records](https://docs.withampersand.com/reference/search/search-records.md): Search records in a SaaS instance. - [Generate a signed URL to upload a zip file to.](https://docs.withampersand.com/reference/upload-url/generate-a-signed-url-to-upload-a-zip-file-to.md) - [Accept an invite](https://docs.withampersand.com/reference/user/accept-an-invite.md) - [Get information about the current user](https://docs.withampersand.com/reference/user/get-information-about-the-current-user.md) - [Write records](https://docs.withampersand.com/reference/write/write-records.md): Create, update, or delete records in a SaaS instance. Create and update support synchronous or asynchronous mode; delete is synchronous only. See [Write actions](https://docs.withampersand.com/write-actions) for details. - [Search actions](https://docs.withampersand.com/search-actions.md) - [Subscribe actions](https://docs.withampersand.com/subscribe-actions.md) - [Terminology](https://docs.withampersand.com/terminology.md) - [Build your own unified API](https://docs.withampersand.com/unified-api.md) - [Use with coding agent](https://docs.withampersand.com/use-with-ai-ide.md) - [Write actions](https://docs.withampersand.com/write-actions.md) ## OpenAPI Specs - [platform](https://docs.withampersand.com/platform.json) - [write](https://docs.withampersand.com/write.json) - [search](https://docs.withampersand.com/search.json) - [read](https://docs.withampersand.com/read.json) - [openapi](https://docs.withampersand.com/api-reference/openapi.json)