Get proposal by key

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

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

fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}', 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/proposals/{key}",
  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/proposals/{key}"

	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/proposals/{key}")

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

{
  "key": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
  "id": 12450,
  "practiceID": 8801,
  "statusID": 3,
  "name": "FY25 — Corporate tax proposal",
  "startDate": "2025-04-01T00:00:00Z",
  "endDate": "2025-06-30T00:00:00Z",
  "expiryDate": "2025-05-15T00:00: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>"
}

Proposals

Get proposal by key

Loads one proposal by key, including full detail: services (prices, quantities, packages), invoices / recurringBillingSetups, xpmJobs, fyiJobs, signatories, and clients.

Prefer GET /api/v1/proposals/{key}/pricing when you only need previous pricing, billing, and jobs (smaller payload for replicate/duplicate).

key is the proposal identifier returned by GET /api/v1/proposals/list.

404: Unknown key or proposal outside your practice.

429: Rate limit exceeded.

GET

api

proposals

{key}

Get proposal by key

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

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

fetch('https://anzapi.onboardme.app/api/v1/proposals/{key}', 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/proposals/{key}",
  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/proposals/{key}"

	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/proposals/{key}")

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

{
  "key": "8f9e2b1c-3d4a-5e6f-7890-abcdef012345",
  "id": 12450,
  "practiceID": 8801,
  "statusID": 3,
  "name": "FY25 — Corporate tax proposal",
  "startDate": "2025-04-01T00:00:00Z",
  "endDate": "2025-06-30T00:00:00Z",
  "expiryDate": "2025-05-15T00:00: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.

Path Parameters

key

string<uuid>

required

Proposal key (identifier).

Response

integer<int32>

practiceID

integer<int32>

lengthID

integer<int32>

statusID

integer<int32>

entityID

integer<int32> | null

currencyID

integer<int32>

approverID

integer<int32> | null

onboardingKey

string<uuid> | null

ethicalLetterKey

string<uuid> | null

serviceGrouping

integer<int32> | null

sendEthicalWhen

integer<int32> | null

name

string | null

note

string | null

startDate

string<date-time>

startOnAcceptance

boolean

endDate

string<date-time> | null

expiryDate

string<date-time> | null

requestPaymentDetails

boolean

paymentDetailsType

integer<int32>

requiresApproval

boolean

requiresMultipleAcceptance

boolean

isNewClient

boolean | null

newClientName

string | null

newClientSurname

string | null

newClientEmail

string | null

newClientBusinessNo

string | null

newClientAddress

string | null

onboardAfterAcceptance

boolean | null

sendEthicalLetter

boolean | null

createXpmJobs

boolean

createKarbonWorkItems

boolean

businessSignatory

integer<int32> | null

createFreeAgentProjects

boolean

createGSTasks

boolean

createFYIJobs

boolean

createChecklist

boolean

includeCdd

boolean

sendForm

boolean

formKey

string<uuid> | null

onboardingSendForm

boolean

onboardingFormKey

string<uuid> | null

onboardingGroupID

integer<int32> | null

approvedOn

string<date-time> | null

sentOn

string<date-time> | null

sentBy

integer<int32> | null

reminderCount

integer<int32>

createdBy

integer<int32>

createdOn

string<date-time>

updatedBy

integer<int32> | null

updatedOn

string<date-time> | null

key

string<uuid>

terms

integer<int32>

termsDetailsOverride

string | null

createBills

boolean

recurringBilling

integer<int32>

payerID

string | null

xglClientUUID

string<uuid> | null

refNo

string | null

statusName

string | null

clientName

string | null

currencyName

string | null

sendEthicalOption

string | null

baseUrl

string | null

entityName

string | null

entitySurname

string | null

entityMobile

string | null

entityEmail

string | null

welcomePDF

boolean

pdfid

integer<int32> | null

sendSMS

boolean

suppressClientDelivery

boolean

stpid

integer<int32> | null

stpDetailsOverride

string | null

document1Name

string | null

document1ID

integer<int32>

document1DetailsOverride

string | null

document2Name

string | null

document2ID

integer<int32>

document2DetailsOverride

string | null

document3Name

string | null

document3ID

integer<int32>

document3DetailsOverride

string | null

document4Name

string | null

document4ID

integer<int32>

document4DetailsOverride

string | null

package1Name

string | null

package1Price

number<double>

package2Name

string | null

package2Price

number<double>

package3Name

string | null

package3Price

number<double>

packageChosen

integer<int32> | null

packageChosenBy

string | null

packageText

string | null

popularPackage

integer<int32> | null

additionalServices

string | null

emailSubject

string | null

emailContent

string | null

packageTexts

object | null

Show child attributes

services

object[] | null

Show child attributes

signatories

object[] | null

Show child attributes

xpmJobs

object[] | null

Show child attributes

karbonWorkItems

object[] | null

Show child attributes

freeAgentProjects

object[] | null

Show child attributes

fyiJobs

object[] | null

Show child attributes

onboardingClients

object[] | null

Show child attributes

clients

object[] | null

Show child attributes

onboardingRecipients

object[] | null

Show child attributes

ethicalClearance

object

Show child attributes

form

object

Show child attributes

onboardingForm

object

Show child attributes

gsTasks

object[] | null

Show child attributes

invoices

object[] | null

Show child attributes

recurringBillingSetup

object

Show child attributes

recurringBillingSetups

object[] | null

Show child attributes

checklist

object

Show child attributes

updateStep

string | null

saveResponseMode

string | null

saveIncompleteMessage

string | null

refreshSubscriptionCounts

boolean

coverPageID

integer<int32> | null

API documentation

Endpoints

Building blocks

Get proposal by key

Authorizations

Path Parameters

Response