If you're building an integration with deskbird, our Public API lets you access and manage data like bookings, users, groups, resources, scheduling, and more.
👉 For full technical documentation, visit our Developer Hub:
https://developer.deskbird.com
1. Available Use Cases
With the deskbird API, you can connect booking and presence data with your existing workplace tools to automate workflows, build custom dashboards, and reduce manual work. Below are a few popular examples that customers use to create immediate operational and employee experience value.
- Access control integration: Automatically grant (and remove) building or zone access based on desk or meeting room bookings — so employees have the right access at the right time without manual lists.
- Parking booking automation: Automatically release or check in bookings via badge scans or HRIS data.
- Digital signage & office dashboards: Display live availability and "who's in the office today" on screens or intranet pages — making it easier for teams to plan their office days and find space quickly.
- Demand-based cleaning & services: Use actual usage data (e.g., checked-in bookings) to clean and service areas that were really used — helping reduce wasted cleaning runs and focus efforts where they matter.
- No-show / ghost booking insights: Analyze booking vs. check-in patterns to spot no-shows and unused capacity — and use the insights to improve space planning and booking rules.
- "Find my team" widgets: Power a simple team presence view in tools like your intranet or collaboration platform — so employees can see when teammates are planned to be on-site.
- Advanced analytics: Connect to BI tools like PowerBI or Looker to analyze utilization and occupancy trends.
💡 Note: These are just a few examples. If you share your setup and what you want to achieve, we're happy to discuss your specific needs and help you find the best integration approach.
2. Available Endpoints
For request/response schemas and examples, see the Developer Hub.
3. Getting Started
All technical documentation, authentication details, and endpoint references can be found on our Developer Hub. You'll also find example payloads, error codes, and integration guides.
To create an API key, go to Admin > Company settings > API keys and click Generate key (only Global Admins can generate keys). In the Generate key window, enter a Name (project name), select API or SCIM, choose an Expiration period (1 year, 2 years, 3 years, or unlimited), then click Generate key.
Your new key will appear in the list, including a key preview plus details like Created by, Created on, Last used, and Expires on.
You can delete keys using the bin icon — this action cannot be undone.
💡 Note: If your company is already using HRIS sync for user provisioning, you can't create SCIM keys.
4. Managing API Keys
Global Admins can manage the full lifecycle of public API keys, including creation, expiration settings, and monitoring.
No API key limit
There is no limit on the number of public API keys you can generate. Create as many as needed for your integrations.
Expiration settings
When generating a key, you can set its expiration to one of the following periods:
- 1 year
- 2 years
- 3 years
- Unlimited
Expiration reminder emails
deskbird automatically sends reminder emails before an API key expires:
- 3 months before expiration
- 2 weeks before expiration
The reminder is sent to the person who created the key, as long as their account is still active. If the creator's account is no longer active, the email is sent to all Global Admins instead.
5. Need Help?
Do you have a specific use case in mind? Not sure if something is possible?
👉 Reach out to support@deskbird.com. We're happy to help you scope the integration.