Skip to main content
GET
/
api
/
dashboard
/
boot
Get dashboard boot metadata
curl --request GET \
  --url https://api.example.com/api/dashboard/boot
{
  "abilities": [
    {
      "subject": "all",
      "action": "manage"
    },
    {
      "subject": "invoices",
      "action": "read"
    }
  ],
  "features": [
    {
      "name": "warehouses",
      "isAccessible": true,
      "defaultAccessible": false
    },
    {
      "name": "branches",
      "isAccessible": false,
      "defaultAccessible": false
    }
  ],
  "isBigcapitalCloud": true
}

Documentation Index

Fetch the complete documentation index at: https://docs.bigcapital.app/llms.txt

Use this file to discover all available pages before exploring further.

Response

200 - application/json

The dashboard details have been successfully retrieved.

​
abilities
object[]
required

List of abilities for the current user

Example:
[
  { "subject": "all", "action": "manage" },
  { "subject": "invoices", "action": "read" }
]
​
features
object[]
required

List of features and their accessibility

Example:
[
  {
    "name": "warehouses",
    "isAccessible": true,
    "defaultAccessible": false
  },
  {
    "name": "branches",
    "isAccessible": false,
    "defaultAccessible": false
  }
]
​
isBigcapitalCloud
boolean
required

Whether the app is running on Bigcapital Cloud

Example:

true