ℹ️Participant Details

This page describes how to obtain details of a participant.

Important Note! Constructor Groups’ V1 API has been retired and is no longer available to new customers. Please use the Groups V2 API going forward. Link to V2 API documentation: https://developer.perculus.com/v2-en

In Groups API, there are two ways to obtain details of a participant:

Both methods require SESSION_ID and respective parameter when making requests.

By ATTENDANCE_CODE

You need the SESSION_ID of the session and the ATTENDANCE_CODE, which is the participant ID of the user, to get the participant details for a session.

Example Payload:

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<ATTENDANCE_CODE>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get the attandee by ATTENDANCE_CODE
attendee = client.attendees.get_by_attendance_code(
    session_id="<SESSION_ID>",
    attendance_code="<ATTENDANCE_CODE>"
)
print(attendee)

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get Attendee
const attendee = client.attendees.getAttendee(
    "<SESSION_ID>", "<ATTENDANCE_CODE>" 
)
console.log(attendee)

By EMAIL

You need the SESSION_ID of the session and the EMAIL, which is the email of the user, to update the participant in a session.

Example Payload:

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: application/json' \
--data ''

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Get the attandee by EMAIL
attendee = client.attendees.get_by_email(
    session_id="<SESSION_ID>",
    email="<EMAIL>"
)
print(attendee)

import APIClient from "perculus-sdk"

// API client
const client = new APIClient()
...

// Get Attendee
const attendee = client.attendees.getAttendee(
    "<SESSION_ID>", "<EMAIL>" 
)
console.log(attendee)

PreviousFiltering Participants NextReports

Last updated 4 months ago

hashtagBy ATTENDANCE_CODE

hashtagBy EMAIL

By ATTENDANCE_CODE

By EMAIL