Authentication
Every endpoint exceptGET /health needs a credential: an API key (on every plan,
starting with pay-as-you-go) or an OAuth Connect token, sent as a bearer token:
401 unauthorized with a pointer to sign up. See the
Authentication guide for details.
Response envelope
Every response is a JSON envelope. Success:data is the payload (an object or an array). meta is optional and carries things
like pagination on list endpoints. error.details
is present only on some errors.
Pagination
List endpoints are page-based (1-indexed). Passpage and page_size (max 100,
default 20). The response’s meta.pagination tells you whether to keep going:
Full review evidence
For review-sourced opportunities,GET /opportunities/{id} includes four nullable
strings under data.review: review_title, pros, cons, and general_comments.
These are the full stored fields, not an AI summary. Missing source fields stay
null; a partial review does not produce invented replacement text. The opportunity
list does not include these fields.
On pricing version 2, all four fields are null until your team reveals the reviewer,
including when the company is already known from another reviewer. A successful
POST /opportunities/{id}/reveal returns the authorized fields under
data.opportunity.review; later detail reads keep returning them. Revealing the same
reviewer again returns the evidence with credits_used: 0. Legacy pricing version 1
retains access to stored review text without a reviewer reveal.
For example, a revealed review with no stored general comment can contain:
review, not the entire response. Before a pricing-v2 reveal,
the same four keys are present with null values. Existing organization and source
access rules still apply: knowing an opportunity ID does not grant access to another
team’s evidence. Email, phone, and buying-committee unlocks retain their separate gates.
Errors
Errors use a stable machinecode plus a human message. The HTTP status matches the
code, except that internal_error is also returned with 503:
See the error reference and rate limits for the
full story.