Skip to Content
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

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

Response Body

Category details

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

The name of the category.

emoji*|

An emoji representing the category.

plTypes*array<>

The P&L types that the category can be used for.

system*boolean

Flag indicating if this is a system-defined category.

systemKey*|

Semantic key for system categories (e.g., revRecurring, paymentFees).

order*number

A number used for ordering categories in the UI.

Range-8388608 <= value <= 8388607
createdTime*|
Formatdate-time
createdUserId*string|null
lastUpdatedTime*|
Formatdate-time
lastUpdatedUserId*string|null
Example Request
curl -X GET 'https://api.saasflow.com/companies/497f6eca-6276-4993-bfeb-53cbbbba6f08/categories/497f6eca-6276-4993-bfeb-53cbbbba6f08'
Example Response
{  "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"}