Appearance
Read organizations
Scope: organizations:read.
Another company's id or external reference returns 404.
GET /public/v1/organizations/
Returns the same organization object as create, without a required action.
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/organizations/by-reference
http
GET /public/v1/organizations/by-reference?external_reference=sf-001Use this before a lead sync when you already stored the source id and need Appraiser Flow's id.
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/organizations
http
GET /public/v1/organizations?q=acme&client_type=lender&limit=50&offset=0| Query | Notes |
|---|---|
q | Optional name search, max 200 characters |
client_type | Optional: lender, amc, private_party, other |
limit | 1–100, default 50 |
offset | 0–10000, default 0 |
Response:
| Field | Type |
|---|---|
items | organization array |
limit, offset | int |
has_more | bool |
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 client_type) |