SaaSFlow
DevelopersAPIReferencecategories

Retrieve category

Retrieve a single category by id. Returns 404 if the category does not exist or belongs to another company.

Authentication

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

Authorization

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
Length1 <= length
categoryId*string
Length1 <= length

Response Body

application/json

application/json

curl -X GET "https://example.com/companies/string/categories/string"
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "companyId": "8bb73d03-06b4-47c7-80c7-59301f770eda",  "name": "string",  "emoji": "string",  "plTypes": [    "revenue"  ],  "system": true,  "systemKey": "string",  "order": -8388608,  "createdTime": "2019-08-24T14:15:22Z",  "createdUserId": "string",  "lastUpdatedTime": "2019-08-24T14:15:22Z",  "lastUpdatedUserId": "string"}

Create category

Create a category. plTypes decides where transactions in it land in the P&L, and order sets its position in the list.

Delete category

Delete a category. Refused with 409 while any transaction is still categorized under it or any planned transaction still uses it, and with 400 for system…