Get object metadata for 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. This endpoint may return nested fields as a part of the response. Nested fields are returned in JSONPath bracket notation (e.g. $['billingaddress']['city']). Currently, nested fields are only returned for Salesforce, but this may be expanded to other providers in the future.

GET /projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata

Get object metadata for installation

cURL

curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/integrations/{integrationId}/objects/{objectName}/metadata \
  --header 'X-Api-Key: <api-key>'

200

{
  "name": "contact",
  "fields": {},
  "displayName": "Contact",
  "mappedObjectName": "people"
}

Authorizations

APIKeyHeaderBearer

X-Api-Key · string · header · required

Path Parameters

projectIdOrName · string · required

The unique identifier or name of the project.

integrationId · string · required

The integration ID.

objectName · string · required

Object name (mapped or unmapped)

Query Parameters

groupRef · string

The groupRef for the installation

excludeReadOnly · boolean

Excludes fields where ReadOnly is true from the response.

Response

200

application/json

The retrieved object metadata

name · string · required

The provider name of the object

Example:

"contact"

fields · object · required

Map of field metadata keyed by field name

Show child attributes

displayName · string

Human-readable name of the object

Example:

"Contact"

mappedObjectName · string

Example:

"people"