Get Lead Reach Outs

get

https://api.prahsys.com/merchant/n1/leads/reach-outs

Get all scheduled reach outs for a lead business and/or lead contacts

Query Params

leadBusinessId

string

ID of the lead business to fetch reach outs for

leadContactIds

string | array

One or more lead contact IDs to include in the feed

leadBusinessIds

string | array

One or more lead business IDs to include in the feed. Used to fetch all reachouts across a contact's associated lead businesses in a single request.

userId

string

Filter reach-outs by the user who created them. Used for user-scoped date queries.

dateFrom

string

ISO datetime string. For status=completed, applied to completed_at. For pending/all, applied to scheduled_date.

dateTo

string

ISO datetime string. For status=completed, applied to completed_at. For pending/all, applied to scheduled_date.

status

string

enum

Defaults to all

Filter by completion status. pending = completedAt is null. completed = completedAt is set. all = no filter.

Allowed:

includeLeadBusiness

When true, each reach-out includes a lightweight leadBusiness summary (id, name, phone, city, state, current statuses).

orgWide

When true, returns reach-outs across all reps in the organization for the given date range and status.

Responses

200OK