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
}
'

import requests

url = "https://api.happenstance.ai/v1/search"

payload = {
    "text": "<string>",
    "group_ids": ["<string>"],
    "include_friends_connections": False,
    "include_my_connections": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    text: '<string>',
    group_ids: ['<string>'],
    include_friends_connections: false,
    include_my_connections: false
  })
};

fetch('https://api.happenstance.ai/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "url": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

API Reference

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/ 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

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
}
'

import requests

url = "https://api.happenstance.ai/v1/search"

payload = {
    "text": "<string>",
    "group_ids": ["<string>"],
    "include_friends_connections": False,
    "include_my_connections": False
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    text: '<string>',
    group_ids: ['<string>'],
    include_friends_connections: false,
    include_my_connections: false
  })
};

fetch('https://api.happenstance.ai/v1/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "id": "<string>",
  "url": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<string>"
}

{
  "title": "<string>",
  "status": 123,
  "type": "https://developer.happenstance.ai/api-reference/introduction#error-response-format",
  "detail": "<string>",
  "instance": "<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.

string

required

Unique identifier for the search request

url

string

required

URL to view the search results on Happenstance

The Basics Get Search