Overview

The deskbird Public API empowers developers to seamlessly integrate our workplace management features into their applications. This guide provides comprehensive resources to get you started with the API, including authentication, available resources, code examples, and response definitions.

Calling the deskbird Public API

The deskbird Public API can be accessed at:

https://connect.deskbird.com

All requests should be directed to this domain.

Authentication

All requests to the Public API require a valid API key for authentication. This key uniquely identifies your company and grants access to the API. To include the API key in your requests, set the Authorization header with the key as its value:

Obtaining an API Key

To obtain an API key for your company, follow these steps:

Navigate to the Integrations section within the deskbird app.

Locate the Public API section and create a new API key.

Important Note: When creating an API key, ensure you select the "Public API" key type.

Availability per Subscription

Availability of this API depends on your subscription. See our pricing page for more information.

If you have questions regarding a use case or require additional API functionality, please get in touch with our support team at support@deskbird.com.

Pagination

The deskbird Public API employs pagination to efficiently handle large datasets. This mechanism allows for the retrieval of data in manageable chunks.

Parameters

Two primary parameters control pagination:

limit: Specifies the maximum number of records to be returned in a single response. Example: setting limit to 10 will yield a maximum of 10 records per request.

offset: Determines the starting point within the overall dataset. This parameter is typically used to fetch subsequent pages of results after receiving the initial response. For example, if the first response contains 10 records (as defined by the limit), setting offset to 10 in the subsequent request will retrieve the next 10 records.

API Response

The API response includes a total field, indicating the total number of records matching your query. This helps estimate the number of pages needed to retrieve all results based on the specified limit.

Example

Consider fetching a list of all desks in your office, assuming a total of 100 desks. By setting limit to 20, you'll receive the first 20 desks in the initial response. The total field will inform you that there are 100 desks overall. To obtain the next 20 desks, send another request with the same limit but an offset of 20.

By effectively utilizing limit, offset, and the total field, you can efficiently navigate through large datasets provided by the deskbird Public API.

Rate Limiting

To keep our API fast, fair, and reliable for everyone, we limit how often requests can be made. This helps prevent overload and ensures smooth performance even during busy times.

How It Works

Request limits: we allow a maximum of 10 requests per second for each API key

Even spacing: when several requests are sent close to each other, the system automatically spaces them out so they are not all processed at once

When the limit is reached, the API will return status code 429

Best Practices

To get the best performance and avoid hitting rate limits:

Send requests sequentially – wait for a response before sending the next one.

Avoid sending requests in parallel, especially for non-critical operations.

Batch or queue your requests if you need to send many at once.

Calling the deskbird Public API#

Authentication#

Obtaining an API Key#

Availability per Subscription#

Pagination#

Parameters#

API Response#

Example#

Rate Limiting#

How It Works#

Best Practices#