Skip to main content

GET

Search [Beta]

Beta Notice

The /search endpoint is still in active beta. The API contract may change before it becomes generally available.

/api/v1/app/search/

Endpoint

/api/v1/app/search/

Query Strings

?show_all=true

Admin users only. Allows access to all results.

?q=<str:search_query>

The search query.

?limit=<int:result_limit>

How many results to show.

Headers

{
    "Content-Type": "application/json",
    "Authorization": "Bearer <str:token>"
}

Response

{
    "panels": [
        {
            "panel_id": "<int:panel_id>",
            "panel_name": "<str:panel_name>"
        }
        ...
    ],
    "threads": [
        {
            "panel_id": "<int:panel_id>",
            "panel_name": "<str:panel_name>",
            "thread_id": "<int:thread_id>",
            "thread_name": "<str:thread_name>"
        }
        ...
    ],
    "messages": [
        {
            "panel_id": "<int:panel_id>",
            "panel_name": "<str:panel_name>",
            "thread_id": "<int:thread_id>",
            "thread_name": "<str:thread_name>",
            "message_id": "<int:message_id>",
            "message_content": "<str:message_content>"
        }
        ...
    ]
}