RoofKit
Developer docsPartner API
API keys

Get lead

Returns one active lead by public lead id.

Bearer API key · Scope: leads.read

Endpoint

GET/api/v1/leads/{lead_id}
Path parameters1 parameter
  • lead_idrequired
    string

    —

Responses

200Lead found.
application/json
object
NameTypeDescription
leadrequiredLead—
401Missing, malformed, revoked, deleted, or unknown API key.

Headers

  • WWW-AuthenticateDocumented response header
application/json
ErrorResponse
403API key lacks the required scope or the workspace is not active.
application/json
ErrorResponse
404Resource not found in the key-bound workspace.
application/json
ErrorResponse
429Rate limit exceeded for this key and endpoint or invalid-auth bucket.

Headers

  • X-RateLimit-LimitMaximum requests allowed in the current window.
  • X-RateLimit-RemainingRequests remaining in the current window.
  • X-RateLimit-ResetISO timestamp when the current rate-limit window resets.
  • Retry-AfterSeconds until the caller should retry.
application/json
ErrorResponse
500Internal authentication or server error.
application/json
ErrorResponse
Try it out
Path parameters