GET https://api.usecommune.com/search Production. There is no separate sandbox host.

Search your newsletters

Full text search across the newsletters this credential was granted: the newsletters themselves, their articles and their chat, ranked by relevance. Nothing outside those newsletters is searched.

Results obey the same gates as the resource operations do, evaluated at the public audience. An article stamped with an audience, an article dated in the future, a draft, and a thread that is not public are never returned, so search cannot be used to see around a permission.

Search returns public content only, whatever the credential is. Everything in a result is something a logged out visitor could already read on the web. That is deliberately narrower than what a credential can reach directly: a key granted content:read on its own newsletter still does not find that newsletter's audience-stamped issues or its private rooms here. Read those through the article and thread operations, which evaluate the audience against the credential. Searching your own restricted content is not part of this operation.

A query shorter than two characters returns an empty page rather than an error, so a caller can send it on every keystroke.

Query parameters

  • string Required
  • string
  • string
  • integer
  • string
  • string

Request Headers

  • string
GET /search
Loading...

Share your request

Use this link to easily share a pre-filled request of this operation. Everything you filled will be shared apart from the authentication fields.

Request URL

https://api-reference.usecommune.dev/explorer/operation/operation-search

Send a delete request

It looks like you’re about to send a DELETE request to this API. This type of request carries a risk of permanent and irreversible data loss.

Are you sure you want to continue?
Response
Waiting for a request to be sent.