People
Find accounts matching audience and engagement criteria
/data-api/v2/people/search- Scope
- directory:read
- Freshness
- catalog read
- Group
- People
- Platforms
- 6 of 7
What this endpoint answers
Cross-platform discovery: audience band, measured engagement, language, category, verified status and full-text terms, applied to every catalog at once and returned as one ranked group per platform. This is the 'find me creators like this' query, without running it six times.
This is a catalog read: it is served from the CRM Solid database in milliseconds, costs one budget unit, and reports how old the reading is in meta.cache_age_s. It needs the directory:read scope (Directory): Read the account and channel catalog across all seven platforms.
Good to know
- A filter a catalog cannot serve is listed in that platform's `ignored` array and the rest of the filters still apply. It is never dropped silently, so a row count is always attributable to the constraints that actually ran.
- `scan` says how a group was produced: "ranked" came off the audience-ordered index and is the true top of that catalog; "bounded" came from a capped candidate scan because the filter could not be served in audience order, so it is the best of what was scanned.
- Results are ranked by audience within each platform. There is no meaningful way to rank a Telegram channel against a YouTube channel on one axis, so the API does not pretend there is.
- Not paginated: this is a discovery probe, and per_platform caps the work. Page through a single catalog with /directory/{platform} once you know where to look.
Parameters
Every value the call accepts, with the example the spec ships so the request runs as written.
| Name | In | Required | Example | What it does |
|---|---|---|---|---|
min_audience | query | optional | - | Lower bound on followers / subscribers / participants. |
max_audience | query | optional | - | Upper bound on the same metric. |
min_engagement | query | optional | - | Minimum measured engagement rate, percent. Instagram only; reported as ignored elsewhere. |
language | query | optional | - | ISO 639-1 language code, as classified from the profile text. |
category | query | optional | - | Cross-platform category from the shared classifier. |
verified | query | optional | - | Restrict to verified accounts. |
q | query | optional | - | Full-text terms over name and bio. Skipped on catalogs with no full-text index. |
platforms | query | optional | x | Comma-separated subset to search. Defaults to all six. |
per_platform | query | optional | - | Rows per platform, 1-25. Default 10. |
Call it
Authenticate with a bearer token or the x-api-key header. Keys are server-to-server credentials. Never embed one in front-end code - call the API from your own backend and forward the result.
curl "https://crmsolid.com/data-api/v2/people/search" \
-H "Authorization: Bearer psk_live_..."
const res = await fetch("https://crmsolid.com/data-api/v2/people/search", {
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
},
});
if (!res.ok) {
const { error } = await res.json();
throw new Error(`${error.code}: ${error.message} (${error.request_id})`);
}
const { data, meta } = await res.json();
import os
import requests
res = requests.get(
"https://crmsolid.com/data-api/v2/people/search",
headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
timeout=30,
)
res.raise_for_status()
payload = res.json()
data, meta = payload["data"], payload["meta"]
Keys look like psk_live_... for production keys, psk_test_... for test keys and are minted in the panel.
What comes back
Success is { data, meta }. Failure is { error: { code, message, request_id } }. The body below is the spec's own example: the values in it are illustrative readings, not live numbers.
- Filters min Audience
- 10,000
- Filters max Audience
- 100,000
- Filters min Engagement
- 3
- Filters language
- en
- Filters verified Only
- no
- Groups
- 2 items
{
"data": {
"filters": {
"minAudience": 10000,
"maxAudience": 100000,
"minEngagement": 3,
"language": "en",
"category": null,
"verifiedOnly": false,
"q": null
},
"groups": [
{
"platform": "instagram",
"count": 10,
"scan": "bounded",
"ignored": [],
"people": [
{
"platform": "instagram",
"handle": "example",
"name": "Example Creator",
"audience": 48120,
"audience_metric": "followers",
"verified": false,
"engagement_rate": 5.8102,
"language": "en",
"category": "fitness",
"url": "https://instagram.com/example"
}
]
},
{
"platform": "x",
"count": 10,
"scan": "ranked",
"ignored": [
{
"filter": "min_engagement",
"reason": "Engagement is only measured where the crawl returns per-post counts, which today is Instagram."
}
],
"people": []
}
],
"unavailable": []
},
"meta": {
"request_id": "req_9f2c41a8b3d5",
"generated_at": "2026-08-23T09:14:02.317Z",
"took_ms": 42
}
}
The meta block
request_idstringrequiredUnique id for this request. Quote it in a support ticket.
generated_atstringrequiredServer time the response was produced.
took_msintegerrequiredMilliseconds spent server-side.
pagePageoptionalsourcestringoptionalWhich backend served the payload, for endpoints with more than one.
cache_age_sintegeroptionalAge of the underlying data in seconds. 0 for live reads.
When it fails
GET /people/search documents 7 failure statuses. Branch on error.code, which is stable and enumerated; message is prose and may change.
- 401Unauthorized
unauthorized | invalid_keyNo key was presented, or the key is unknown, revoked or expired.
- 402PaymentRequired
payment_required | subscription_inactiveThe key is valid but the plan behind it cannot serve the call: the included requests are spent and overage is switched off, capped or unfunded (payment_required), or the billing period lapsed and was not renewed (subscription_inactive). Retrying does not help; paying does. The X-Plan-* headers on this response say how far past the line you are.
Carries X-Plan, X-Plan-Limit, X-Plan-Overage, X-Plan-Period-End, X-Plan-Remaining.
- 403Forbidden
forbidden_scope | forbidden_ipThe key is valid but not allowed to make this call: it lacks the scope, or the request came from an address outside the key's allowlist.
- 422InvalidRequest
invalid_requestA parameter is malformed, out of range or mutually exclusive with another. `details` names the offending fields.
- 429RateLimited
rate_limited | quota_exceededEither the burst ceiling for the current minute or the daily quota is spent. Distinguish with the code: rate_limited clears within the minute, quota_exceeded does not clear until 00:00 UTC.
Carries Retry-After, X-Quota-Limit, X-Quota-Remaining, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, X-Request-Id.
- 500InternalError
internal_errorSomething failed on our side. Internals are never leaked; quote the request id.
- 503Unavailable
upstream_timeout | upstream_error | not_configuredThe request could not be served right now. BRANCH ON error.code, not on the status: 'upstream_timeout' means a source was too slow (this is what a catalog query hitting its 15-second statement timeout returns, so it is reachable from any endpoint that reads the corpus, not only the live-scrape ones) and the same call is worth retrying with backoff - narrowing it with a smaller limit, a filtered scope or a less popular account makes it far less likely; 'upstream_error' means a source was unreachable, so back off further; 'not_configured' means the capability has no backing service in this deployment, and retrying will never help.
Every response carries X-Request-Id and meta.request_id. Quote it in support requests.
Coverage and limits
This endpoint covers X, Instagram, TikTok, YouTube, Telegram, Bluesky. Rate limits come from the tier on your key.
| Tier | Requests a minute | Requests a day | Live reads a minute |
|---|---|---|---|
| free | 30 | 1,000 | 5 |
| standard | 120 | 25,000 | 20 |
| pro | 600 | 250,000 | 60 |
| unlimited | 6,000 | 10,000,000 | 600 |
This call only draws on the ordinary per-minute and per-day columns. Every response reports where you stand in X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset and the X-Plan headers.
Start calling it
A key takes a minute to mint in the panel, no card. The reference covers authentication, the envelope, scopes, rate limits and every error code in one page.
Reference path: /data-api/reference/people-search