Skip to content

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-001

Use 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
QueryNotes
qOptional name search, max 200 characters
client_typeOptional: lender, amc, private_party, other
limit1–100, default 50
offset0–10000, default 0

Response:

FieldType
itemsorganization array
limit, offsetint
has_morebool

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 ​

StatusCode
403insufficient_scope
404not_found
422validation_error (unknown client_type)

API base: https://staging-api.appraiserflow.ai/public/v1 (af_test_ keys)