Skip to main content
GET
/
v1
/
search
/
{search_id}
Get Search
curl --request GET \
  --url https://api.happenstance.ai/v1/search/{search_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "url": "<string>",
  "status": "<string>",
  "text": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "group_ids": [
    "<string>"
  ],
  "include_friends_connections": false,
  "include_my_connections": false,
  "results": [
    {
      "person_id": "<string>",
      "person_url": "<string>",
      "name": "<string>",
      "traits_score": 123,
      "linkedin_url": "<string>",
      "twitter_url": "<string>",
      "current_title": "<string>",
      "current_company": "<string>",
      "summary": "<string>",
      "mutuals": [
        {
          "user_id": "<string>",
          "name": "<string>",
          "affinity_score": 123
        }
      ],
      "traits": [
        {
          "header": "<string>",
          "score": 123
        }
      ]
    }
  ],
  "parent_search_id": "<string>",
  "has_more": false
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
search_id
string
required

Response

Successful Response

Response from GET /v1/search/{id} - retrieving search status and results.

​
id
string
required

Unique identifier for the search request

​
url
string
required

URL to view the search results on Happenstance (points to parent search for continued searches)

​
status
string
required

Status of the search (RUNNING, COMPLETED, FAILED)

​
text
string
required

Original search query text

​
created_at
string
required

Timestamp when search was created (ISO 8601 format)

​
updated_at
string
required

Timestamp when search was last updated (ISO 8601 format)

​
group_ids
string[]

List of group IDs that were searched

​
include_friends_connections
boolean
default:false

Whether the search included friends' connections

​
include_my_connections
boolean
default:false

Whether the search included the user's own connections

​
results
SearchPersonV1 · object[] | null

Search results (only populated when status is COMPLETED)

​
parent_search_id
string | null

ID of the parent search if this is a continued search

​
has_more
boolean
default:false

Whether more results may be available via POST /v1/search/{id}/find-more. True when status is COMPLETED and the result count meets the threshold for additional results.