v1

latestOpenAPI 3.1.02026-07-13193557.5 KB

Create Search

Search for people within specified groups and/or within a user's connections.

Use @mentions in your search query to filter results to a specific person's connections (e.g., "engineers @Jane Smith knows"). Use the /v1/groups/{group_id} endpoint to look up member names for @mentions.

Requires sufficient credits. Returns 402 Payment Required if not enough credits. Returns 429 Too Many Requests if you have 10 or more search requests currently running.

post/v1/search

Request body

textstring required

Search query text. Use @mentions to filter results to a specific person's connections (e.g., 'engineers @Jane Smith knows').

group_idsstring[] nullable

List of group IDs to search within.

include_friends_connectionsboolean

Search across your friends' connections

include_my_connectionsboolean

Search across your own connections

search_everyoneboolean

Response

Successful Response

idstring required

Unique identifier for the search request

urlstring required

URL to view the search results on Happenstance

warningstring nullable

Warning message when credit balance is low