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>'

import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

Objects & Fields

Get object metadata for connection

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. 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}

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>'

import requests

url = "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata"

headers = {"X-Api-Key": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Api-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata")
  .header("X-Api-Key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withampersand.com/v1/projects/{projectIdOrName}/providers/{provider}/objects/{objectName}/metadata")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

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

{
  "type": "urn:problem-type:exampleOrganization:exampleProblem",
  "href": "https://www.belgif.be/specification/rest/api-guide/#standardized-problem-types",
  "title": "Description of the type of problem that occurred",
  "status": 400,
  "detail": "Description of specific occurrence of the problem",
  "instance": "urn:uuid:123e4567-e89b-12d3-a456-426614174000"
}

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

Show child attributes

displayName

string

Human-readable name of the object

Example:

"Contact"

mappedObjectName

string

Example:

"people"

Get object metadata for installation Upsert custom fields for installation

⌘I

Introduction

WRITE API

READ API

SEARCH API

PLATFORM API

Get object metadata for connection

Authorizations

Path Parameters

Query Parameters

Response