List Invitations
Retrieve a list of email invitations sent to leads. For each invitation, track engagement status, including whether the lead visited the link or completed sign-up.
link_url
URL of the invitation link sent to the lead.
offering_name
Name of the offering associated with the invitation.
created_by
Name of the user who created the invitation.
id
Unique identifier of the invitation.
offering_id
Identifier of the associated offering. Sting starting with offering_.
lead
Object containing details about the invited lead.
visited
Indicates whether the lead clicked the invitation link.
signed_up
Indicates whether the lead completed sign-up.
sign_up_link_id
Identifier of the sign-up link associated with the invitation.
created_at
Time the invitation was created, in Unix time.
updated_at
Time the invitation was last updated, in Unix time.
{base_uri}/partner/onboarding/sign_up_links/invitations
List Invitations
curl -X GET '{base_uri}/partner/onboarding/sign_up_links/invitations' -H 'access_key: your-access-key-here' \ -H 'Content-Type: application/json' \ -H 'idempotency: your-idempotency-parameter-here' \ -H 'salt: your-random-string-here' \ -H 'signature: your-calculated-signature-here' \ -H 'timestamp: your-unix-timestamp-here' \ -H 'merchant_account_id: your-merchant-account-here' \{ "status": { "error_code": "", "status": "SUCCESS", "message": "Success", "response_code": "", "operation_id": "f40261da-c2cc-410f-bba3-1bbdf5378b13" }, "data": [ { "link_url": "https://dashboard.rapyd.net/branded-sign-up/partner/ced844d19f96b2eed8986086df2da4500478501fd16e3", "offering_name": "Example Offering", "created_by": "Example User", "id": "ced844d19f96b2eed8986086df2da4500478501fd16e3", "offering_id": "offering_7a4e05312b88f2c311cb7e7f5e152571", "lead": { "email": "lead@example.com", "full_name": "John Doe" }, "visited": false, "signed_up": false, "sign_up_link_id": "a564218eda8f854ae26272f64aadb80a761641179e0ba", "created_at": 1779266246, "updated_at": 1779266246 } ] }