Appearance
GET /public/v1/orders/
| Auth | Required |
| Scope | orders:read |
Reads one order the office already has. This does not create an order. Another company's id returns 404.
The response is a milestone for a lender portal or status page:
| Field | Type |
|---|---|
id | uuid |
order_number | string |
status | string, for example scheduling, on_hold, delivered, cancelled |
channel | string |
due_date | date or null |
fee | string or null (engagement fee) |
loan_number | string or null |
client_tracking_number | string or null |
property_address, property_city, property_state, property_postal, property_county | string or null (property_address is present) |
engaging_client_id | uuid |
lender_id | uuid or null |
updated_at | datetime |
Internal notes, special instructions, and appraisal values are omitted. Match engaging_client_id or lender_id to an organization you synced.
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.
List by a number you already have
GET /public/v1/orders requires at least one of order_number, loan_number, or client_tracking_number. With none of them the API returns 400 / missing_filter so a key cannot download the whole order book.
http
GET /public/v1/orders?loan_number=LN-4421limit is 1–50, default 20. Response: items, limit, 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.
Quote accept, order create, scheduling, and payments are not on this API yet.
Errors
| Status | Code |
|---|---|
| 400 | missing_filter |
| 403 | insufficient_scope |
| 404 | not_found |