Skip to main content
POST
/
v1
/
search
Create Search
curl --request POST \
  --url https://api.happenstance.ai/v1/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "text": "<string>",
  "group_ids": [
    "<string>"
  ],
  "include_friends_connections": false,
  "include_my_connections": false
}
'
{
  "id": "<string>",
  "url": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
text
string
required

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

​
group_ids
string[] | null

List of group IDs to search within.

​
include_friends_connections
boolean
default:false

Search across your friends' connections

​
include_my_connections
boolean
default:false

Search across your own connections

Response

Successful Response

Response from POST /v1/search - creating a new search request.

​
id
string
required

Unique identifier for the search request

​
url
string
required

URL to view the search results on Happenstance