Fetch Single Participant

Fetch Single Participant API endpoint for Sweeppea. POST /participants/single. Retrieve complete participant data including all entries across collections.

POST participants/single

Description

This endpoint allows you to fetch complete data for a single participant in a sweepstakes. The participant can be searched by ParticipantToken, KeyEmail, or KeyPhoneNumber. The endpoint searches across all collections (Participants, ParticipantsAmoe, OptOuts) and returns all entries if the participant appears multiple times.

Request Body Parameters

Parameter Type Required Description
SweepstakesToken String (UUID v4) Yes Unique identifier for the sweepstakes
ParticipantToken String (UUID v4) No* Unique identifier for the participant
KeyEmail String No* Participant's email address
KeyPhoneNumber String No* Participant's phone number (10 digits)

* At least one search parameter (ParticipantToken, KeyEmail, or KeyPhoneNumber) is required

Code Examples

curl -X POST "https://api-v3.sweeppea.com/participants/single" \ -H "Authorization: Bearer YOUR_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "SweepstakesToken": "uuid-v4-string", "KeyEmail": "participant@example.com" }'

Response

200 OK

{ "Response": true, "Data": { "SweepstakesToken": "uuid-v4-string", "SweepstakesName": "Summer Giveaway 2025", "SearchCriteria": { "KeyEmail": "participant@example.com" }, "TotalEntries": 2, "Collections": ["Participants", "OptOuts"], "Entries": [ { "ParticipantToken": "uuid-v4-string", "UserToken": "uuid-v4-string", "SweepstakesToken": "uuid-v4-string", "KeyEmail": "participant@example.com", "KeyPhoneNumber": "5551234567", "BonusEntries": 0, "CreationDate": "2025-06-15T10:30:00.000Z", "EntryPagesFields": { "FirstName": "John", "LastName": "Doe" }, "Status": true, "Collection": "Participants" }, { "ParticipantToken": "uuid-v4-string", "UserToken": "uuid-v4-string", "SweepstakesToken": "uuid-v4-string", "KeyEmail": "participant@example.com", "OptOutDate": "2025-07-01T14:20:00.000Z", "Collection": "OptOuts" } ] } }
Search Examples

Search by ParticipantToken:

{ "SweepstakesToken": "uuid-v4-string", "ParticipantToken": "uuid-v4-string" }

Search by Phone Number:

{ "SweepstakesToken": "uuid-v4-string", "KeyPhoneNumber": "5551234567" }
Error Responses

400 Bad Request

{ "Response": false, "Message": "Missing Search Criteria: ParticipantToken, KeyEmail, or KeyPhoneNumber required", "Code": 400 }

404 Not Found

{ "Response": false, "Message": "Participant Not Found in This Sweepstakes", "Code": 404 }