Participant Management: Everything in a single call (ParticipantProfileValues)

The ParticipantProfileValues endpoint is a powerful tool for querying, updating, or deleting a participant's information. Its main strength lies in data centralisation: unlike other endpoints that require multiple queries to join information together, this endpoint automatically retrieves demographic data, financial data, and, most importantly, all Custom Fields filled in by the user in a single response.

Retrieve the complete profile (GET)

This resource allows you to search for a participant using their ID, Serial Number, or External Identifier.

Endpoint: GET /v1.0/:key/ParticipantProfileValues/:identifier

Why use this endpoint? The main advantage is that there is no need to make additional calls to discover the answers to dynamic forms. The system automatically cross-references participant information with the fields configured in the project.

The response includes:

• Demographics: Name, company, address, email, biography, etc.

• Financials: Total balances, amounts paid, and total booked.

• Custom Fields (The key): If your form has questions such as "Allergies?" or "T-shirt Size", these will appear at the same level as the first name or surname. The system automatically detects the response type (Text, Date, Dropdown menu) and delivers the final processed value.

Update a participant (POST)

Updating a profile is just as simple and intelligent. You do not need to specify which database table you wish to modify; the endpoint detects the type of field you are sending.

Endpoint: POST /v1.0/:key/ParticipantProfileValues/:identifier

How it works:

• Standard Data: If you send fields such as First_Name or Email, the system updates the basic record.

• Dynamic Fields: Any other field you send in the request body will be searched for in the User Fields list. If the field exists (e.g., "DietaryPreference"), the system will automatically update or insert the value.

Delete a participant (DELETE)

If you need to remove a user from a specific project, this method ensures that both their main record and all values associated with their custom fields are cleared.

Endpoint: DELETE /v1.0/:key/ParticipantProfileValues/:identifier
 

Response Example (GET)

{
    "Person_Id": "10255",
    "First_Name": "Ana",
    "Family_Name": "García",
    "Company": "Tech Solutions",
    "Email": "ana.garcia@example.com",
    "Category_Name": "VIP",
    "Total_Paid": "150.00",
    // Custom Fields (retrieved automatically)
    "T_Shirt_Size": "M",
    "Dietary_Requirements": "Vegetarian",
    "Transport_Required": "Yes"
}