List client contacts

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/contacts/list \
  --header 'Authorization: Basic <encoded-value>'

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

fetch('https://anzapi.onboardme.app/api/v1/contacts/list', 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/contacts/list",
  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/contacts/list"

	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/contacts/list")

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

[
  {
    "entityContactID": 1205,
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "contactID": 88,
    "contactName": "Jordan",
    "contactSurname": "Lee",
    "email": "jordan.lee@example.com",
    "mobile": "+61 400 222 333",
    "position": "Director",
    "isPrimary": true,
    "isDeleted": false,
    "updatedOn": "2025-04-10T09:15:00Z"
  }
]

{
  "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

contacts

list

List client contacts

curl --request GET \
  --url https://anzapi.onboardme.app/api/v1/contacts/list \
  --header 'Authorization: Basic <encoded-value>'

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

fetch('https://anzapi.onboardme.app/api/v1/contacts/list', 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/contacts/list",
  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/contacts/list"

	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/contacts/list")

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

[
  {
    "entityContactID": 1205,
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "contactID": 88,
    "contactName": "Jordan",
    "contactSurname": "Lee",
    "email": "jordan.lee@example.com",
    "mobile": "+61 400 222 333",
    "position": "Director",
    "isPrimary": true,
    "isDeleted": false,
    "updatedOn": "2025-04-10T09:15:00Z"
  }
]

{
  "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.

Query Parameters

lastUpdated

string<date-time>

Only contacts changed on or after this UTC time (incremental sync).

pageNumber

integer<int32>

1-based page index (1–10000).

entityKey

string<uuid>

When set, only contacts for this client entity key.

includeDeleted

boolean

default:false

When true, includes soft-deleted contacts.

Response

entityContactID

integer<int64>

entityKey

string<uuid> | null

contactID

integer<int64>

contactName

string | null

contactSurname

string | null

salutation

string | null

addressee

string | null

mobile

string | null

telephone

string | null

position

string | null

isPrimary

boolean

isDeleted

boolean

updatedOn

string<date-time> | null

API documentation

Endpoints

Building blocks

List client contacts

Authorizations

Query Parameters

Response