Events

Search events

POST

/api/v1/events/search

Request bodyrequired

typesoptional

string[]

channeloptional

"linkedin" | "instagram"

campaignIdoptional

string · uuid

leadIdoptional

string · uuid

enrollmentIdoptional

string · uuid

Only events recorded for this campaign enrollment.

accountIdoptional

string · uuid

actorUserIdoptional

string · uuid

Only events caused by this member: what they sent, approved or stopped, and what campaigns they started sent.

fromoptional

string · date

tooptional

string · date

cursoroptional

string

limitoptional

integer

Response

200A page of events, newest first. Filter by campaign, lead, enrollment, account, member, type, channel, or date. Pass nextCursor as cursor for the next page.

events

object[]

nextCursor

string | null

requestId

string · uuid

Id of this request, for support and troubleshooting

Errors

  • 400: Bad request
  • 401: Unauthorized: missing or invalid API key
  • 403: Forbidden
  • 404: Not found
  • 422: Invalid request payload

Search docs

Search documentation, API reference, and MCP tools

We use cookies to enhance your experience on Needle and keep your data secure. Privacy Policy