Skip to main content
GET
Get lead events

Authorizations

X-Api-Key
string
header
required

Your secret ReachBoost API key.

Path Parameters

workspace_uuid
string<uuid>
required

Your unique workspace identifier.

Example:

"YOUR_WORKSPACE_UUID"

Query Parameters

page
integer
default:1

The page number.

Required range: x >= 1
per_page
integer
default:50

The number of results per page.

Required range: 1 <= x <= 100
event_types
enum<string>[]
required

Event types to filter by. Repeat the parameter or pass a comma-separated list.

Minimum array length: 1
Available options:
connection_request_sent,
connection_request_accepted,
connection_request_withdrawn,
follow_up_sent,
follow_up_replied,
profile_visited,
profile_followed,
post_liked
sender_uuid
string<uuid>

Filter by sender UUID.

campaign_uuid
string<uuid>

Filter by campaign UUID.

start_date
string<date>

Start of the date range (YYYY-MM-DD).

Example:

"2026-01-01"

end_date
string<date>

End of the date range (YYYY-MM-DD).

Example:

"2026-01-31"

Response

Paginated list of leads with campaign events

current_page
integer
per_page
integer
total_count
integer
total_pages
integer
next_page
integer | null
prev_page
integer | null
data
object[]