HAhappenstance

Get Search

Changed on

Get search results.

Returns the status and results of a search request. Optionally provide a page_id to retrieve a specific page of results.

get/v1/search/{search_id}

Request

  • Base URL
    https://api.happenstance.ai (the document declares no server; this is the origin it was published from)
  • Auth
    HTTP bearer

Path parameters

search_idstring required

Query parameters

page_idstring nullable

Response

Successful Response

idstring required

Unique identifier for the search request

urlstring required

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

statusstring required

Status of the search (RUNNING, COMPLETED, FAILED)

textstring required

Original search query text

created_atstring required

Timestamp when search was created (ISO 8601 format)

updated_atstring required

Timestamp when search was last updated (ISO 8601 format)

group_idsstring[]

List of group IDs that were searched

include_friends_connectionsboolean

Whether the search included friends' connections

include_my_connectionsboolean

Whether the search included the user's own connections

page_idstring nullable

Page identifier for the current result page. Null for the first page (the parent search itself). For subsequent pages, this is the page_id returned by POST /v1/search/{id}/find-more.

next_pagestring nullable

Page identifier for the next result page. Use as the page_id query parameter on GET /v1/search/{id}?page_id={next_page} to retrieve the next page. Null if no next page exists.

has_moreboolean

Whether more results may be available via POST /v1/search/{id}/find-more. Searches return up to 30 results at a time.

Changes