Skip to main content
POST
Recommend Participants

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-API-Key
string | null

Body

application/json
workspace_id
string<uuid>
required
interview_id
string<uuid> | null
limit
integer
default:5
Required range: 1 <= x <= 12
campaign
ParticipantRecommendationCampaignIn · object
existing_person_ids
string<uuid>[]
existing_emails
string[]

Response

Successful Response

recommendations
ParticipantRecommendationOut · object[]
required