Leads
SensitiveFirmographic market sizing with real counts
/data-api/v2/leads/linkedin/segments- Scope
- leads:read
- Freshness
- catalog read
- Group
- Leads
- Platforms
- 1 of 7
What this endpoint answers
How many companies exist in a slice of the catalog, and how reachable that slice is. Group by industry, country, size band or founding decade, filter on any of the others, and get true counts rather than a facet list with no numbers behind it. Every row is an aggregate over companies, so nothing here identifies a person and the surface is aggregate by construction rather than by a filter somebody has to remember.
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 leads:read scope (Leads): LinkedIn company and contact data, and X follower-graph exports.
Good to know
- Counts are exact, not sampled. Measured on production: 452ms for the widest grouping and 386ms with an industry filter, cached for two minutes on top because a segment count does not move in seconds.
- '(unknown)' is a real bucket and is never hidden. country_code is populated on 82.32 percent of rows and founded_year on 70.70 percent. In the worked example above, grouping Software Development by country puts 1,422 of 7,776 companies - 18.3 percent - in the unknown bucket, so a chart that drops it is understating the market by nearly a fifth.
- crawl_succeeded is enrich_status 'ok': the website contact crawl completed. It is NOT 'has an email address'. 49,813 companies are 'ok' and 37,896 of them - 76.1 percent - actually yielded one. The exact email-holding count was measured at 2,425ms and dropped as too slow for a synchronous endpoint.
- hq_country is not offered as a dimension. At 1.51 percent populated it would report a market of 1,418 companies out of 93,677 while looking like an answer.
- min_staff and max_staff filter on the exact headcount, which is present on 91.82 percent of rows. A company with no headcount is excluded by either bound rather than assumed to be small.
- This is aggregate data about organisations. No row identifies a person, and no contact data is returned at any bucket size.
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 |
|---|---|---|---|---|
by | query | optional | country | Dimension to group on. |
industry | query | optional | Software Development | Restrict to one industry, exactly as LinkedIn writes it. |
country | query | optional | DE | ISO 3166-1 alpha-2. Matched against country_code, never the free text. |
size_band | query | optional | 51-200 employees | LinkedIn size band, e.g. '51-200 employees'. |
min_staff | query | optional | 50 | Lower bound on exact headcount. Companies with no headcount are excluded. |
max_staff | query | optional | 500 | Upper bound on exact headcount. Companies with no headcount are excluded. |
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/leads/linkedin/segments" \
-H "Authorization: Bearer psk_live_..."
const res = await fetch("https://crmsolid.com/data-api/v2/leads/linkedin/segments", {
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/leads/linkedin/segments",
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.
- Dimension
- country
- Filters industry
- Software Development
- Buckets
- 3 items
- Totals companies
- 7,776
- Totals with domain
- 7,518
- Totals crawl succeeded
- 4,088
- Coverage measured at
- 2026-08-31
- Coverage rows
- 93,677
{
"data": {
"dimension": "country",
"filters": {
"industry": "Software Development"
},
"buckets": [
{
"bucket": "US",
"companies": 3094,
"with_domain": 3041,
"crawl_succeeded": 1580,
"with_staff_count": 2975,
"median_staff": 110,
"active_last_90d": 2247
},
{
"bucket": "(unknown)",
"companies": 1422,
"with_domain": 1315,
"crawl_succeeded": 680,
"with_staff_count": 1213,
"median_staff": 42,
"active_last_90d": 846
},
{
"bucket": "IN",
"companies": 512,
"with_domain": 493,
"crawl_succeeded": 294,
"with_staff_count": 474,
"median_staff": 58,
"active_last_90d": 304
}
],
"totals": {
"companies": 7776,
"with_domain": 7518,
"crawl_succeeded": 4088
},
"coverage": {
"measured_at": "2026-08-31",
"rows": 93677
}
},
"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 /leads/linkedin/segments 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 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/leads-linkedin-segments