Profile status

5 min read

Check if a company profile exists in the database before requesting enrichment.

POST

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:

  1. Call Profile Status: get existence status, last update date, and specialty count.
  2. If the company exists and is recent: use Profile (cached, 1 credit) to retrieve the full company profile.
  3. 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 successfully
error null
Always null on success
dataobject
Availability and freshness information (null on error responses)
Show child attributesHide child attributes
exists boolean
true if the company exists in the database
lastUpdate string | null
When ReverseContact last fetched this company from the source (ISO 8601). null when exists is false
specialityCount number
Number of company specialties. Only present when exists is true
quotasobject
Credits and rate limit usage after this request
Show child attributesHide child attributes
creditsConsumed number
Credits consumed by this request. Always 0 for Profile Status
workspaceobject
Workspace-level limits
Show child attributesHide child attributes
id string
Your workspace identifier
hasUnlimitedCredits boolean
Whether workspace credits are unlimited
allowDailyOvercost boolean
Whether the workspace may exceed its daily cap
creditsobject
Credit balance
Show child attributesHide child attributes
total number
Total credits in your plan
used number
Credits consumed so far
left number
Remaining credits
dailyLimitobject
Daily request limit (null if not configured)
Show child attributesHide child attributes
limit number
Maximum requests per day
used number
Requests made today
left number
Remaining requests today
nextReset string
When the daily window resets (ISO 8601)
minuteRateLimitobject
Per-minute rate limit
Show child attributesHide child attributes
limit number
Maximum requests per minute
used number
Requests made in the current minute
left number
Remaining requests in the current minute
nextReset string
When the minute window resets (ISO 8601)
keyobject
API key-level limits (null when request is from dashboard)
Show child attributesHide child attributes
id string
API key identifier
dailyLimitobject
Daily limit for this key (null if not configured)
Show child attributesHide child attributes
limit number
Maximum requests per day
used number
Requests made today
left number
Remaining requests today
nextReset string
When the daily window resets (ISO 8601)
minuteRateLimitobject
Minute rate limit for this key
Show child attributesHide child attributes
limit number
Maximum requests per minute
used number
Requests made in the current minute
left number
Remaining requests in the current minute
nextReset string
When the minute window resets (ISO 8601)
metadataobject
Request tracking information
Show child attributesHide child attributes
requestId string
Unique identifier for this request
executionTimeMs number
Total execution time in milliseconds

Previous

Profile live

Next

From email