SaaSFlow
DevelopersAPIReferencevendors

List vendors

List vendors, each enriched with the number of transactions booked against it (nrTransactions), the date of its latest settled transaction…

Authentication

Checking whether you're signed in…
GET
/companies/{companyId}/vendors

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
Length1 <= length

Query Parameters

q?string
limit?integer
Range1 <= value <= 500
offset?|
Range0 <= value
linkedTo?string

Keep only rows linked to an integration: an integration name (e.g. stripe, digistore24) keeps rows carrying an external id from that integration, any keeps rows linked to at least one integration, none keeps rows linked to no integration.

Value in"any""none""stripe""slack""hubspot""datevPayroll""finway""pleo""salesforce""digistore24""paypal"
unused?string
Value in"0""1""true""false"
sortBy?string

What to sort by: the name, or the average monthly spend.

Default"name"
Value in"name""monthlySpend"
sortDirection?string
Default"asc"
Value in"asc""desc"

Response Body

List of vendors

response?unknownapplication/json
curl -X GET "https://example.com/companies/string/vendors"
null

Update external id

Replace a customer's external ids with the list you send. This is a full replacement, not a merge, so include the ids you want to keep.

Create vendor

Create a vendor. defaultCategorization is the template applied to every future transaction matched to this vendor: category, date rule, P&L split, and…