True on every success response.
The envelope
Every success answer has the same shape.
The success envelope. Every success response carries it.
Envelope fields
okbooleanrequired
request_idstringrequired
The id of this request. Send the request_id to support@leadmcp.ai.
releasestringrequired
The build id that served this response.
dataanyoptional
The payload of the route. The shape depends on the route.
pagePageoptional
The paging block. Present on a paged route.
Show child attributes
returnedintegerrequired
The number of rows in this page.
limitintegerrequired
The page size the request asked for.
totalinteger or nullrequired
The total number of matching rows, or null when the count did not finish inside its budget.
next_cursorstring or nullrequired
The cursor for the next page, or null on the last page.
quotaQuotarequired
The quota block. Every response carries it. It names the plan and the usage; read the plan limits themselves from GET /account. Field names are frozen.
Show child attributes
planstringrequired
The plan slug this account is on. It names the caps; read the numbers themselves from GET /account.
contact_credits_usedintegerrequired
The contact credits this request spent. A count, a schema read or a miss spends zero.
month_remainingintegerrequired
The contact credits left in the current billing month. A paid plan's month starts on its billing date each month; without a subscription it is the UTC calendar month. On the free plan, the contact credits left in the lifetime pool; the pool has no window.
today_remainingintegerrequired
The contact credits left in the current UTC day. On the free plan, the same number as month_remaining.
bindingenumrequired
The window that runs out first at the current pace. On the free plan, always month.
monthday
resets_atstringrequired
The RFC 3339 UTC time at which the binding window resets. On the free plan the pool never resets, and the field is 9999-12-31T23:59:59.000Z.
warningsarray of Warningrequired
Non fatal notes about this response. Empty on a clean call.
Show child attributes
codeenumrequired
The warning code.
count_unavailableno_rowsexport_truncatedduplicate_work_emailduplicate_linkedinoff_domaindeprecatedmax_followers_missing
messagestringrequired
One sentence a developer can read.
hintstringoptional
The suggested next action, for example to remove one key and count again.
keys_appliedarray of stringoptional
On no_rows, the filter keys that were applied. On off_domain, the inputs we hold at another employer.
resets_atstringoptional
On export_truncated, present only when a contact credit cap cut the job: the RFC 3339 UTC time at which the cap that cut the job resets. On the free plan the pool never resets, and the field is 9999-12-31T23:59:59.000Z; the hint then says the pool is spent and points to the upgrade. get_export can also return export_truncated, with no resets_at, when max_rows_per_company kept fewer rows than rows_to_export; only exported rows are charged.
page
The paging block. Present on a paged route.
returnedintegerrequired
The number of rows in this page.
limitintegerrequired
The page size the request asked for.
totalinteger or nullrequired
The total number of matching rows, or null when the count did not finish inside its budget.
next_cursorstring or nullrequired
The cursor for the next page, or null on the last page.
quota
The quota block. Every response carries it. It names the plan and the usage; read the plan limits themselves from `GET /account`. Field names are frozen.
planstringrequired
The plan slug this account is on. It names the caps; read the numbers themselves from GET /account.
contact_credits_usedintegerrequired
The contact credits this request spent. A count, a schema read or a miss spends zero.
month_remainingintegerrequired
The contact credits left in the current billing month. A paid plan's month starts on its billing date each month; without a subscription it is the UTC calendar month. On the free plan, the contact credits left in the lifetime pool; the pool has no window.
today_remainingintegerrequired
The contact credits left in the current UTC day. On the free plan, the same number as month_remaining.
bindingenumrequired
The window that runs out first at the current pace. On the free plan, always month.
monthday
resets_atstringrequired
The RFC 3339 UTC time at which the binding window resets. On the free plan the pool never resets, and the field is 9999-12-31T23:59:59.000Z.
warnings
One non fatal note on a successful response.
codeenumrequired
The warning code.
count_unavailableno_rowsexport_truncatedduplicate_work_emailduplicate_linkedinoff_domaindeprecatedmax_followers_missing
messagestringrequired
One sentence a developer can read.
hintstringoptional
The suggested next action, for example to remove one key and count again.
keys_appliedarray of stringoptional
On no_rows, the filter keys that were applied. On off_domain, the inputs we hold at another employer.
resets_atstringoptional
On export_truncated, present only when a contact credit cap cut the job: the RFC 3339 UTC time at which the cap that cut the job resets. On the free plan the pool never resets, and the field is 9999-12-31T23:59:59.000Z; the hint then says the pool is spent and points to the upgrade. get_export can also return export_truncated, with no resets_at, when max_rows_per_company kept fewer rows than rows_to_export; only exported rows are charged.
The codes are listed on Errors and warnings.
Docs for agents: llms.txt