Public API
  1. Groups
Public API
  • Welcome to the deskbird Public API
  • Users
    • Lists company users
      GET
    • Lists single company user
      GET
  • Bookings
    • Lists company bookings
      GET
    • Lists single company booking
      GET
  • Groups
    • Lists company user groups
      GET
    • Lists single company user group
      GET
  • Resources
    • Lists company resources
      GET
  • Offices
    • Lists company offices
      GET
    • Check User into Office
      POST
  1. Groups

Lists company user groups

GET
/groups
Groups
Returns company user groups

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Query Params
offset
number 
optional
The offset to start from
Default:
0
Example:
0
limit
number 
optional
The limit of items to return
Default:
100
Example:
100
Header Params
Authorization
string 
required
Public API key for the company

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://connect.deskbird.com/groups' \
--header 'Authorization;'

Responses

🟢200OK
application/json
List of user groups of the company
Body
optional
Example:
{"data":[{"id":"3eab02f6-3406-43fc-98e2-1b25e8f5af02","companyId":"1","name":"Ux-Designers"},{"id":"8c02de34-942e-4c24-a466-9ddb4f50ec92","companyId":"1","name":"Customer success team"}],"offset":0,"limit":2,"total":237}
Example
{
    "data": [
        {
            "id": "3eab02f6-3406-43fc-98e2-1b25e8f5af02",
            "companyId": "1",
            "name": "Ux-Designers"
        },
        {
            "id": "8c02de34-942e-4c24-a466-9ddb4f50ec92",
            "companyId": "1",
            "name": "Customer success team"
        }
    ],
    "offset": 0,
    "limit": 2,
    "total": 237
}
🟠401Unauthorized
🟠403Forbidden
Previous
Groups
Next
Lists single company user group
Built with