Skip to Content
SaaSFlow
DevelopersAPIReferencevendors

Retrieve vendor

Retrieve a single vendor by id, including its default categorization. Returns 404 if the vendor does not exist or belongs to another company.

Authentication

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

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
vendorId*string
Formatuuid

Response Body

Vendor details

application/json
  1. response
id*string
Formatuuid
companyId*string
Formatuuid
name*string

The name of the vendor.

defaultCategorization*|

The default categorization to apply to transactions from this vendor.

domains*array<string>

An array of website domains associated with this vendor.

logo*boolean

Flag indicating if a logo is available for this vendor.

autoCreatedSource*|

The source from which this vendor was automatically created.

Value in"searchApiGoogleWebSearch""stripe""hubspot""datevPayroll""finway""pleo""digistore24""paypal"null
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
externalIds*array<string>

External IDs (URNs) linked to this vendor (e.g., DATEV Payroll).

Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/vendors/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "defaultCategorization": {    "categoryId": "string",    "usingDateRule": {      "type": "transactionDate"    },    "plSplit": {      "revenue": 0,      "cogs": 0,      "cac": 0,      "pd": 0,      "ga": 0,      "no": 0,      "neutral": 0    },    "passThroughTax": 0,    "transferTargetAccountId": "string"  },  "domains": [    "string"  ],  "logo": true,  "autoCreatedSource": "searchApiGoogleWebSearch",  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string",  "externalIds": [    "string"  ]}