Search workspaces - Huddle/huddle-apis GitHub Wiki

Summary

The APIs for Workspace Search with search term and creation date range.

Table of contents

Operation
Search for Workspaces

Operations

Search for Workspaces

You can search for Workspaces based on a free-text query, creation date range, and optional page size.

Example 1: Basic Search

The following example requests a search for Workspaces containing the word "enhance".

Request:

GET /membership/workspaces/search?query=enhance&pageSize=100 HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: Bearer <token>

Example 2: Search with Date Range

This example adds filters to only include workspaces created between July 1, 2025 and July 25, 2025.

GET /membership/workspaces/search?query=enhance&createdFrom=2025-07-01&createdTo=2025-07-25&pageSize=50 HTTP/1.1
Accept: application/vnd.huddle.data+json
Authorization: Bearer <token>

Response (Example 1)

HTTP/1.1 200 OK
Content-Type: application/vnd.huddle.data+json
{
    "links": [
        {
            "rel": "self",
            "href": "https://api.huddle.x2/membership/workspaces/search?query=enhance&pageSize=100"
        }
    ],
    "results": [
        {
            "workspace": {
                "actors": [
                    {
                        "name": "Jane Doe",
                        "email": "[email protected]",
                        "rel": "owner",
                        "links": [
                            {
                                "rel": "self",
                                "href": "https://api.huddle.x2/membership/users/3356"
                            },
                            {
                                "rel": "avatar",
                                "href": "https://api.huddle.x2/files/users/3356/avatar"
                            },
                            {
                                "rel": "alternate",
                                "href": "https://my.huddle.x2/user/id/3356"
                            }
                        ]
                    }
                ],
                "title": "Enhanced search epic",
                "description": "<p>This is my huddle workspace</p>",
                "created": "2025-07-18T02:45:06.08",
                "links": [
                    {
                        "rel": "self",
                        "href": "https://api.huddle.x2/membership/workspaces/3363"
                    },
                    {
                        "rel": "alternate",
                        "href": "https://my.huddle.x2/workspace/3363",
                        "type": "text/html"
                    }
                ]
            }
        }
    ]
}

Request Parameters

Name Type Required Description
query string Yes Free text to search workspace names and descriptions.
createdFrom date No Filters workspaces created on or after this date. Ignored when createdTo is not provided.
createdTo date No Filters workspaces created on or before this date. Ignored when createdFrom is not provided.
pageSize integer No Maximum number of results to return. Default is 100.

Response Properties

Property Description
links A list of hyperlinks related to this response (e.g., self).
results A collection of workspaces matching the search criteria.

Workspace Object Fields

Field Description
title Name of the workspace
description Description of the workspace (may include HTML)
created ISO timestamp when the workspace was created
actors List of users with roles related to the workspace
links Related resource links for the workspace

Actor Object Fields

Field Description
name Name of the user
email Email address of the user
rel Relationship to the workspace (e.g., owner)
links List of related user links (self, avatar, alternate)

Response Link Relations

Name Description Methods
self The URI of this workspace resource GET
alternate The workspace URL to redirect -

Other Responses

Case Response
Invalid authorization token 401 Unauthorized
Invalid parameters 400 Bad Request
⚠️ **GitHub.com Fallback** ⚠️