List deals
curl --request GET \
--url https://anzapi.onboardme.app/api/v1/deals/list \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://anzapi.onboardme.app/api/v1/deals/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/deals/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/deals/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/deals/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))
}HttpResponse<String> response = Unirest.get("https://anzapi.onboardme.app/api/v1/deals/list")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/deals/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[
{
"dealID": 123,
"name": "<string>",
"status": "<string>",
"source": "<string>",
"value": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityName": "<string>",
"entityEmail": "<string>",
"groupCode": "<string>",
"groupName": "<string>",
"updatedByName": "<string>",
"updatedOn": "2023-11-07T05:31:56Z"
}
]{
"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>"
}Deals
List deals
Returns deals for your practice.
Use lastUpdated for incremental sync and pageNumber for paged exports (1-based, up to 10000).
Optional filters: name, status, source (substring), entityKey, groupCode.
By default, deals with status Lost are excluded. Set includeLostDeals=true to include them.
Status/source name values come from GET /api/v1/settings/deal-statuses and deal-sources.
429: Rate limit exceeded.
GET
/
api
/
v1
/
deals
/
list
List deals
curl --request GET \
--url https://anzapi.onboardme.app/api/v1/deals/list \
--header 'Authorization: Basic <encoded-value>'import requests
url = "https://anzapi.onboardme.app/api/v1/deals/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/deals/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/deals/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/deals/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))
}HttpResponse<String> response = Unirest.get("https://anzapi.onboardme.app/api/v1/deals/list")
.header("Authorization", "Basic <encoded-value>")
.asString();require 'uri'
require 'net/http'
url = URI("https://anzapi.onboardme.app/api/v1/deals/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[
{
"dealID": 123,
"name": "<string>",
"status": "<string>",
"source": "<string>",
"value": 123,
"entityKey": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"entityName": "<string>",
"entityEmail": "<string>",
"groupCode": "<string>",
"groupName": "<string>",
"updatedByName": "<string>",
"updatedOn": "2023-11-07T05:31:56Z"
}
]{
"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
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
Only deals changed on or after this UTC time (incremental sync).
1-based page index (1–10000).
Substring match on deal name.
Substring match on status.
Substring match on source.
Filter to deals for this client entity key.
Filter to deals for this group code.
When true, includes deals with status Lost.
Response
OK