Bigcapital Docs home page
Search...
⌘K
Support
Github
Github
Search...
Navigation
Users
Send an invitation to a new user.
Guides
API Reference
Community
Blog
Get Started
Introduction
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
GET
Retrieve user details of the given user id.
POST
Edit details of the given user.
DEL
Soft deleting the given user.
GET
Retrieve the list of users.
PUT
Activate the given user.
PUT
Inactivate the given user.
POST
Accept a user invitation.
GET
Check if an invitation token is valid.
POST
Send an invitation to a new user.
POST
Resend an invitation to an existing user.
Contacts
Users
Send an invitation to a new user.
POST
/
api
/
invite
Try it
Body
application/json
email
string
required
Email address of the user to invite
Example:
"
[email protected]
"
roleId
number
required
Role ID to assign to the invited user
Example:
2
Check if an invitation token is valid.
Resend an invitation to an existing user.
Assistant
Responses are generated using AI and may contain mistakes.
