Get linked integration IDs

Get linked integration IDs for an entity

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/entities/{key}/integrations \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://anzapi.onboardme.app/api/v1/entities/{key}/integrations"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/entities/{key}/integrations', 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://anzapi.onboardme.app/api/v1/entities/{key}/integrations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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://anzapi.onboardme.app/api/v1/entities/{key}/integrations"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/entities/{key}/integrations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "entityName": "Riverstone Holdings Ltd",
  "xpmClientID": "xpm-48291",
  "xglClientID": "XGL-00921",
  "gsClientID": null,
  "kloudConnectClientID": null,
  "fyiClientID": "FYI-CL-88321",
  "karbonClientID": null,
  "qbClientID": null,
  "bglID": null,
  "bglContactID": null
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

GET

api

entities

{key}

integrations

Get linked integration IDs for an entity

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/entities/{key}/integrations \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://anzapi.onboardme.app/api/v1/entities/{key}/integrations"

headers = {"Authorization": "Basic <encoded-value>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://anzapi.onboardme.app/api/v1/entities/{key}/integrations', 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://anzapi.onboardme.app/api/v1/entities/{key}/integrations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>"
  ],
]);

$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://anzapi.onboardme.app/api/v1/entities/{key}/integrations"

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

	req.Header.Add("Authorization", "Basic <encoded-value>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://anzapi.onboardme.app/api/v1/entities/{key}/integrations")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Basic <encoded-value>'

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

{
  "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
  "entityName": "Riverstone Holdings Ltd",
  "xpmClientID": "xpm-48291",
  "xglClientID": "XGL-00921",
  "gsClientID": null,
  "kloudConnectClientID": null,
  "fyiClientID": "FYI-CL-88321",
  "karbonClientID": null,
  "qbClientID": null,
  "bglID": null,
  "bglContactID": null
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

{
  "type": "<string>",
  "title": "<string>",
  "status": 123,
  "detail": "<string>",
  "instance": "<string>"
}

Authorizations

Authorization

string

header

required

Swagger / Postman only: Client ID as username, Client secret as password. In Postman, set this once on the collection (Authorization → Basic Auth) so all requests inherit. For production server-to-server code, prefer X-OM-Auth-ID and X-OM-Auth-Key headers.

Path Parameters

key

string<uuid>

required

Client entity key (identifier).

Response

entityKey

string<uuid> | null

entityName

string | null

xpmClientID

string | null

xglClientID

string | null

gsClientID

string | null

kloudConnectClientID

string | null

fyiClientID

string | null

karbonClientID

string | null

karbonEntityType

string | null

qbClientID

string | null

freeAgentClientUrl

string | null

bglID

string | null

bglContactID

string | null

bglSmsfID

string | null

bglSmsfFirm

string | null

API documentation

Endpoints

Building blocks

Get linked integration IDs

Authorizations

Path Parameters

Response