Deskbird Public Api

Deskbird Public Api Description

BASE URL
https://developer.deskbird.com

Lists company users

Returns company users

Headers

Authorization

required, string

Public API key for the company

Query Parameters

offset

optional, number, default: 0

The offset to start from

limit

optional, number, default: 100

The limit of items to return

GET
/public-api/users
1

Lists single company user

Returns a single company user by userId

Headers

Authorization

required, string

Public API key for the company

Path Parameters

userId

required, number
GET
/public-api/users/:userId
1

Lists company bookings

Returns company bookings within a provided timeframe

Headers

Authorization

required, string

Public API key for the company

Query Parameters

offset

optional, number, default: 0

The offset to start from

limit

optional, number, default: 100

The limit of items to return

startDate

required, string

The start date of the search period

endDate

required, string

The end date of the search period

bookingId

optional, number

The ID of the booking

status

optional, string enum

The status of the booking

Possible Enum Values

accepted

rejected

requested

awaitingResponse

cancelled

running

awaitingExtensionResponse

userId

optional, number

The ID of the user associated with the booking

zoneId

optional, number

The ID of the zone where the booking is located

resourceItemId

optional, number

The ID of the resource Item associated with the booking

workspaceId

optional, number

The ID of the workspace where the booking is located

GET
/public-api/bookings
1

Lists single company booking

Returns a single company booking by bookingId

Headers

Authorization

required, string

Public API key for the company

Path Parameters

bookingId

required, number

booking id

GET
/public-api/bookings/:bookingId
1

Lists company user groups

Returns company user groups

Headers

Authorization

required, string

Public API key for the company

Query Parameters

offset

optional, number, default: 0

The offset to start from

limit

optional, number, default: 100

The limit of items to return

GET
/public-api/groups
1

Lists single company user group

Returns a single company user group by groupId

Headers

Authorization

required, string

Public API key for the company

Path Parameters

groupId

required, number
GET
/public-api/groups/:groupId
1

Resources

ENDPOINTS
GET/public-api/resources

Lists company resources

Returns company resources within a provided filter

Headers

Authorization

required, string

Public API key for the company

Query Parameters

offset

optional, number, default: 0

The offset to start from

limit

optional, number, default: 100

The limit of items to return

officeId

optional, number

Office id

type

optional, string enum

Resource type

Possible Enum Values

deskArea

flexDesk

eventRoom

privateRoom

phoneBooth

loungeArea

kitchen

zoneId

optional, number

Zone id

GET
/public-api/resources
1