Campaigns

Search enrollments

Find enrollments by the lead or the campaign name. Every word in query must appear. Pass campaignId to search inside one campaign. Use the id and campaignId with the campaign lead endpoints.

POST

/api/v1/enrollments/search

Request bodyrequired

queryrequired

string

Text to match. Every word must appear in the record.

campaignIdoptional

string · uuid

Only enrollments in this campaign.

Response

200Matching enrollments.

enrollments

object[]

Up to 20 matches. Each hit includes campaignId.

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