README.md

V0.1

The bridges tying Hack Club's services together. Illustrated below.

Usage

API2 relies on JSON passed in the select url param. When I write:

// Operations/Clubs
{
  maxRecords: 1,
  fields: ["Name", "Latitude"]
}

you should try this:

curl https://api2.hackclub.com/v0.1/Operations/Clubs?select={"maxRecords":1,"fields":["Name","Latitude"]}

The allowlist

You can use v0.1 without authentication. Your requests will be filtered through the allowlist found in this file. If there are additional Airtable bases or fields you'd like access to, feel free to submit a PR to add them.

If you want to authenticate & get past the allowlist, you'll need an API token from Hack Club staff. To use the token, you must pass it through the params. For example:

curl https://api2.hackclub.com/v0.1/Operations/People/?authKey=YOUR_TOKEN&select={"maxRecords":1}