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 Objects & Fields API

The Objects & Fields API from Ampersand — 4 operation(s) for objects & fields.

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

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

This API exposes 4 operations across 4 paths, and defines 9 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.

4 operations 4 paths 9 schemas 2 GET2 PUT

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 Objects & Fields 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 4

Across 4 paths, the API surfaces 4 operations — 2 GET, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Objects & Fields 4
GET
/projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata
Ampersand Get Object Metadata via Installation
getObjectMetadataForInstallation 5 params → 200default
GET
/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata
Ampersand Get Object Metadata via Connection
getObjectMetadataForConnection 5 params → 200default
PUT
/projects/{projectIdOrName}/integrations/{integrationId}/object-metadata
Ampersand Upsert Custom Fields for Installation
upsertMetadataForInstallation 2 params body → 200400401403404500
PUT
/projects/{projectIdOrName}/providers/{provider}/object-metadata
Ampersand Upsert Custom Fields for Connection
upsertMetadataForConnection 2 params body → 200400401403404500

Schemas 9

The contract defines 9 schemas that model the data the API accepts and returns. The most detailed are FieldDefinition (10 properties), AssociationDefinition (8 properties), NumericFieldOptions (5 properties), StringFieldOptions (5 properties). Each schema is shown below with its type and property counts.

FieldUpsertResult
object
Result of an upsert operation for a single field
4 properties 2 required
NumericFieldOptions
object
Additional options for numeric fields
5 properties
AssociationLabels
object
UI labels for an association
2 properties
StringFieldOptions
object
Additional options for string fields
5 properties
ObjectMetadata
object
4 properties 2 required
UpsertMetadataRequest
object
Request payload for upserting metadata (fields only)
2 properties 2 required
AssociationDefinition
object
Relationship information for a field to another object
8 properties 2 required
FieldDefinition
object
Field definition for creating or updating custom fields
10 properties 3 required
UpsertMetadataResponse
object
Response containing results for all created/updated fields
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ampersand-objects-fields-api-openapi.yml Raw ↑

Other APIs Ampersand publishes across the network.

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

This is an independent, third-party profile of Ampersand Objects & Fields 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.