Appearance
Read leads
Scope: leads:read.
GET /public/v1/leads/
Returns the lead object. Another company's id is 404.
Try It calls https://staging-api.appraiserflow.ai/public/v1 with an af_test_ key. The key stays in sessionStorage. af_live_ keys are blocked. Live server calls use https://api.appraiserflow.ai/public/v1 with an af_live_ key kept on your server.
GET /public/v1/leads/by-reference
http
GET /public/v1/leads/by-reference?external_reference=deal-4421Try It calls https://staging-api.appraiserflow.ai/public/v1 with an af_test_ key. The key stays in sessionStorage. af_live_ keys are blocked. Live server calls use https://api.appraiserflow.ai/public/v1 with an af_live_ key kept on your server.
GET /public/v1/leads
http
GET /public/v1/leads?stage=qualified&organization_id={uuid}&limit=50&offset=0| Query | Notes |
|---|---|
stage | Optional: lead, qualified, proposal, won, lost |
organization_id | Optional Appraiser Flow organization uuid |
limit | 1–100, default 50 |
offset | 0–10000, default 0 |
Response: items, limit, offset, has_more.
Try It calls https://staging-api.appraiserflow.ai/public/v1 with an af_test_ key. The key stays in sessionStorage. af_live_ keys are blocked. Live server calls use https://api.appraiserflow.ai/public/v1 with an af_live_ key kept on your server.
Errors
| Status | Code |
|---|---|
| 403 | insufficient_scope |
| 404 | not_found |
| 422 | validation_error (unknown stage) |