Menu

Search

1 endpoint in the Mattering Comms API.

GET search/ User APIService tier

``GET search/?q=&limit=``: channels and messages the caller can see.

Identity via :func:resolve_identity (fail-closed: no org header is 403). Scope is the ONE visible-channel set the app itself uses (channels_for_user_and_org_qs: org, then the workspace header when present, then visibility: public standard channels plus every channel or DM the caller is a member of), so a private channel's messages never reach a non-member. Query grammar and message matching are shared with the browser topbar search (search_query / search_scope).

Rows: {type, type_label, id, title, subtitle, path} with path the in-app page (/c/<channel>/ or the message permalink). Fewer than two characters of q returns empty data with no query run.

URL

  • User APIhttps://comms.mattering.io/api/user/v1/search/
  • Service tierhttps://comms.mattering.io/api/internal/v1/search/

Query parameters

NameDefault
limitnone
qnone

Responses

200 data and meta envelope

{
  "data": "...",
  "meta": {
    "query": "...",
    "count": 0
  }
}

200 data and meta envelope

{
  "data": [],
  "meta": {
    "query": "...",
    "count": 0
  }
}

Field names come from the code; values are placeholders (... is a string, 0 a number, dates are ISO 8601).

Example

curl -X GET "https://comms.mattering.io/api/user/v1/search/?limit=...&q=..." \
  -H "Authorization: Bearer $MATTERING_API_KEY"

Source: CommsCore/api.py (api.cross_app_search)

All Comms resources
Start Free Explore our Products