Download OpenAPI specification:Download
Welcome to Deskbee's technical documentation
📢 This documentation is under construction, but you will find most of the information you need to help improve and simplify the Deskbee experience.
Deskbee provides a REST API so you can integrate or automate actions.
The communication base address is api.deskbee.io, always accompanied by the secure protocol https://. API versions are grouped by directory, suffixed to base address (https://api.deskbee.io/v1.1).
📢 We can provide an environment for internal testing and development tests. Just contact help@deskbee.co
The API supports two methods for sending parameters
curl --request POST 'https://api.deskbee.io/v1.1/oauth/token' \
--data-raw 'grant_type=client_credentials&client_id=942ff....e4e23676e'
curl --request POST 'https://api.deskbee.io/v1.1/oauth/token' \
--header 'Content-Type: application/json' \
--data-raw '{
"grant_type" : "client_credentials",
"client_id' :"",
"client_secret' : "",
"scope" : ""
}'
Some requests made in the API will return a list of information, this information will not be returned in a single response, this is because some responses may have a lot of information, so these requests are paginated.
The Deskbee API uses paging by cursor, in this paging a key parameter is used.
The client receives a variable named cursor along with the response. This cursor is a pointer that points to a specific item that needs to be sent with a request. The server then uses the cursor to fetch the other set of items.
Cursor-based paging is more complex and is preferred when dealing with a real-time dataset.
Below is an example of a cursor-paged JSON response:
Description of the parameters that can be sent in the Deskbee API pagination
Parameters | Description |
---|---|
limit | Number of individual objects that are returned on each page. max: 250 |
curl -i -X GET 'https://api.deskbee.io/v1.1/users?limit=1' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <token>'
Description of the parameters received in the Deskbee API pagination
Parameters | Description |
---|---|
links.next | Url that tells which page to request next. If not displayed, this will be the last page |
links.prev | Url that reports the previous data page. If not displayed, this is the first page |
{
"data": [{
...
}, {
...
}, {
...
}],
"links": {
"prev": "https://api.deskbee.io/v1.1/users?cursor=eyJuYW1lIjoiS3VyaXJpbiIsIl9wb2ludHNUb05leHRJdGVtcyI6ZmFsc2V9",
"next": "https://api.deskbee.io/v1.1/users?cursor=eyJuYW1lIjoiS3VyaXJpbiIsIl9wb2ludHNUb05leHRJdGVtcyI6dHJ1ZX0"
},
"meta": {
"path": "https://api.deskbee.io/v1.1/users",
"per_page": "2"
}
}
All responses are returned in valid JSON format.
Dates are returned in ISO8601 format.
{
// ...
"created_at": "2020-01-01T12:00:00Z",
"updated_at": "2020-01-01T13:00:00Z",
// ...
}
Each response returns an appropriate HTTP code as specified https://datatracker.ietf.org/doc/html/rfc7231#section-6
Codes | Message | Description |
---|---|---|
200 | OK | Successful request for a GET, DELETE or PUT that completed synchronously |
201 | Created | Successful request for a POST, PUT |
202 | Accepted | Request accepted for a POST, PUT, DELETE, or PATCH that will be processed asynchronously |
204 | No Content | Request successfully carried out, however, there is no content to return |
{
"data": {
"uuid": "68b0327b-e0f9-40e2-a81c-15fb0d981ede",
"name": "Grupo Teste",
"is_checkin_home_office": false,
"created_at": "2021-09-23T14:28:36-03:00",
"updated_at": "2021-09-23T14:28:36-03:00"
}
}
In the event of returning an error, HTTP Status Code different from 2xx for example, a structured and consistent error will be generated in the body of the response.
Field | Type | Description |
---|---|---|
error | Int | Error code, same as the code returned in the HTTP Status (machine-readable) |
id | String | Identifier of the occurred error (machine-readable) |
message | String | User-friendly message explaining the error, human-readable. |
errors | String[] | Error parameters, listing the errors reported in the request. |
{
"error": 422
"id": "unprocessable_entity",
"message": "The given data failed to pass validation.",
"errors": {
"email": ["The email field is required."],
"name": ["The name field is required."]
}
}
Errors returned by the Deskbee API
Code | Message | ID | Description |
---|---|---|---|
400 | Bad Request | unexpected_value | The sent data is invalid or non-existent |
400 | Bad Request | oauth_escope | Invalid OAuth Authentication Scope |
401 | Unauthorized | unauthenticated | Not authorized to access this method |
401 | Unauthorized | oauth_server | Error in access credentials to generate JWT token |
401 | Unauthorized | oauth_unauthorized | Authorization error in OAuth authentication |
404 | Not Found | not_found | Endpoint not found or non-existent |
422 | Unprocessable Entity | unprocessable_entity | Your request contains invalid parameters |
507 | Insufficient Storage | query_error | Unable to store your data |
429 | Too Many Requests | request_limit | You have exceeded the consumption limit, try again later |
500 | Internal Server Error | internal_error | Something went wrong with the Server, report the problem |
To begin integration with Deskbee's API, it is necessary to create a ClientApi in the Deskbee Panel.
📢 Only users with Admin and Master Profile permissions have access to the integrations menu
📢 ATTENTION
For compliance, choose only the scopes that the application needs to use
To authenticate in the Deskbee API, we use the client_credential OAuth flow.
📢 The client credentials flow is a server-to-server flow. There is no user authentication involved in the process
This flow is useful for systems that need to perform API operations when no user is present. These can be night operations or other operations involving contact between two applications / systems.
The Flow consists of:
grant_type | string |
client_id | string |
client_secret | string |
scope | string |
{- "grant_type": "client_credentials",
- "client_id": "943e47a1.....afc40e491",
- "client_secret": "7gWtVs9P.....PEyjRVqz05QdyB",
- "scope": "organization.show organization.upsert integration.checkin booking.show organization.remove"
}
{- "access_token": "eyJ...yqU",
- "token_type": "Bearer",
- "expires_in": "3600"
}
Returns a single building
uuid required | string UUID of the building to return |
{- "data": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
Returns a list of buildings
object (SearchBuildingParams) Example: search='place_type:workspace;is_active:false' Search filters. Use semicolon-separated key:value pairs. | |
user_scope | string <uuid> Example: user_scope=123e4567-e89b-12d3-a456-426614174000 Scope-based filter, filtering buildings only by the user's uuid according to the spatial restrictions configured in the deskbee panel. |
{- "data": [
- {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
]
}
Returns a single floor
uuid required | string UUID of the floor to return |
{- "data": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}
}
Returns a list of floors
object (SearchFloorParams) Example: search='place_type:workspace;is_active:false' Search filters. Use semicolon-separated key:value pairs. | |
user_scope | string <uuid> Example: user_scope=123e4567-e89b-12d3-a456-426614174000 Scope-based filter, filtering buildings only by the user's uuid according to the spatial * restrictions configured in the deskbee panel. |
{- "data": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}
]
}
uuid required | string <uuid> UUID of the parking |
{- "data": {
- "uuid": "123e4567-e89b-12d3-a456-426655440000",
- "name": "Parking Lot A",
- "is_active": true,
- "path": "Seattle › Seattle Tower › Parking",
- "available_vacancies": 50
}
}
object (SearchFloorParams) Example: search='place_type:workspace;is_active:false' Search filters. Use semicolon-separated key:value pairs. | |
object (ResponseFilterVacancies) Example: response_filter=date:2024/01/01;start_hour:06:00;end_hour:11:00 Filter response. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426655440000",
- "name": "Parking Lot A",
- "is_active": true,
- "path": "Seattle › Seattle Tower › Parking",
- "available_vacancies": 50
}
]
}
Returns a single place
uuid required | string UUID of the place to return |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "qrcode": "string",
- "type": "workspace",
- "name": "string",
- "name_display": "string",
- "capacity": 0,
- "is_mapped": true,
- "status": {
- "id": "1",
- "name": "string"
}, - "sector": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string"
}, - "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "area": {
- "address": "string",
- "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "qrcode_base64": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAIAAABCSeBNAAAACXBIWXMAAA7fMTuDwBOJA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAITto+xLhiyLh0x6h5w6PeRu7OOpSyNuCjCNNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEGaNsnkNC26+5K0BCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AGHlpOwTjyEecijzkFOnh3yDjtV+NuTZ+PyIhZ8Bbk8agCANQJAGIEgDEKQBCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEIK6PsfYYcyjxkLDzkblwy5NadeBlDrvmDtwYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AGFllD1kLLzvgOMhZxZPW+l+uyFHVA+5jGncFCBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAgjQAYWWUPWSGfInzrJ+5Zr7krQEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AEEagCANQDj4pOwhp04POc96yHHPQzb4l5z4pwBeYMR3A0wjDUCQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIAhMfRu9F7GzL33ufEpfyQIfkLvu4RvycwjTQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxBWTsoesks90aUt7Yk7632G7KxPXHCvOfjSgX2kAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAgjQAQRqAsDLKvuT2y+ITh7cnXvM+Q3bWQ4bknx+x8DPA7UkDEKQBCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABh+yj7kiFj4ROH5Le\\/dUN+wUtOfJA+nHe7gReQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAwqxRNs+GzJCH7KxPvIwhx2qvGfHwAdNIAxCkAQjSAARpAII0AEEagCANQJAG=",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
}
object (SearchPlaceParams) Example: search='place_type:workspace' Search filters. Use semicolon-separated key:value pairs. | |
user_scope | string <uuid> Example: user_scope=123e4567-e89b-12d3-a456-426614174000 Scope-based filter, filtering buildings only by the user's uuid according to the spatial * restrictions configured in the deskbee panel. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "qrcode": "string",
- "type": "workspace",
- "name": "string",
- "name_display": "string",
- "capacity": 0,
- "is_mapped": true,
- "status": {
- "id": "1",
- "name": "string"
}, - "sector": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string"
}, - "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "area": {
- "address": "string",
- "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "qrcode_base64": "iVBORw0KGgoAAAANSUhEUgAAAV4AAAFeCAIAAABCSeBNAAAACXBIWXMAAA7fMTuDwBOJA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAITto+xLhiyLh0x6h5w6PeRu7OOpSyNuCjCNNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEGaNsnkNC26+5K0BCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AGHlpOwTjyEecijzkFOnh3yDjtV+NuTZ+PyIhZ8Bbk8agCANQJAGIEgDEKQBCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEIK6PsfYYcyjxkLDzkblwy5NadeBlDrvmDtwYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AGFllD1kLLzvgOMhZxZPW+l+uyFHVA+5jGncFCBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAgjQAYWWUPWSGfInzrJ+5Zr7krQEI0gAEaQCCNABBGoAgDUCQBiBIAxCkAQjSAARpAII0AEEagCANQDj4pOwhp04POc96yHHPQzb4l5z4pwBeYMR3A0wjDUCQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIAhMfRu9F7GzL33ufEpfyQIfkLvu4RvycwjTQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABBGoAgDUCQBiBIAxBWTsoesks90aUt7Yk7632G7KxPXHCvOfjSgX2kAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAgjQAQRqAsDLKvuT2y+ITh7cnXvM+Q3bWQ4bknx+x8DPA7UkDEKQBCNIABGkAgjQAQRqAIA1AkAYgSAMQpAEI0gAEaQCCNABh+yj7kiFj4ROH5Le\\/dUN+wUtOfJA+nHe7gReQBiBIAxCkAQjSAARpAII0AEEagCANQJAGIEgDEKQBCNIABGkAwqxRNs+GzJCH7KxPvIwhx2qvGfHwAdNIAxCkAQjSAARpAII0AEEagCANQJAG=",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
]
}
Returns list of cost centers
object (SearchCostCenterParams) Example: search='name:developer' Search filters. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "code": "string",
- "description": "string"
}
]
}
Add a cost center
name required | string name of the cost center |
code required | string code of the cost center |
description | string description or a note about the cost center |
{- "name": "Commodities",
- "code": "1900623",
- "description": "string"
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "code": "string",
- "description": "string"
}
}
Returns a single cost center
uuid required | string UUID of the cost center to return |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "code": "string",
- "description": "string"
}
}
uuid required | string UUID of the cost center |
name required | string name of the cost center |
code required | string code of the cost center |
description | string description or a note about the cost center |
{- "name": "Commodities",
- "code": "1900623",
- "description": "string"
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "code": "string",
- "description": "string"
}
}
Returns list of users
object (SearchUserApiClient) Example: search='email:eq:[email protected];is_squad:false' Search filters. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "source": "admin_painel",
- "access_type": "user_password",
- "profile": "master",
- "photo": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "avatar": "string"
}, - "locale": {
- "timezone": "America/New_York",
- "language": "pt_BR"
}, - "tags": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
], - "squads": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
], - "allocated": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
], - "status": true,
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "vehicles": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Add a user
name | string Name of the user |
string <email> Unique email address of the user | |
is_send_mail | boolean Flag to indicate if mail should be sent |
enrollment | string The enrollment number used to associate Deskbee users with other platforms. This serves as a unique identifier for integration purposes. |
squad_uuid | string <uuid> Unique identifier of the squad |
status | boolean Indicates the user's status. When true, the user is active; when false, the user is deactivated and cannot log in to Deskbee. |
object Free-form object for user documents, used exclusively for integrations with access control and guest pass systems. Any information can be included as key-value pairs. | |
tags | Array of strings <uuid> [ items <uuid > ] List of UUIDs representing user tags. |
{- "name": "string",
- "is_send_mail": true,
- "enrollment": "ENROLL12345",
- "squad_uuid": "addd4fbe-876a-4d8c-833d-e952be1b0f18",
- "status": true,
- "documents": {
- "rg": "12345678",
- "cpf": "123.456.789-00",
- "passport": "N1234567",
- "driverLicense": "X1234567890"
}, - "tags": [
- "123e4567-e89b-12d3-a456-426614174000",
- "123e4567-e89b-12d3-a456-426614174001"
]
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "source": "admin_painel",
- "access_type": "user_password",
- "profile": "master",
- "photo": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "avatar": "string"
}, - "locale": {
- "timezone": "America/New_York",
- "language": "pt_BR"
}, - "tags": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
], - "squads": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
], - "allocated": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
], - "status": true,
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "vehicles": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Returns a single user
uuid required | string UUID of the user to return |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "source": "admin_painel",
- "access_type": "user_password",
- "profile": "master",
- "photo": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "avatar": "string"
}, - "locale": {
- "timezone": "America/New_York",
- "language": "pt_BR"
}, - "tags": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
], - "squads": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
], - "allocated": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
], - "status": true,
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "vehicles": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
uuid required | string User UUID |
name | string Name of the user |
string <email> Unique email address of the user | |
is_send_mail | boolean Flag to indicate if mail should be sent |
enrollment | string The enrollment number used to associate Deskbee users with other platforms. This serves as a unique identifier for integration purposes. |
squad_uuid | string <uuid> Unique identifier of the squad |
status | boolean Indicates the user's status. When true, the user is active; when false, the user is deactivated and cannot log in to Deskbee. |
object Free-form object for user documents, used exclusively for integrations with access control and guest pass systems. Any information can be included as key-value pairs. | |
tags | Array of strings <uuid> [ items <uuid > ] List of UUIDs representing user tags. |
{- "name": "string",
- "is_send_mail": true,
- "enrollment": "ENROLL12345",
- "squad_uuid": "addd4fbe-876a-4d8c-833d-e952be1b0f18",
- "status": true,
- "documents": {
- "rg": "12345678",
- "cpf": "123.456.789-00",
- "passport": "N1234567",
- "driverLicense": "X1234567890"
}, - "tags": [
- "123e4567-e89b-12d3-a456-426614174000",
- "123e4567-e89b-12d3-a456-426614174001"
]
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "source": "admin_painel",
- "access_type": "user_password",
- "profile": "master",
- "photo": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "avatar": "string"
}, - "locale": {
- "timezone": "America/New_York",
- "language": "pt_BR"
}, - "tags": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
], - "squads": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
], - "allocated": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
], - "status": true,
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "vehicles": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
uuid required | string User UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "source": "admin_painel",
- "access_type": "user_password",
- "profile": "master",
- "photo": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "avatar": "string"
}, - "locale": {
- "timezone": "America/New_York",
- "language": "pt_BR"
}, - "tags": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
], - "squads": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
], - "allocated": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}
], - "status": true,
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "vehicles": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}
], - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
squads | Array of strings <uuid> [ items <uuid > ] List of squad UUIDs. |
users | Array of strings <uuid> [ items <uuid > ] List of user UUIDs. |
{- "squads": [
- "a3ed0ca6-c809-48e7-baae-543fe8fc55a2",
- "bc4bdb6b-4def-4cd9-a7fe-b5fa481101cd"
], - "users": [
- "1cbb45ce-1da3-4b71-b0e1-d59190a9e413",
- "80a0079d-3ee2-4785-b41e-529bb4e68ee6"
]
}
{- "data": ""
}
squads | Array of strings <uuid> [ items <uuid > ] List of squad UUIDs. |
users | Array of strings <uuid> [ items <uuid > ] List of user UUIDs. |
{- "squads": [
- "a3ed0ca6-c809-48e7-baae-543fe8fc55a2",
- "bc4bdb6b-4def-4cd9-a7fe-b5fa481101cd"
], - "users": [
- "1cbb45ce-1da3-4b71-b0e1-d59190a9e413",
- "80a0079d-3ee2-4785-b41e-529bb4e68ee6"
]
}
{- "data": ""
}
Submits data to create a user tag
name | string Unique name for the user tag. |
access | string Enum: "public" "private" Access level for the user tag, must be either 'public' or 'private'. |
{- "name": "string",
- "access": "public"
}
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "access": "public",
- "is_default": true
}
]
}
Returns a single squad
uuid required | string UUID of the squad to return |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
}
uuid required | string Squad UUID |
name required | string group name |
{- "name": "Commodities"
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
}
uuid required | string Squad UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
}
Returns list of squads
object (SearchSquadParams) Example: search='name:developer' Search filters. Use semicolon-separated key:value pairs. | |
user_scope | string <uuid> Example: user_scope=123e4567-e89b-12d3-a456-426614174000 Scope-based filter, filtering buildings only by the user's uuid according to the spatial restrictions configured in the deskbee panel. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
]
}
Add a squad
name required | string group name |
{- "name": "Commodities"
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "updated_at": "2024-02-14T16:29:56-03:00",
- "created_at": "2024-02-14T16:29:56-03:00"
}
}
Returns a list of squads along with their spatial restrictions, including blocks by area such as floor, building, sector, or site.s
object (SearchSquadParams) Example: search='name:developer' Search filters. Use semicolon-separated key:value pairs. | |
user_scope | string <uuid> Example: user_scope=123e4567-e89b-12d3-a456-426614174000 Scope-based filter, filtering buildings only by the user's uuid according to the spatial restrictions configured in the deskbee panel. |
{- "data": [
- {
- "uuid": "string",
- "name": "string",
- "areas": [
- {
- "uuid": "string",
- "name": "string",
- "type": "site"
}
]
}
]
}
object (SearchGuestPass) Example: search='search=period:2024/01/01,2024/01/30;state=active' Search filters. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "master_uuid": "94aeff1d-54e2-4d12-ac8e-82b121d942aa",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "token_access": "string",
- "status": {
- "id": 1,
- "name": "string"
}, - "area": {
- "address": "string",
- "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "avatar": "string",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
]
}
Updates the status of a guest pass to 'Passed' (status id = 4) and sends email notifications to the host and a designated concierge or receptionist.
uuid required | string User UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "master_uuid": "94aeff1d-54e2-4d12-ac8e-82b121d942aa",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "token_access": "string",
- "status": {
- "id": 1,
- "name": "string"
}, - "area": {
- "address": "string",
- "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "name_display": "string",
- "enrollment": "string",
- "avatar": "string",
- "documents": [
- {
- "type": "passport",
- "doc": "N1234567"
}
]
}, - "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
Fetches detailed information about a specific reservation and its associated check-in data using the reservation's unique identifier (UUID).
uuid required | string Booking UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
}
object (SearchBooking) Example: search='search=period:2024/01/01,2024/01/30;state=reserved' Search filters. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
]
}
Creates a new booking. If 'place_uuid' is not provided, 'floor_uuid' must be specified, and the system will select the first available place on the floor that the 'person_uuid' has access to.
📢 ATTENTION
Currently, only reservations for workstations are supported.
user_uuid required | string <uuid> Required UUID of the person making the booking. |
date required | string <date> Required date of the booking in 'Y/m/d' format. |
start_hour required | string <time> Required start hour of the booking in 'H:i' format. |
end_hour required | string <time> Required end hour of the booking in 'H:i' format. |
place_uuid | string <uuid> Optional UUID of the place for the booking. |
floor_uuid | string <uuid> Required UUID of the floor for the booking if place_uuid is not provided. |
is_send_email | boolean Indicates whether an email with the reservation details should be sent to the person. |
{- "user_uuid": "7c4d2d7d-8620-4fb3-967a-4a621082cf1f",
- "date": "2024/01/30",
- "start_hour": "08:00",
- "end_hour": "15:00",
- "place_uuid": "a1998e5c-7d53-454f-ac7a-ce908acc5631",
- "floor_uuid": "fb41c11a-b256-4172-9281-a04f78acbcef",
- "is_send_email": true
}
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
}
Returns a list of all check-ins associated with a specific booking, including check-ins by both the host and participants (if participant check-ins are enabled in the Deskbee Panel).
uuid required | string Booking UUID |
{- "data": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_anonymization": "false",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "occupation_time": "string"
}
]
}
This endpoint performs a check-in for an active reservation identified by the reservation uuid.
uuid required | string Booking UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
}
This endpoint performs a checkout for a specified reservation, freeing up the reserved space.
uuid required | string Booking UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
}
Cancels an active reservation that has not yet had a check-in. This frees up the reserved space.
uuid required | string Booking UUID |
{- "data": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "state": "busy",
- "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "owner": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "is_checkin_guest": true,
- "tolerance": {
- "minutes": 0,
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "meeting": {
- "is_online": true,
- "title": "string",
- "description": "string"
}, - "guests": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "language": "string",
- "image": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "url": "string",
- "thumbs": {
- "low": "string",
- "medium": "string"
}
}, - "type": "inperson"
}
], - "vehicle": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "brand": {
- "uuid": "123e4567-e89b-12d3-a456-426614174001",
- "name": "Tesla",
- "type": "Electric",
- "code": "TES"
}, - "model": "Model S",
- "color": "Red",
- "plate": "XYZ-1234",
- "is_default": true
}, - "checkin": {
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "is_checkout_system": true,
- "is_checkout_api": true,
- "is_checkin_api": true,
- "occupation_time": "string"
}, - "min_tolerance": 0,
- "created_at": "2019-08-24T14:15:22Z",
- "updated_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z"
}
}
Get ticket event details by UUID.
uuid required | string <uuid> UUID of the ticket event |
{- "data": {
- "number": 123,
- "ticket": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ticket ABC",
- "category": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Category A"
}, - "subcategory": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Category A"
}
}, - "open_date": "2023-03-15T11:15:48-03:00",
- "end_date": "2023-03-16T14:30:00-03:00",
- "history": [
- {
- "status": "Closed",
- "date": "2023-03-15T11:15:48-03:00",
- "note": "Ticket closed successfully"
}
], - "date_scheduling": "2023-03-17T09:00:00-03:00",
- "status": "Closed",
- "creator": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "requester": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "sla": {
- "name": "SLA A",
- "event": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "label": "Custom Field 1",
}
]
}
}
}
Returns a list of tickets
object (SearchTicketParams) Example: search=search=status:closed;period:2023/03/01,2023/03/29;type:operational Search filters. Use semicolon-separated key:value pairs. |
{- "data": [
- {
- "number": 123,
- "ticket": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ticket ABC",
- "category": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Category A"
}, - "subcategory": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Category A"
}
}, - "open_date": "2023-03-15T11:15:48-03:00",
- "end_date": "2023-03-16T14:30:00-03:00",
- "history": [
- {
- "status": "Closed",
- "date": "2023-03-15T11:15:48-03:00",
- "note": "Ticket closed successfully"
}
], - "date_scheduling": "2023-03-17T09:00:00-03:00",
- "status": "Closed",
- "creator": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "requester": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "enrollment": "string",
- "avatar": "string"
}, - "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "qrcode": "string",
- "type": {
- "name": "workspace",
- "description": "Estação de Trabalho.",
- "code_prefix": "EST"
}, - "floor": {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "name": "Ground Floor",
- "path": "Building A > 1st Floor",
- "is_active": true
}, - "building": {
- "uuid": "8d305642-0b1c-4520-8b7c-d30a27c3dd35",
- "name": "Prédio Christian Gustavo Leon",
- "address": "R. Manuela Zaragoça, 8650, Porto Martinho - 13046-085",
- "is_active": true,
- "site": {
- "uuid": "bc5b334c-1ff0-4e85-a5d6-cd5ee7b6c552",
- "name": "Thiago Maia Medina",
- "is_active": true
}
}
}, - "sla": {
- "name": "SLA A",
- "event": [
- {
- "uuid": "123e4567-e89b-12d3-a456-426614174000",
- "label": "Custom Field 1",
}
]
}
}
]
}
Generates a customizable QR code for access control and IoT interactions through Deskbee integration with other systems.
identifier_type | string Type of the identifier. For example, 'email'. |
identifier | string The actual identifier value. For example, an email address. |
code | string <uuid> Unique code associated with the identifier. |
{- "identifier_type": "string",
- "code": "f5d62b05-370e-48be-a755-8675ca146431"
}
{- "data": [
- {
- "identifier": "string",
- "identifier_type": "string",
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f"
}
]
}
The Check-in Automation is a form of integration in which a device sends an event to Deskbee, indicating the Device Code that identifies the location of the person and the person's identifier. With this information, Deskbee locates reservations made by this user in the building structure linked to the device that sent the event, thereby performing the person's automated check-in.
To implement this automation, it is necessary to develop a call to the Deskbee API whenever there is any interaction with the Turnstile / Device. For this purpose, you should contact the company that provides your Access Control to carry out this implementation.
In the Deskbee Panel, navigate to Integrations > Automation and click on 'Checkin / Checkout Automation'.
📢 Contact your Access Control provider to carry out this implementation.
Receives the entry device code and a person's identifier (enrollment number or document number), searches for reservations for the specified building and person, and performs check-in or check-out for the found reservations.
device | string Identifier of the entry device. |
person | string Code identifying the person, which can be an enrollment number or a document identifier.. |
date | string <date-time> ISO 8601 formatted date and time when the event was generated. |
[- {
- "device": "string",
- "person": "string",
- "date": "2019-08-24T14:15:22Z"
}
]
{- "data": {
- "success": [
- {
- "device": "string",
- "person": "string",
- "date": "2019-08-24T14:15:22Z",
- "booking_uuid": "f4eed8e3-aacb-417a-9f78-ebb308e5bd15"
}
], - "fails": [
- {
- "id": "string",
- "message": "string"
}
]
}
}
Webhook Integration: Detailed documentation on the configuration and validation of webhooks.
Configuration in Deskbee Panel: Access as Admin or Master to set up the WebHook.
📢 Security and Requirements: The client's URL must be HTTPS.
In case of failure (e.g., the client returns an HTTP Status other than 200), up to 5 additional attempts are made. The interval between attempts progressively increases to a maximum of 100,000 seconds (~27 hours).
The client should validate the origin of the POST by verifying the HMAC-SHA1 of the request body against the X-Hub-Signature header.
EXPECTED_SIGNATURE=`cat {conteudo do payload} | openssl dgst -sha1 -hmac "{webhook integration key}"`
SIGNATURE={signature}
if [ "$SIGNATURE"="$EXPECTED_SIGNATURE" ]; then
echo "Subscription Valid, received by Deskbee"
fi
import { createHmac } from 'crypto'
const signature = createHmac('sha1', {webhook integration key}).update({conteudo do payload}).digest('hex')
if (equals(signature, {signature})) {
console.log('Subscription Valid, received by Deskbee')
}
This webhook is triggered when a booking is created, updated, or deleted. It sends a payload with detailed information about the booking event.
subscription_id | string <uuid> Webhook subscription ID. |
transaction_id | string <uuid> Unique transaction ID for the event. |
account | string Account code associated with the event. |
send_at | string <date-time> Date and time of the event. |
event | string Event type for booking. |
object Details of the booking action. | |
object Additional detailed information about the booking. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "booking",
- "resource": {
- "action": "created",
- "route": "/bookings/7999cbd9-c919-45b9-8803-49b89ae0b4d4",
- "uuid": "7999cbd9-c919-45b9-8803-49b89ae0b4d4"
}, - "included": {
- "booking_uuid": "f4eed8e3-aacb-417a-9f78-ebb308e5bd15",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "tolerance": {
- "minutes": "15",
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "status": {
- "id": "1",
- "name": "reserved"
}, - "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "type": "workspace",
- "name": "string"
}, - "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "email": "string"
}
}
}
This webhook is triggered when a participant of a meeting performs a check-in, but only if participant check-in is enabled in the Deskbee Panel under meeting room settings. It sends detailed information about the check-in and the associated booking.
subscription_id | string <uuid> Webhook subscription ID. |
transaction_id | string <uuid> Unique transaction ID for the event. |
account | string Account code associated with the event. |
send_at | string <date-time> Date and time of the event. |
event | string Event type for guest check-in. |
object Details of the booking action. | |
object Additional information related to the booking and the guest check-in event. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "guest_checkin",
- "resource": {
- "action": "checkin",
- "route": "string",
- "uuid": "string"
}, - "included": {
- "booking_uuid": "f4eed8e3-aacb-417a-9f78-ebb308e5bd15",
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "checkin": "2019-08-24T14:15:22Z",
- "checkout": "2019-08-24T14:15:22Z",
- "occupation_time": 0,
- "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "type": "workspace",
- "name": "string"
}, - "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "email": "string"
}
}
}
This webhook is triggered when a check-in or check-out is performed, sending details about the booking and the check-in/check-out action.
subscription_id | string <uuid> Webhook subscription ID. |
transaction_id | string <uuid> Unique transaction ID for the event. |
account | string Account code associated with the event. |
send_at | string <date-time> Date and time of the event. |
event | string Event type for check-in or check-out. |
object Details of the check-in/check-out action. | |
object Additional information about the booking and check-in/check-out. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "checkin",
- "resource": {
- "action": "checkin",
- "route": "/bookings/7999cbd9-c919-45b9-8803-49b89ae0b4d4",
- "uuid": "7999cbd9-c919-45b9-8803-49b89ae0b4d4"
}, - "included": {
- "booking_uuid": "f4eed8e3-aacb-417a-9f78-ebb308e5bd15",
- "checkin_uuid": "9e43827e-4eb2-4524-bedf-96bcc7f584e2",
- "start_date": "2019-08-24T14:15:22Z",
- "end_date": "2019-08-24T14:15:22Z",
- "tolerance": {
- "minutes": "15",
- "checkin_min_time": "2019-08-24T14:15:22Z",
- "checkin_max_time": "2019-08-24T14:15:22Z"
}, - "status": {
- "id": "5",
- "name": "busy"
}, - "place": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "type": "workspace",
- "name": "string"
}, - "person": {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "name": "string",
- "email": "string"
}
}
}
This webhook is triggered when a locker is opened, either due to check-in/check-out or when the 'open locker' button is pressed in the app. It sends a payload with the details of the action and the related booking.
subscription_id | string <uuid> Webhook subscription ID. |
transaction_id | string <uuid> Unique transaction ID for the event. |
account | string Account code associated with the event. |
send_at | string <date-time> Date and time of the event. |
event | string Event type, in this case, locker. |
object Details of the locker action. | |
object Additional information about the locker. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "locker",
- "resource": {
- "action": "open-locker",
- "route": "string",
- "uuid": "string"
}, - "included": {
- "place_uuid": "string",
- "place_type": "locker"
}
}
This endpoint is triggered to send data when a group event occurs in Deskbee. Events may include the creation, update, or deletion of a group. The webhook URL and event types are configured by the client in the Deskbee Panel. When a corresponding event is triggered, the webhook sends this payload containing details of the subscription, transaction, account, time of sending, event type, and group resource information.
Webhook event payload for group events.
subscription_id | string <uuid> The webhook subscription ID. |
transaction_id | string <uuid> Unique ID for the webhook event transaction. |
account | string Account associated with the event. |
send_at | string <date-time> The date and time when the event is sent. |
event | string The identifier of the webhook event. |
object Details of the group resource involved in the event. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "squad",
- "resource": {
- "action": "created",
- "route": "/squads/51c47312-6412-46b3-8f65-bacf1e50606b",
- "uuid": "51c47312-6412-46b3-8f65-bacf1e50606b"
}
}
This webhook is triggered when a user is created, updated, or deleted. It sends a payload with details of the action and the affected user.
subscription_id | string <uuid> The webhook subscription ID. |
transaction_id | string <uuid> Unique transaction ID for the event. |
account | string Account code associated with the event. |
send_at | string <date-time> Date and time of the event. |
event | string Event type, in this case, user. |
object Details of the user action. | |
object Additional information about the user. |
{- "subscription_id": "aa11a4c2-a467-43db-b413-c4ab0f5cf627",
- "transaction_id": "0fec1e58-b197-4052-99cf-2218496c5482",
- "account": "string",
- "send_at": "2019-08-24T14:15:22Z",
- "event": "user",
- "resource": {
- "action": "created",
- "route": "/users/3ef39920-5403-4b00-8677-323fb59385de",
- "uuid": "3ef39920-5403-4b00-8677-323fb59385de"
}, - "included": {
- "email": "string",
- "personal_badge": "string"
}
}
Documentation for integrating Deskbee with third-party systems such as SSO, Slack, Calendars, and others.
For detailed guidance and configuration instructions, please visit Deskbee Integrations Documentation.
This section covers various aspects of connecting Deskbee with external services, providing seamless integration to enhance functionality and user experience.
📢 If you have any questions or require assistance, please feel free to contact our support team at help@deskbee.co.