Skip to main content
Welcome to the Ampersand API reference docs! If you are new to Ampersand, this is not the best place to get started. Depending on your use case, you may not actually need to use the API. Please check out our Quickstart guide instead. Ampersand offers 4 APIs:
  • Write API: for writing data to your customer’s SaaS instance. Learn more in Write Actions.
  • Read API: for advanced read use cases like triggering an off-schedule read of your customer’s SaaS instance, or for managing read schedules. If you simply want to do scheduled reads, you do not need to use this API. Please refer to Read Actions.
  • Platform API: for advanced use cases in managing integrations and customer installations. Most customers do not use the Platform API directly, but interact with the Ampersand Dashboard, CLI or UI library instead.
  • Proxy API: for making direct API requests to your customer’s SaaS instance without any transformations. Learn more in Proxy Actions.
If you prefer exploring APIs interactively, check out the official Ampersand Postman Collection. Run In Postman