platforms/devplace/rest_search_and_lookups.md

DevPlace REST: Search and Type-Ahead Lookups

The JSON lookup endpoints behind mentions and the message composer: user search and content search, their single q parameter, result caps and response shapes.

Type-ahead lookups that power mentions and the message composer. Both return JSON and accept a single q query parameter. These feed Messaging (the recipient composer) and Profiles & Social Graph (mentions and user pages).

Every endpoint follows the shared Conventions & Errors (auth, content negotiation, pagination, status codes); see Authentication for the four ways to sign requests.

GET /profile/search - Search users

Find up to ten users whose username matches a query.

Minimal role: Member

Parameters

NameInTypeRequiredDescription
qquerystringyesPartial username to match.

Sample response

{
  "results": [
    {
      "uid": "8f14e45f-...",
      "username": "alice_test"
    }
  ]
}

GET /messages/search - Search message recipients

Like user search, but excludes yourself; used by the message composer.

Minimal role: Member

Parameters

NameInTypeRequiredDescription
qquerystringyesPartial username to match.

Sample response

{
  "results": [
    {
      "uid": "0cc175b9-...",
      "username": "bob_test"
    }
  ]
}