Skip to content

List categories

Request

Fetch all categories (chart of accounts) for the business.

Security
ApiKeyAuth
curl -i -X GET \
  https://developer.boyahq.com/_mock/categories/categories \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

Successful response

Bodyapplication/json
Array [
_idstring
groupidstring
namestring
descriptionstring
statusstring
Example:"ACTIVE"
subcategoriesArray of objects(Subcategory)
createdAtstring, (date-time)
updatedAtstring, (date-time)
__vnumber
]
Response
[
  {
    "_id": "string",
    "groupid": "string",
    "name": "string",
    "description": "string",
    "status": "ACTIVE",
    "subcategories": [ … ],
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "__v": 0
  }
]