Filtering Participants

This step shows how to filter participants via PerculusAPI

If you like to see all participants belonging to a session, you can achieve this by not sending any parameters to the request.

Available parameters:

Parameter	Type	Description
user_id	string	GUID of the user
attendance_code	string	Attendance code of the participant
name	string	Name of the participant
surname	string	Surname of the participant
email	string	Email of the participant
role	string	Role of the participant(see for possible values)
mobile	string	Mobile of the participant
page_size	integer	Page size
page_number	integer	Page number

Example payload:

CURL

curl --location --request GET 'https://<DOMAIN>/xapi/session/<SESSION_ID>/attendee/<EMAIL>' \
--header 'Authorization: Bearer <ACCESS_TOKEN>' \
--header 'Content-Type: x-www-form-urlencoded' \
--data-urlencode 'name=john' \
--data-urlencode 'surname=doe'

Python

from perculus_sdk.client import APIClient

# API client
client = APIClient()
...

# Filter Attendees
attendees = client.attendees.search_attendees(
    session_id="<SESSION_ID>",
    params={
        "name": "<NAME>",
        "role": "<ROLE>"
    }
)
print(attendees)

C#

// ASAP :)

NodeJS

import APIClient from "perculus-sdk"

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

// Get Attendees
const attendees = client.attendees.searchAttendees("<SESSION_ID>",
    {
        name: "<NAME>",
        role: "<ROLE>"
    }
)
console.log(attendees)

GO

// ASAP :)