Search participants
curl --request GET \
--url https://attend.hackclub.com/api/v1/events/{event_id}/participants/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://attend.hackclub.com/api/v1/events/{event_id}/participants/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://attend.hackclub.com/api/v1/events/{event_id}/participants/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://attend.hackclub.com/api/v1/events/{event_id}/participants/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"participant_id": 123,
"participant_event_id": 123,
"display_name": "Jane",
"full_name": "Jane Doe",
"email": "jsmith@example.com",
"slack_user_id": "<string>",
"phone": "<string>",
"pronouns": "<string>",
"headshot_url": "<string>",
"status": "invited",
"checked_in_at": "2023-11-07T05:31:56Z",
"nfc_badge_token": "<string>",
"nfc_badge_assigned": true,
"has_anaphylaxis_risk": true,
"requires_refrigeration": true,
"cross_contamination_risk": true,
"high_support_flag": true,
"can_leave_unaccompanied": true,
"waiver_signed": true,
"updated_at": "2023-11-07T05:31:56Z",
"scans_by_context": [
{
"scan_context_id": 123,
"scan_context_name": "<string>",
"checks_in": true,
"is_travel_pickup": true,
"is_airport": true,
"scan_count": 123,
"first_scanned_at": "2023-11-07T05:31:56Z",
"last_scanned_at": "2023-11-07T05:31:56Z"
}
],
"travel_inbound": {
"id": 123,
"direction": "inbound",
"mode": "plane",
"visa_required": true,
"visa_status": "<string>",
"visa_type": "<string>",
"visa_number": "<string>",
"passport_nationality": "<string>",
"is_unaccompanied_minor": true,
"carrier": "<string>",
"flight_number": "<string>",
"train_departure_station": "<string>",
"train_arrival_station": "<string>",
"departure_station": "<string>",
"arrival_station": "<string>",
"departure_city": "<string>",
"arrival_city": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"expected_arrival_time": "2023-11-07T05:31:56Z",
"bus_departure_location": "<string>",
"bus_arrival_location": "<string>",
"origin_address": "<string>",
"other_details": "<string>",
"notes": "<string>",
"pickup_dismissed_at": "2023-11-07T05:31:56Z",
"legs": [
{
"id": 123,
"position": 123,
"flight_code": "<string>",
"departure_airport": "<string>",
"arrival_airport": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"live_status": "<string>",
"live_departure_time": "2023-11-07T05:31:56Z",
"live_arrival_time": "2023-11-07T05:31:56Z",
"travel_picked_up_at": "2023-11-07T05:31:56Z",
"airport_picked_up_at": "2023-11-07T05:31:56Z"
}
]
},
"travel_outbound": {
"id": 123,
"direction": "inbound",
"mode": "plane",
"visa_required": true,
"visa_status": "<string>",
"visa_type": "<string>",
"visa_number": "<string>",
"passport_nationality": "<string>",
"is_unaccompanied_minor": true,
"carrier": "<string>",
"flight_number": "<string>",
"train_departure_station": "<string>",
"train_arrival_station": "<string>",
"departure_station": "<string>",
"arrival_station": "<string>",
"departure_city": "<string>",
"arrival_city": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"expected_arrival_time": "2023-11-07T05:31:56Z",
"bus_departure_location": "<string>",
"bus_arrival_location": "<string>",
"origin_address": "<string>",
"other_details": "<string>",
"notes": "<string>",
"pickup_dismissed_at": "2023-11-07T05:31:56Z",
"legs": [
{
"id": 123,
"position": 123,
"flight_code": "<string>",
"departure_airport": "<string>",
"arrival_airport": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"live_status": "<string>",
"live_departure_time": "2023-11-07T05:31:56Z",
"live_arrival_time": "2023-11-07T05:31:56Z",
"travel_picked_up_at": "2023-11-07T05:31:56Z",
"airport_picked_up_at": "2023-11-07T05:31:56Z"
}
]
},
"allergies": "<string>",
"medical_conditions": "<string>",
"medications": "<string>",
"diet_type": "<string>",
"life_threatening_allergies": "<string>",
"freedom_waiver_granted": true,
"emergency_contacts": [
{
"name": "<string>",
"phone": "<string>",
"relationship": "<string>",
"priority": 123
}
],
"parent_guardian_name": "<string>",
"parent_guardian_phone": "<string>",
"parent_guardian_email": "<string>"
}
]
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}Participants
Search participants
Case-insensitive search by name, email, or id. Returns up to 20 matches. Not available to event API keys.
GET
/
events
/
{event_id}
/
participants
/
search
Search participants
curl --request GET \
--url https://attend.hackclub.com/api/v1/events/{event_id}/participants/search \
--header 'Authorization: Bearer <token>'import requests
url = "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://attend.hackclub.com/api/v1/events/{event_id}/participants/search', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://attend.hackclub.com/api/v1/events/{event_id}/participants/search"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://attend.hackclub.com/api/v1/events/{event_id}/participants/search")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://attend.hackclub.com/api/v1/events/{event_id}/participants/search")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"results": [
{
"participant_id": 123,
"participant_event_id": 123,
"display_name": "Jane",
"full_name": "Jane Doe",
"email": "jsmith@example.com",
"slack_user_id": "<string>",
"phone": "<string>",
"pronouns": "<string>",
"headshot_url": "<string>",
"status": "invited",
"checked_in_at": "2023-11-07T05:31:56Z",
"nfc_badge_token": "<string>",
"nfc_badge_assigned": true,
"has_anaphylaxis_risk": true,
"requires_refrigeration": true,
"cross_contamination_risk": true,
"high_support_flag": true,
"can_leave_unaccompanied": true,
"waiver_signed": true,
"updated_at": "2023-11-07T05:31:56Z",
"scans_by_context": [
{
"scan_context_id": 123,
"scan_context_name": "<string>",
"checks_in": true,
"is_travel_pickup": true,
"is_airport": true,
"scan_count": 123,
"first_scanned_at": "2023-11-07T05:31:56Z",
"last_scanned_at": "2023-11-07T05:31:56Z"
}
],
"travel_inbound": {
"id": 123,
"direction": "inbound",
"mode": "plane",
"visa_required": true,
"visa_status": "<string>",
"visa_type": "<string>",
"visa_number": "<string>",
"passport_nationality": "<string>",
"is_unaccompanied_minor": true,
"carrier": "<string>",
"flight_number": "<string>",
"train_departure_station": "<string>",
"train_arrival_station": "<string>",
"departure_station": "<string>",
"arrival_station": "<string>",
"departure_city": "<string>",
"arrival_city": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"expected_arrival_time": "2023-11-07T05:31:56Z",
"bus_departure_location": "<string>",
"bus_arrival_location": "<string>",
"origin_address": "<string>",
"other_details": "<string>",
"notes": "<string>",
"pickup_dismissed_at": "2023-11-07T05:31:56Z",
"legs": [
{
"id": 123,
"position": 123,
"flight_code": "<string>",
"departure_airport": "<string>",
"arrival_airport": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"live_status": "<string>",
"live_departure_time": "2023-11-07T05:31:56Z",
"live_arrival_time": "2023-11-07T05:31:56Z",
"travel_picked_up_at": "2023-11-07T05:31:56Z",
"airport_picked_up_at": "2023-11-07T05:31:56Z"
}
]
},
"travel_outbound": {
"id": 123,
"direction": "inbound",
"mode": "plane",
"visa_required": true,
"visa_status": "<string>",
"visa_type": "<string>",
"visa_number": "<string>",
"passport_nationality": "<string>",
"is_unaccompanied_minor": true,
"carrier": "<string>",
"flight_number": "<string>",
"train_departure_station": "<string>",
"train_arrival_station": "<string>",
"departure_station": "<string>",
"arrival_station": "<string>",
"departure_city": "<string>",
"arrival_city": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"expected_arrival_time": "2023-11-07T05:31:56Z",
"bus_departure_location": "<string>",
"bus_arrival_location": "<string>",
"origin_address": "<string>",
"other_details": "<string>",
"notes": "<string>",
"pickup_dismissed_at": "2023-11-07T05:31:56Z",
"legs": [
{
"id": 123,
"position": 123,
"flight_code": "<string>",
"departure_airport": "<string>",
"arrival_airport": "<string>",
"departure_time": "2023-11-07T05:31:56Z",
"arrival_time": "2023-11-07T05:31:56Z",
"live_status": "<string>",
"live_departure_time": "2023-11-07T05:31:56Z",
"live_arrival_time": "2023-11-07T05:31:56Z",
"travel_picked_up_at": "2023-11-07T05:31:56Z",
"airport_picked_up_at": "2023-11-07T05:31:56Z"
}
]
},
"allergies": "<string>",
"medical_conditions": "<string>",
"medications": "<string>",
"diet_type": "<string>",
"life_threatening_allergies": "<string>",
"freedom_waiver_granted": true,
"emergency_contacts": [
{
"name": "<string>",
"phone": "<string>",
"relationship": "<string>",
"priority": 123
}
],
"parent_guardian_name": "<string>",
"parent_guardian_phone": "<string>",
"parent_guardian_email": "<string>"
}
]
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}{
"error": "Unauthorized"
}Authorizations
Mobile token, global API token, series API key, or event API key. See Authentication above for which endpoints each one reaches.
Path Parameters
Event id or slug.
Query Parameters
Search term. Blank returns no results.
Response
Matching participants (max 20).
Show child attributes
Show child attributes
Was this page helpful?