List onboardings

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

import requests

url = "https://anzapi.onboardme.app/api/v1/onboardings/list"

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/onboardings/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/onboardings/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/onboardings/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/onboardings/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

[
  {
    "onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
    "onboardingID": 8934,
    "statusID": 2,
    "statusName": "In progress",
    "createdOn": "2025-04-07T10:00:00Z",
    "sentOn": "2025-04-08T07:45:00Z",
    "submittedOn": null,
    "completedOn": null,
    "updatedOn": "2025-04-10T06:30:00Z",
    "createdByKey": "11111111-2222-3333-4444-555555555555",
    "approverKey": null,
    "engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
    "formKey": "99999999-8888-7777-6666-555555555555",
    "recipients": [
      {
        "recipientKey": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
        "name": "Alex",
        "surname": "Nguyen",
        "email": "alex.nguyen@client.example",
        "mobile": "+61 412 555 014",
        "sendOrder": 1,
        "sentOn": "2025-04-09T08:00:00Z",
        "submittedOn": "2025-04-09T14:22: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>"
}

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

Onboardings

List onboardings

Returns onboarding jobs for your practice. Use lastUpdated for incremental sync and searchFilter for quick narrowing.

Query tips

statusID: filter by onboarding status ID.
searchFilter: free-text search across key onboarding fields.
pageNumber: 1-based page (1–10000).
userID: filter by assigned user (see GET /api/v1/users/list for IDs).
lastUpdated: only rows changed on or after this UTC time (must not be in the future).
excludeCompleted: when true, completed onboardings are omitted.

429: Rate limit exceeded.

GET

api

onboardings

list

List onboardings

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

import requests

url = "https://anzapi.onboardme.app/api/v1/onboardings/list"

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/onboardings/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/onboardings/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/onboardings/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/onboardings/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

[
  {
    "onboardingKey": "aabbccdd-1122-3344-5566-77889900aabb",
    "onboardingID": 8934,
    "statusID": 2,
    "statusName": "In progress",
    "createdOn": "2025-04-07T10:00:00Z",
    "sentOn": "2025-04-08T07:45:00Z",
    "submittedOn": null,
    "completedOn": null,
    "updatedOn": "2025-04-10T06:30:00Z",
    "createdByKey": "11111111-2222-3333-4444-555555555555",
    "approverKey": null,
    "engagementKey": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
    "formKey": "99999999-8888-7777-6666-555555555555",
    "recipients": [
      {
        "recipientKey": "f1e2d3c4-b5a6-7890-abcd-ef1234567890",
        "name": "Alex",
        "surname": "Nguyen",
        "email": "alex.nguyen@client.example",
        "mobile": "+61 412 555 014",
        "sendOrder": 1,
        "sentOn": "2025-04-09T08:00:00Z",
        "submittedOn": "2025-04-09T14:22: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>"
}

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

statusID

integer<int32>

Filter by onboarding status ID.

searchFilter

string

Case-insensitive search across key onboarding fields.

pageNumber

integer<int32>

1-based page index (1–10000). Omit for default paging.

userID

integer<int32>

Restrict to onboardings assigned to this user ID.

lastUpdated

string<date-time>

Return only items updated at or after this UTC time (incremental sync).

excludeCompleted

boolean

default:false

When true, excludes completed onboardings.

Response

onboardingKey

string<uuid>

onboardingID

integer<int32>

statusID

integer<int32> | null

statusName

string | null

createdOn

string<date-time> | null

sentOn

string<date-time> | null

submittedOn

string<date-time> | null

completedOn

string<date-time> | null

updatedOn

string<date-time> | null

createdByKey

string<uuid> | null

approverKey

string<uuid> | null

engagementKey

string<uuid> | null

formKey

string<uuid> | null

recipients

object[] | null

Show child attributes

API documentation

Endpoints

Building blocks

List onboardings

Authorizations

Query Parameters

Response