Skip to main content
GET
/
v1
/
categories
Get Categories
curl --request GET \
  --url https://api.bookeeping.ai/public-api/v1/categories \
  --header 'Authorization: Bearer <token>'
{
  "message": "<string>",
  "metaData": {
    "warnings": [
      "<string>"
    ]
  },
  "data": {
    "categories": [
      {
        "_id": "<string>",
        "name": "<string>",
        "projectId": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "emoji": "<string>",
        "parentCategory": "INCOME",
        "isArchived": true,
        "number": "<string>",
        "group": "<string>",
        "createdBy": "USER"
      }
    ],
    "count": 123
  }
}

Authorizations

​
Authorization
string
header
required

API key for authentication. Get your key from the Dashboard > Settings > API Access.

Query Parameters

​
page
string

The page number 1 - n

​
limit
string

The number of items per page. Max is 250. Default is 10.

​
sortKey
enum<string>

The key to sort the items by. Default is _id.

Available options:
_id,
name,
createdAt,
updatedAt,
transactionDate
​
sortOrder
enum<string>

The order to sort the items by. Default is 1. -1 for descending. 1 for ascending.

Available options:
1,
-1
​
query
string

The query to search the categories by name

​
accounts
string

The accounts to filter the categories by. Comma separated list of level two categories. Comma separated list of level two categories eg: INCOME,OTHER_INCOME,SALES,EXPENSE,DEPRECIATION,COST_OF_GOODS_SOLD,OTHER_EXPENSE,OVERHEAD,CURRENT_ASSET,FIXED_ASSET,INVENTORY,NON_CURRENT_ASSET,PREPAYMENT,LIABILITY,CURRENT_LIABILITY,NON_CURRENT_LIABILITY,TAX_PAYABLE,TAX,EQUITY

Response

Get Categories executed successfully

​
message
string

Success message

​
metaData
object
​
data
object