GTM verbs

post/v1/find_leads

Request

  • Base URL: https://api.layrcake.dev
  • URL: https://api.layrcake.dev/v1/find_leads
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Optional stable retry key.

Request body

audiencestring required
titlesstring[]
locationsstring[]
industriesstring[]
company_domainsstring[]
limitinteger
route'balanced' | 'cheapest' | 'broadest' | 'fastest'

Source preference for this call: balanced (the default), cheapest (the lowest-cost sources), broadest (the sources expected to find the most) or fastest. The price doesn't change with it. Where route choice isn't available to this key yet, only balanced is accepted.

budget_creditsnumber

Spend ceiling for this call, in credits. If the most the call can cost is above it, limit is lowered to the largest that fits and result.budget_applied says so; the call is refused, before anything is reserved or charged, only when not even one lead fits. It is a ceiling only: it never lets the call use a dearer source. Where spend ceilings aren't available to this key yet, a request that sets it is refused with the reason.

dry_runboolean

Return this call's plan instead of running it, as of evaluated_at: the most it can cost, how many sources could answer, what budget_credits changes, and every limit the real call would trip. Nothing is looked up, reserved or charged, and a later call may differ. Where previews aren't available to this key yet, a request that sets it is refused with the reason.

offer_tokenstring

Accept a previous answer's offer: send the same call again, unchanged, with its offer.offer_token. Only the premium step runs, as its own charge at the offer's price, up to its max_credits; the token works once, until expires_at, and only when max_credits is within this key's premium allowance. Where premium offers aren't available to this key yet, a request that sets it is refused with the reason.

premium'within_budget'

Consent, for this call only, to a dearer source when the standard sources come back short, as long as the whole call, the premium step included, stays within budget_credits (which it requires). The premium step is charged separately and reported in result.premium_step. Without it, budget_credits is only a ceiling. Where premium offers aren't available to this key yet, a request that sets it is refused with the reason.

Response

Successful outcome

Changes

No recorded changes to this operation across all 1 revision of this API.