Public API
    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

    Groups

    The Groups API allows you to retrieve group data from the Deskbird system. You can fetch multiple groups with pagination support or retrieve details of a specific group.

    Authentication#

    All group-related endpoints require authentication via a valid API Key in the Authorization header. Ensure that you include a valid API key in your requests.

    Endpoints#

    1. Get Groups#

    Endpoint:
    GET /groups
    Description:
    Retrieves a list of groups with optional pagination.
    Query Parameters:
    limit (integer, optional) – The maximum number of groups returned per request.
    offset (integer, optional) – The starting point for retrieving groups (used for pagination).
    Headers:
    Authorization: Bearer <your_api_key>
    Example Request:

    2. Get Single Group#

    Endpoint:
    GET /groups/{groupId}
    Description:
    Retrieves details of a specific group by its unique groupId.
    URL Parameters:
    groupId (string, required) – The unique identifier of the group to be fetched.
    Headers:
    Authorization: Bearer <your_api_key>
    Example Request:

    By using the Groups API, you can efficiently manage groups while ensuring secure access through token-based authentication.
    Previous
    Lists single company booking
    Next
    Lists company user groups
    Built with