Get Started
API Reference
- Api keys
- Items
- Inventory Adjustments
- Branches
- Warehouses
- Accounts
- Inventory Cost
- Sale Invoices
- Pdf Templates
- Tax Rates
- Payments Received
- Import
- resources
- Payment Links
- stripe
- Item Categories
- Expenses
- Warehouse Transfers
- Customers
- Vendors
- Sale Estimates
- Sale Receipts
- Bills
- Landed Cost
- Manual Journals
- Credit Notes
- Credit Note Refunds
- Credit Notes Apply Invoice
- Vendor Credits
- Vendor Credits Apply Bills
- Bill Payments
- Vendor Credits Refunds
- Bank Accounts
- Banking Plaid
- banking-plaid
- Banking Categorization
- Banking Transactions
- Banking Uncategorized Transactions
- Banking Pending Transactions
- Bank Rules
- Banking Recognized Transactions
- Banking Transactions Matching
- Transactions Locking
- Settings
- Reports
- Dashboard
- Roles
- Subscriptions
- Organization
- Payment Services
- Attachments
- Export
- Views
- Currencies
- misc
- Users
- Contacts
Dashboard
Get dashboard boot metadata
GET
/
api
/
dashboard
/
boot
Copy
{
"abilities": [
{
"subject": "all",
"action": "manage"
},
{
"subject": "invoices",
"action": "read"
}
],
"features": [
{
"name": "warehouses",
"isAccessible": true,
"defaultAccessible": false
},
{
"name": "branches",
"isAccessible": false,
"defaultAccessible": false
}
],
"isBigcapitalCloud": true
}
Response
200 - application/json
The dashboard details have been successfully retrieved.
The response is of type object
.
Copy
{
"abilities": [
{
"subject": "all",
"action": "manage"
},
{
"subject": "invoices",
"action": "read"
}
],
"features": [
{
"name": "warehouses",
"isAccessible": true,
"defaultAccessible": false
},
{
"name": "branches",
"isAccessible": false,
"defaultAccessible": false
}
],
"isBigcapitalCloud": true
}
Assistant
Responses are generated using AI and may contain mistakes.