List leads

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

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

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

[
  {
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "leadDetailID": 501,
    "externalSystemID": "CRM-LEAD-8821",
    "entityCode": "LD-2048",
    "entityName": "Harbour View",
    "entitySurname": "Pty Ltd",
    "fullName": "Harbour View Pty Ltd",
    "email": "contact@harbourview.example",
    "mobile": "+61 400 111 222",
    "entityType": "Company",
    "leadSource": "Website enquiry",
    "leadStatus": "New",
    "leadValue": 4500,
    "updatedByName": "Alex Morgan",
    "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

leads

list

List leads

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

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

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

[
  {
    "entityKey": "2c4f6a88-1b3d-5e7f-90ab-cdef12345678",
    "leadDetailID": 501,
    "externalSystemID": "CRM-LEAD-8821",
    "entityCode": "LD-2048",
    "entityName": "Harbour View",
    "entitySurname": "Pty Ltd",
    "fullName": "Harbour View Pty Ltd",
    "email": "contact@harbourview.example",
    "mobile": "+61 400 111 222",
    "entityType": "Company",
    "leadSource": "Website enquiry",
    "leadStatus": "New",
    "leadValue": 4500,
    "updatedByName": "Alex Morgan",
    "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 leads changed on or after this UTC time (incremental sync).

pageNumber

integer<int32>

1-based page index (1–10000).

name

string

Substring match on lead name fields.

string

Substring match on email.

leadStatus

string

Substring match on lead status.

leadSource

string

Substring match on lead source.

includeLostLeads

boolean

default:false

When true, includes leads with status Lost.

Response

entityKey

string<uuid> | null

leadDetailID

integer<int64> | null

externalSystemID

string | null

entityCode

string | null

entityName

string | null

entitySurname

string | null

fullName

string | null

mobile

string | null

entityType

string | null

leadSource

string | null

leadStatus

string | null

leadValue

number<double> | null

updatedByName

string | null

updatedOn

string<date-time> | null

API documentation

Endpoints

Building blocks

List leads

Authorizations

Query Parameters

Response