The Scrapyard API can be used to access event locations and the signups of your event. You’re also able to add custom notes to each signup.

Every endpoint except the locations endpoint requires an API key. DM Ian or Samuel to get an API key for your event.

Base URL is https://scrapyard.hackclub.com/api

GET /locations

No parameters

200

Returns all approved events with a location

[
	{
		"id": string,
		"name": string,
		"location": string,
		"slug": string,
		"lat": number,
		"lng": number,
		"format": "24-hour" | "12-hour" | "2-day"
	},
	...
]

GET /organizer/signups

Query parameters:

• event - your event’s slug

Headers:

• Authorization - Bearer YOUR_API_KEY

200

Returns all signups for your event

[
	{
	  "id": string,
	  "createdAt": string (ISO 8601),
	  "email": string,
	  "fullName": string,
	  "preferredName": string,
	  "pronouns": string,
	  "address": string,
	  "phoneNumber": string,
	  "dateOfBirth": string,
	  "parentName": string,
	  "parentEmail": string,
	  "emergencyPhone": string,
	  "allergiesAndMedicalConcerns": string,
	  "reference": string,
	  "tShirtSize": "Small" | "Medium" | "Large" | "Extra Large" | "I don't care" | "I don't want a T-shirt",,
	  "organizerNotes": object,
	},
	...
]

401

Missing or invalid API key

{
	"error": "Missing API key" | "Invalid API key"
}

500