Skip to main content
GET
/
projects
/
{projectIdOrName}
/
providers
/
{provider}
/
objects
/
{objectName}
/
metadata
Get object metadata for connection
curl --request GET \
  --url https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata \
  --header 'X-Api-Key: <api-key>'
{
  "name": "contact",
  "fields": {},
  "displayName": "Contact",
  "mappedObjectName": "people"
}

Authorizations

​
X-Api-Key
string
header
required

Path Parameters

​
projectIdOrName
string
required

The unique identifier or name of the project.

​
provider
string
required

The API Provider

​
objectName
string
required

Object name (mapped or unmapped)

Query Parameters

​
groupRef
string

The groupRef for the connection.

​
excludeReadOnly
boolean

Excludes fields where ReadOnly is true from the response.

Response

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

​
displayName
string

Human-readable name of the object

Example:

"Contact"

​
mappedObjectName
string
Example:

"people"