Skip to Content
SaaSFlow
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…
GET
/companies/{companyId}/search

Authorization

headerAuthorization<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.

Path Parameters

companyId*string
Formatuuid

Query Parameters

q*string
Length1 <= length

Response Body

Unified command-palette search results for the current company

application/json
  1. response
customers*array<>
vendors*array<>
accounts*array<>
transactions*array<>
Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/search?q=string'
Example Response200
{  "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"    }  ]}