DevelopersAPIReferencesearch
List search
Free-text search across a company, grouped by entity type. Use it when you know a name but not an id: one call matches customers, vendors, and accounts on…
Authentication
Checking whether you're signed in…
Authorization<token>
A SaaSFlow API key (format sf_…) or an OAuth bearer token. Paste only the key — the proxy adds the Bearer prefix. Create an API key in Settings → Company settings → API keys — see API keys.
In: header
Path Parameters
companyId*string
Length
1 <= lengthQuery Parameters
q*string
Length
1 <= lengthResponse Body
application/json
curl -X GET "https://example.com/companies/string/search?q=string"{ "customers": [ { "type": "customer", "id": "string", "name": "string", "logo": true } ], "vendors": [ { "type": "vendor", "id": "string", "name": "string", "logo": true } ], "accounts": [ { "type": "account", "id": "string", "name": "string", "accountType": "bank" } ], "transactions": [ { "type": "transaction", "id": "string", "fromTo": "string", "description": "string", "date": "string", "amountValue": 0, "amountCurrency": "string", "accountId": "string", "accountName": "string" } ]}