Create a new API key

APIKeyHeader

A Problem Details object (RFC 9457).

Additional properties specific to the problem type may be present.


Ampersand

Overview

Quickstart

Concepts

Object and field mapping

Embed UI components

Terminology

Dev and prod environments

Access via API key

API Reference

Start building now

Sign in

Read Actions

Write Actions

Proxy Actions

Subscribe actions

Webhook destinations

Acuity Scheduling

Aha!

Aircall

Airtable

Anthropic

Apollo

Asana

Ashby

Atlassian

Attio

AWeber

Bird (MessageBird)

Blueshift

Blueshift (EU)

Brevo

Bynder

Calendly

Campaign Monitor

Capsule

ChartMogul

Clari

ClickUp

Close

Constant Contact

Copper

Crunchbase

Customer.io Journeys App

Customer.io Journeys Track

Delighted

Discord

Dixa

Docusign

Drift

Dropbox

Dropbox Sign

Dynamics 365 Business Central

Dynamics 365 CRM

Facebook

Figma

Formstack

Front

Geckoboard

GetResponse

GitLab

Gong

Google

Gorgias

GoToWebinar

Groove

Guru

Help Scout Mailbox

HeyReach

Hive

HubSpot

Insightly

Instantly

Intercom

Ironclad

Iterable

Jira

Jotform

Keap

Klaviyo

Lever

LinkedIn

Lemlist

Mailgun

Marketo

Microsoft

Miro

Mixmax

Monday

Mural

Notion

Nutshell

OpenAI

Outreach

Paddle

Paddle Sandbox

Pinterest

Pipedrive

Pipeliner

Podium

Rebilly

Recurly

RingCentral

Salesforce

Salesloft

Seismic

Sellsy

SendGrid

ServiceNow

Smartlead

Smartsheet

Snapchat Ads

Write records

Triggers reading data from a SaaS instance. See [Trigger a read](https://docs.withampersand.com/define-integrations/read-actions#trigger-a-read) for details.

Trigger a read

If a read action has delivery mode set to onRequest, then use this endpoint to request for more results. Learn more in [Delivery modes](https://docs.withampersand.com/define-integrations/read-actions#delivery-modes).

Deliver results

Generate a URL for the browser to render to kick off OAuth flow.

Get URL for OAuth flow

List all projects that the API key or user credential has access to

Create a new project

Get a project

Delete a project

Update a project

List provider apps

Create a new provider app

Delete a provider app

Update a provider app

List integrations

Create a new integration

Delete an integration

Batch upsert a group of integrations

Create a new revision

Hydrate a revision with information from the consumer's SaaS instance.

Hydrate a revision

List installations

Create a new installation

Get an installation

Delete an installation

Update an installation

Retrieves metadata about an object in a customer's SaaS instance, including its fields.
This endpoint requires that an Installation exists for the given groupRef.
It applies object mappings.


Get object metadata for installation

Retrieves metadata about an object in a customer's SaaS instance, including its fields.
This endpoint only requires that a Connection exists for the given groupRef.
It does not apply any object mappings.


Get object metadata for connection

List operations

Get an operation

List logs for an operation

List providers

Get provider

List API keys

Get an API key

Delete an API key

Update an API key

List connections

For providers which support 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.

Generate a new connection

Get a connection

Delete a connection

Create a new group

Create a new consumer

List destinations

Create a new destination

Get a destination

Delete a destination

Update a destination

Generate a signed URL to upload a zip file to.

Create a new organization

Get an organization

Update an organization

List builders for an organization

List invites for an organization

Invite a user to an organization

Get an invite

Revoke an invite

Get information about the current user

Accept an invite

Get the billing account for an organization

Create a portal session for a billing account

Authentication

WRITE API

READ API

PLATFORM API

Create a new API key

Authorizations

Path Parameters

Body

Response