const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spreads": [
{
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
]
}
Spreads
List Lead Spreads
List a lead’s financial spreading runs
GET
/
api
/
v1
/
leads
/
:leadId
/
spreads
const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spreads": [
{
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
]
}
List every financial spreading run for a lead, newest first. Each entry is a complete spread in the same shape as Get Spread, including its
artifacts, whose ids you pass to the artifact endpoints to download.
Authentication
Requires thex-api-key header with a valid workspace API key.
Path Parameters
string
required
The lead whose runs to list.
Response
boolean
Whether the request succeeded.
array
The lead’s runs, newest first. Each entry has the same fields as the
spread
object returned by Get Spread.Errors
error
The
leadId isn’t a lead in your workspace.const options = {
method: "GET",
headers: { "x-api-key": "<your-api-key>" },
};
fetch(
"https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads",
options,
)
.then((response) => response.json())
.then((response) => console.log(response))
.catch((err) => console.error(err));
import requests
url = "https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads"
headers = {"x-api-key": "<your-api-key>"}
response = requests.request("GET", url, headers=headers)
print(response.json())
curl --request GET \
--url https://api-v2.getomni.ai/api/v1/leads/b1f0a790-201b-47e9-84ed-cc7eed1270c5/spreads \
--header 'x-api-key: <your-api-key>'
{
"success": true,
"spreads": [
{
"id": "9f1e2d3c-4b5a-6789-0abc-def012345678",
"status": "COMPLETE",
"error": null,
"leadId": "b1f0a790-201b-47e9-84ed-cc7eed1270c5",
"documents": [
{ "id": "doc-a", "filename": "2023-tax-return.pdf", "status": "EXTRACTED", "error": null },
{ "id": "doc-b", "filename": "2023-financials.pdf", "status": "EXTRACTED", "error": null }
],
"artifacts": [
{ "id": "art-report", "type": "REPORT", "title": "Financial Spread - Pacific Coast Container Haulers" },
{ "id": "art-sheet", "type": "SPREADSHEET", "title": "Financial Spread - Pacific Coast Container Haulers (Excel)" }
],
"createdAt": "2026-07-23T18:04:00.000Z",
"updatedAt": "2026-07-23T18:08:40.000Z"
}
]
}
⌘I