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

    Resources

    The Resources API allows you to retrieve resource data from the Deskbird system. This endpoint supports pagination and filtering options based on office, zone, and resource type.

    Authentication#

    All resource-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#

    Get Resources#

    Endpoint:
    GET /resources
    Description:
    Retrieves a list of resources with optional filters and pagination.
    Query Parameters:
    limit (integer, optional) – The maximum number of resources returned per request.
    officeId (string, optional) – The ID of the office where the resources are located.
    offset (integer, optional) – The starting point for retrieving resources (used for pagination).
    type (ResourceType, optional) – The type of resource to filter results.
    Allowed values:
    flexDesk
    meetingRoom
    other
    parking
    zoneId (string, optional) – The ID of the zone where the resources are located.
    Headers:
    Authorization: Bearer <your_api_key>
    Example Request:
    By using the Resources API, you can efficiently retrieve resources with filtering and pagination while ensuring secure access through token-based authentication.
    Previous
    Lists single company user group
    Next
    Lists company resources
    Built with