How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Ampersand Connection API

The Connection API from Ampersand — 3 operation(s) for connection.

Ampersand Connection API is one of 18 APIs that Ampersand publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Connection. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and authentication docs.

This API exposes 5 operations across 3 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

Requests are made against a single base URL, https://api.withampersand.com/v1.

5 operations 3 paths 12 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.withampersand.com
Authentication
API Key, HTTP Bearer
Resource Areas
1

Authentication & Security 2

Ampersand Connection API declares 2 security schemes for authenticating requests. An API key is passed in the header as X-Api-Key (APIKeyHeader). It accepts HTTP bearer tokens (JWT) (Bearer). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Connection 5
GET
/projects/{projectIdOrName}/connections
Ampersand List Connections
listConnections 4 params → 200404default
POST
/projects/{projectIdOrName}/connections:generate
Ampersand Generate a New Connection
generateConnection 1 param body → 201400422default
GET
/projects/{projectIdOrName}/connections/{connectionId}
Ampersand Get a Connection
getConnection 5 params → 200404default
PATCH
/projects/{projectIdOrName}/connections/{connectionId}
Ampersand Update a Connection.
updateConnection 2 params body → 200400default
DELETE
/projects/{projectIdOrName}/connections/{connectionId}
Ampersand Delete a Connection
deleteConnection 2 params → 204default

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are Connection (15 properties), ConnectionRequest (13 properties), ProviderApp (9 properties), Group (5 properties). Each schema is shown below with its type and property counts.

GenerateConnectionRequest
ProviderMetadataInfo
object
3 properties 2 required
UpdateConnectionRequest
object
Specify which fields to update in updateMask and provide corresponding values in connection. Fields in connection not listed in updateMask are ignored.
2 properties 2 required
ProviderApp
object
9 properties 5 required
Consumer
object
5 properties 4 required
Oauth2AuthorizationCodeTokensOnly
object
3 properties
Group
object
5 properties 4 required
Oauth2AuthorizationCode
object
3 properties
ProviderAppMetadata
object
Provider-specific configuration that extends the standard OAuth flow.
2 properties
ConnectionRequest
object
13 properties
Connection
object
15 properties 8 required
ProviderMetadata
object

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ampersand-connection-api-openapi.yml Raw ↑

Other APIs Ampersand publishes across the network.

Ampersand API Key API
Ampersand Billing Account API
Ampersand Destination API
Ampersand Installation API
Ampersand Integration API
Ampersand JWT Key API
Ampersand Notification API
Ampersand OAuth API
Ampersand Objects & Fields API
Ampersand Operation API
Ampersand Org API
Ampersand Project API
Where this information came from

This is an independent, third-party profile of Ampersand Connection API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.