Directory
Resolve up to 100 records at once
/data-api/v2/directory/{platform}/bulk- Scope
- directory:read
- Freshness
- catalog read
- Group
- Directory
- Platforms
- 7 of 7
What this endpoint answers
One round trip for a batch of handles or ids. Returns the records that exist and an explicit `missing` array for the inputs that do not, so a sync job can tell 'not in the catalog' from 'the call failed'.
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
- Duplicates are collapsed before the lookup; `requested` is the de-duplicated count.
- Handles are matched on lower(handle), which is the shape every platform's handle index is built on.
- This endpoint is not paginated - the 100-value cap is the page.
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 |
|---|---|---|---|---|
platform | path | required | x | Which catalog to read. |
Request body
handlesstring[]optionalUp to 100 handles. Case-insensitive, a leading @ is stripped. Send this or 'ids', not both.
idsstring[]optionalUp to 100 platform ids (numeric for X, Instagram, TikTok and Telegram, channel id for YouTube, DID for Bluesky).
{
"handles": [
"elonmusk",
"nasa",
"thisdoesnotexist"
]
}
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 -X POST "https://crmsolid.com/data-api/v2/directory/x/bulk" \
-H "Authorization: Bearer psk_live_..." \
-H "Content-Type: application/json" \
-d '{"handles":["elonmusk","nasa","thisdoesnotexist"]}'
const res = await fetch("https://crmsolid.com/data-api/v2/directory/x/bulk", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.CRM_SOLID_DATA_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"handles": [
"elonmusk",
"nasa",
"thisdoesnotexist"
]
}),
});
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 json
import os
import requests
body = json.loads("""
{
"handles": [
"elonmusk",
"nasa",
"thisdoesnotexist"
]
}
""")
res = requests.post(
"https://crmsolid.com/data-api/v2/directory/x/bulk",
headers={"Authorization": f"Bearer {os.environ['CRM_SOLID_DATA_API_KEY']}"},
json=body,
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.
- Requested
- 3
- Found
- 1 items
- Missing
- thisdoesnotexist
{
"data": {
"requested": 3,
"found": [
{
"user_id": "44196397",
"username": "elonmusk",
"name": "Elon Musk",
"description": "",
"followers_count": 221384902,
"following_count": 1102,
"statuses_count": 79431,
"media_count": 4612,
"favourites_count": 152889,
"url": null,
"is_verified": false,
"is_blue_verified": true,
"verified_type": null,
"is_automated": false,
"location": "",
"photo_url": "https://pbs.twimg.com/profile_images/1936002956/elon_400x400.jpg",
"banner_url": "https://pbs.twimg.com/profile_banners/44196397/1739948056/1500x500",
"account_created_at": "2009-06-02T20:12:29+00:00",
"language": "en",
"country": "US",
"category": "technology",
"citation_score": 41882,
"tier": "S",
"status": "active",
"is_nsfw": false,
"last_seen": "2026-08-22T22:14:07+00:00",
"weekly_growth": 412004
}
],
"missing": [
"thisdoesnotexist"
]
},
"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
POST /directory/{platform}/bulk documents 8 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.
- 404NotFound
not_foundThe addressed resource does not exist.
- 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, LinkedIn. 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/directory-bulk