Introduction
The Company Profile Status endpoint verifies whether a company profile exists in our database and returns freshness information. Use it to check data availability before spending credits on a full fetch or a live pull.
When to use
A typical cost-optimized workflow looks like this:
- Call Profile Status: get existence status, last update date, and specialty count.
- If the company exists and is recent: use Profile (cached, 1 credit) to retrieve the full company profile.
- If the company is stale or missing: use Profile live (fresh from Social, 2 credits) for an up-to-date result.
This simple check → fetch/live decision can save significant credits at scale.
Note
Profile Status is free, but it still requires a non-empty credit balance. When your workspace reaches 0 credits it returns 402 NO_CREDITS (top up to resume), since no fetch or live pull could follow anyway.
Authorization
apikey
string
required
Your API key from the developer dashboard. Pass it via
Authorization: Bearer YOUR_API_KEY header.Request body
Provide either url or id. If both are supplied, id takes precedence.
url
string
conditional
Public Social company URL (e.g.
https://social.com/company/acme-corp). Required unless id is given.id
string
conditional
ReverseContact company id from a previous response (e.g.
com_01jbd5vewyenebxgaz869ffe5t). Required unless url is given.Response structure
success
boolean
true if the request was processed successfullyerror
null
Always
null on success