Skip to main content
GET
/
v1
/
search
/
{id}
JavaScript
import Influship from 'influship';

const client = new Influship({
  apiKey: process.env['INFLUSHIP_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const searchRetrieveResponse of client.search.retrieve(
  '123e4567-e89b-12d3-a456-426614174000',
)) {
  console.log(searchRetrieveResponse.creator);
}
{
  "data": [
    {
      "creator": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "Jane Fitness",
        "bio": "Fitness coach & wellness advocate",
        "avatar_url": "https://cdn.example.com/avatars/jane.jpg"
      },
      "relevant_profile": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "platform": "instagram",
        "username": "fitness_coach_jane",
        "url": "https://www.instagram.com/fitness_coach_jane",
        "followers": 125000,
        "engagement_rate": 3.5,
        "is_verified": true
      },
      "primary_profile": {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "platform": "instagram",
        "username": "fitness_coach_jane",
        "url": "https://www.instagram.com/fitness_coach_jane",
        "followers": 125000,
        "engagement_rate": 3.5,
        "is_verified": true
      },
      "match": {
        "score": 0.85,
        "reasons": [
          "Active fitness content creator",
          "High engagement on workout posts"
        ]
      }
    }
  ],
  "search_id": "123e4567-e89b-12d3-a456-426614174000",
  "total": 87,
  "has_more": true,
  "next_cursor": "eyJvZmZzZXQiOjI1fQ=="
}

Authorizations

X-API-Key
string
header
required

Path Parameters

id
string<uuid>
required

Search ID returned from POST /v1/search

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

Query Parameters

limit
integer
default:25

Maximum results to return

Required range: 1 <= x <= 100
Example:

25

cursor
string

Pagination cursor for next page

Response

Successful response

data
object[]
required
search_id
string<uuid>
required

Search ID. Use with GET /v1/search/{id} for free pagination.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Example:

"123e4567-e89b-12d3-a456-426614174000"

total
integer
required

Total number of results across all pages

Required range: -9007199254740991 <= x <= 9007199254740991
Example:

87

has_more
boolean
required

Whether more results are available

Example:

true

next_cursor
string | null
required

Cursor for the next page

Example:

"eyJvZmZzZXQiOjI1fQ=="