Skip to main content
GET
Get Lead
Rate Limits:
  • Request Rate: ~100 requests per 5 seconds per project (same as other lead APIs).
  • Heavy use of this endpoint (especially with masked=false) can be expensive; cache results when possible.

Query Parameters

string
MongoDB ObjectId of the lead (required if not using referenceId)
string
External reference ID (requires projectId and processId)
string
Required when using referenceId
string
Required when using referenceId
boolean
default:"false"
If true, masks phone number (all but last 4 digits)

Response

boolean
Indicates if the request was successful
object
The lead object with activities

Error Responses

  • 400 Bad Request
    • Missing identifier
      • Returned when neither leadId nor referenceId is provided.
      • Example:
    • Missing projectId/processId with referenceId
      • Returned when referenceId is provided without both projectId and processId.
      • Example:
  • 404 Not Found
    • Returned when no lead matches the provided identifiers.
    • Examples:
  • 429 Too Many Requests
    • Returned when project-level rate limits are exceeded for this endpoint.
    • Recommended behavior:
      • Back off and retry later with exponential backoff.
      • Avoid hot-loop polling; cache results on your side when possible.
  • 500 Internal Server Error
    • Unexpected server-side error.
    • Safe to retry with backoff; if it persists, contact support with request details.