Clear API Documentation

With the Clear API, you can get regions, registrations, promotions, and more out of the CodeDay database.

Get Started API Reference

Authentication

 

To authenticate with the Clear API, you must create an API application here. You will be given two values, a public key and a private key. You will use these to authenticate with the API.

When calling a Clear API, pass these keys in the querystring of the URL, for example:

https://clear.codeday.org/api/regions?public=YOUR_PUBLIC_KEY&private=YOUR_PRIVATE_KEY

Permissions

 

Throughout the API reference, you will see references to these two permissions:

  • admin: Gives an API application read/write access to all resources across all events, such as creating registrations at an event.
  • internal: Gives an API application read access to internal information, such as retrieving a list of events a user has access to.

Both of these permissions can be granted by an admin. Please talk to either tjhorner or tylermenezes if you believe you need one of these permissions.

List regions

Get the current batch of regions and their corresponding events.
Returns an array of Region objects.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/regions
curl --request GET \
  --url https://clear.codeday.org/api/regions
var request = require("request");

var options = { method: 'GET', url: 'https://clear.codeday.org/api/regions' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/regions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/regions");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/regions"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "atlanta",
    "name": "Atlanta",
    "webname": "atlanta",
    "abbr": "ATL",
    "location": {
      "lat": 33.76,
      "lng": -84.39
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "SpXQ7yN4Xwfk",
      "name": "CodeDay Atlanta Fall 2017",
      "region_name": "Atlanta",
      "webname": "atlanta",
      "hashtag": "atlanta",
      "urls": {
        "home": "https://codeday.org/atlanta",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": false
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": false,
      "cost": 20,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "austin",
    "name": "Austin",
    "webname": "austin",
    "abbr": "AUS",
    "location": {
      "lat": 30.23,
      "lng": -97.77
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "yQJilBcGdJPt",
      "name": "CodeDay Austin Fall 2017",
      "region_name": "Austin",
      "webname": "austin",
      "hashtag": "austin",
      "urls": {
        "home": "https://codeday.org/austin",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "ba",
    "name": "Bay Area",
    "webname": "ba",
    "abbr": "SFO",
    "location": {
      "lat": 37.44,
      "lng": -122.14
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "1SVVDoNc3qfl",
      "name": "CodeDay Bay Area Fall 2017",
      "region_name": "Bay Area",
      "webname": "ba",
      "hashtag": "ba",
      "urls": {
        "home": "https://codeday.org/ba",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "baltimore",
    "name": "Baltimore",
    "webname": "baltimore",
    "abbr": "BWI",
    "location": {
      "lat": 39.28,
      "lng": -76.62
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "MCNPA6N9dxdW",
      "name": "CodeDay Baltimore Fall 2017",
      "region_name": "Baltimore",
      "webname": "baltimore",
      "hashtag": "baltimore",
      "urls": {
        "home": "https://codeday.org/baltimore",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "boca",
    "name": "Boca Raton",
    "webname": "boca",
    "abbr": "BOC",
    "location": {
      "lat": 25.79,
      "lng": -80.22
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "LjZOHd23kegE",
      "name": "CodeDay Boca Raton Fall 2017",
      "region_name": "Boca Raton",
      "webname": "boca",
      "hashtag": "boca",
      "urls": {
        "home": "https://codeday.org/boca",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "boston",
    "name": "Boston",
    "webname": "boston",
    "abbr": "BOS",
    "location": {
      "lat": 42.36,
      "lng": -71.06
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "PALQ7zTpF36l",
      "name": "CodeDay Boston Fall 2017",
      "region_name": "Boston",
      "webname": "boston",
      "hashtag": "boston",
      "urls": {
        "home": "https://codeday.org/boston",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "chicago",
    "name": "Chicago",
    "webname": "chicago",
    "abbr": "CHI",
    "location": {
      "lat": 41.88,
      "lng": -87.63
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "XPhZAKFG3zmo",
      "name": "CodeDay Chicago Fall 2017",
      "region_name": "Chicago",
      "webname": "chicago",
      "hashtag": "chicago",
      "urls": {
        "home": "https://codeday.org/chicago",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "colorado",
    "name": "Colorado",
    "webname": "colorado",
    "abbr": "DEN",
    "location": {
      "lat": 39.74,
      "lng": -104.98
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": {
      "id": "ueVeFAjnHEfF",
      "name": "CodeDay Colorado Fall 2017",
      "region_name": "Colorado",
      "webname": "colorado",
      "hashtag": "colorado",
      "urls": {
        "home": "https://codeday.org/colorado",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "columbia",
    "name": "Columbia",
    "webname": "columbia",
    "abbr": "CAE",
    "location": {
      "lat": 34,
      "lng": -81.04
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "wBkrQ8IajkYU",
      "name": "CodeDay Columbia Fall 2017",
      "region_name": "Columbia",
      "webname": "columbia",
      "hashtag": "columbia",
      "urls": {
        "home": "https://codeday.org/columbia",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "dallas",
    "name": "Dallas",
    "webname": "dallas",
    "abbr": "DAL",
    "location": {
      "lat": 32.78,
      "lng": -96.8
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "ydBFXA0J4yNa",
      "name": "CodeDay Dallas Fall 2017",
      "region_name": "Dallas",
      "webname": "dallas",
      "hashtag": "dallas",
      "urls": {
        "home": "https://codeday.org/dallas",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "dayton",
    "name": "Dayton",
    "webname": "dayton",
    "abbr": "DAY",
    "location": {
      "lat": 39.76,
      "lng": -84.19
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": null
  },
  {
    "id": "dc",
    "name": "DC",
    "webname": "dc",
    "abbr": "DC",
    "location": {
      "lat": 38.9,
      "lng": -77.04
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "6gV9F4e0lfRX",
      "name": "CodeDay DC Fall 2017",
      "region_name": "DC",
      "webname": "dc",
      "hashtag": "dc",
      "urls": {
        "home": "https://codeday.org/dc",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "desmoines",
    "name": "Des Moines",
    "webname": "desmoines",
    "abbr": "DSM",
    "location": {
      "lat": 41.59,
      "lng": -93.62
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "tWIjHjxoon16",
      "name": "CodeDay Des Moines Fall 2017",
      "region_name": "Des Moines",
      "webname": "desmoines",
      "hashtag": "desmoines",
      "urls": {
        "home": "https://codeday.org/desmoines",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "detroit",
    "name": "Detroit",
    "webname": "detroit",
    "abbr": "DET",
    "location": {
      "lat": 42.33,
      "lng": -83.05
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "uBiRqHGm5pg1",
      "name": "CodeDay Detroit Fall 2017",
      "region_name": "Detroit",
      "webname": "detroit",
      "hashtag": "detroit",
      "urls": {
        "home": "https://codeday.org/detroit",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "flagstaff",
    "name": "Flagstaff",
    "webname": "flagstaff",
    "abbr": "FLG",
    "location": {
      "lat": 35.18,
      "lng": -111.75
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": null
  },
  {
    "id": "houston",
    "name": "Houston",
    "webname": "houston",
    "abbr": "HOU",
    "location": {
      "lat": 29.76,
      "lng": -95.38
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "XZpNRj3Lsr8Y",
      "name": "CodeDay Houston Fall 2017",
      "region_name": "Houston",
      "webname": "houston",
      "hashtag": "houston",
      "urls": {
        "home": "https://codeday.org/houston",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "jersey",
    "name": "New Jersey",
    "webname": "jersey",
    "abbr": "EWR",
    "location": {
      "lat": 40.89,
      "lng": -74.68
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": null
  },
  {
    "id": "kansascity",
    "name": "Kansas City",
    "webname": "kansascity",
    "abbr": "MCI",
    "location": {
      "lat": 39.1,
      "lng": -94.58
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "DHXOTQv2fHtK",
      "name": "CodeDay Kansas City Fall 2017",
      "region_name": "Kansas City",
      "webname": "kansascity",
      "hashtag": "kansascity",
      "urls": {
        "home": "https://codeday.org/kansascity",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "la",
    "name": "Los Angeles",
    "webname": "la",
    "abbr": "LA",
    "location": {
      "lat": 34.05,
      "lng": -118.25
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "Jlu47xhPmLmp",
      "name": "CodeDay Los Angeles Fall 2017",
      "region_name": "Los Angeles",
      "webname": "la",
      "hashtag": "la",
      "urls": {
        "home": "https://codeday.org/la",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "minneapolis",
    "name": "Minneapolis",
    "webname": "minneapolis",
    "abbr": "MSP",
    "location": {
      "lat": 44.98,
      "lng": -93.27
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "tlRPcr4g0xr5",
      "name": "CodeDay Minneapolis Fall 2017",
      "region_name": "Minneapolis",
      "webname": "minneapolis",
      "hashtag": "minneapolis",
      "urls": {
        "home": "https://codeday.org/minneapolis",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "nashville",
    "name": "Nashville",
    "webname": "nashville",
    "abbr": "NAS",
    "location": {
      "lat": 36.17,
      "lng": -86.78
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "foKcyTPO8qkH",
      "name": "CodeDay Nashville Fall 2017",
      "region_name": "Nashville",
      "webname": "nashville",
      "hashtag": "nashville",
      "urls": {
        "home": "https://codeday.org/nashville",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "ny",
    "name": "New York",
    "webname": "ny",
    "abbr": "NYC",
    "location": {
      "lat": 40.67,
      "lng": -73.94
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "36DHFsTsO984",
      "name": "CodeDay New York Fall 2017",
      "region_name": "New York",
      "webname": "ny",
      "hashtag": "ny",
      "urls": {
        "home": "https://codeday.org/ny",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "omaha",
    "name": "Omaha",
    "webname": "omaha",
    "abbr": "OMA",
    "location": {
      "lat": 41.25,
      "lng": -96
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": null
  },
  {
    "id": "orlando",
    "name": "Orlando",
    "webname": "orlando",
    "abbr": "ORL",
    "location": {
      "lat": 28.42,
      "lng": -81.3
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": null
  },
  {
    "id": "philly",
    "name": "Philadelphia",
    "webname": "philly",
    "abbr": "PHL",
    "location": {
      "lat": 39.95,
      "lng": -75.17
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "AU2fOR7Cqby2",
      "name": "CodeDay Philadelphia Fall 2017",
      "region_name": "Philadelphia",
      "webname": "philly",
      "hashtag": "philly",
      "urls": {
        "home": "https://codeday.org/philly",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "phoenix",
    "name": "Phoenix",
    "webname": "phoenix",
    "abbr": "PHX",
    "location": {
      "lat": 33.45,
      "lng": -112.07
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": {
      "id": "dytqrY7IVJSK",
      "name": "CodeDay Phoenix Fall 2017",
      "region_name": "Phoenix",
      "webname": "phoenix",
      "hashtag": "phoenix",
      "urls": {
        "home": "https://codeday.org/phoenix",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "pittsburgh",
    "name": "Pittsburgh",
    "webname": "pittsburgh",
    "abbr": "PIT",
    "location": {
      "lat": 40.44,
      "lng": -80
    },
    "timezone": "America/Detroit",
    "timezone_group": "Eastern",
    "current_event": {
      "id": "7J0P2e07nGsq",
      "name": "CodeDay Pittsburgh Fall 2017",
      "region_name": "Pittsburgh",
      "webname": "pittsburgh",
      "hashtag": "pittsburgh",
      "urls": {
        "home": "https://codeday.org/pittsburgh",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "portland",
    "name": "Portland",
    "webname": "portland",
    "abbr": "PDX",
    "location": {
      "lat": 45.52,
      "lng": -122.68
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "6o9bsSlaq7LB",
      "name": "CodeDay Portland Fall 2017",
      "region_name": "Portland",
      "webname": "portland",
      "hashtag": "portland",
      "urls": {
        "home": "https://codeday.org/portland",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "sandiego",
    "name": "San Diego",
    "webname": "sandiego",
    "abbr": "SD",
    "location": {
      "lat": 32.72,
      "lng": -117.16
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "TiXVuY58YG0Q",
      "name": "CodeDay San Diego Fall 2017",
      "region_name": "San Diego",
      "webname": "sandiego",
      "hashtag": "sandiego",
      "urls": {
        "home": "https://codeday.org/sandiego",
        "register": "https://codeday.org/sandiego/register"
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": {
        "name": "NEST CoWork",
        "address": {
          "line_1": "1855 1st Ave",
          "line_2": null,
          "city": "San Diego",
          "state": "CA",
          "postal": "92101",
          "country": "US"
        },
        "full_address": "1855 1st Ave, San Diego CA 92101, US"
      },
      "registration_info": {
        "estimate": 100,
        "max": 100,
        "is_open": true,
        "remaining": 91,
        "is_earlybird_ending": false
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "seattle",
    "name": "Seattle",
    "webname": "seattle",
    "abbr": "SEA",
    "location": {
      "lat": 47.61,
      "lng": -122.33
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "j7yK7gKvpvoF",
      "name": "CodeDay Seattle Fall 2017",
      "region_name": "Seattle",
      "webname": "seattle",
      "hashtag": "seattle",
      "urls": {
        "home": "https://codeday.org/seattle",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": {
        "id": "A2wmPY4nF30e",
        "name": "CodeDay Seattle Eastside Fall 2017",
        "region_name": "Seattle Eastside",
        "webname": "seattle-eastside",
        "hashtag": "seattle",
        "urls": {
          "home": "https://codeday.org/seattle-eastside",
          "register": null
        },
        "starts_at": 1510430400,
        "ends_at": 1510516800,
        "venue": null,
        "registration_info": {
          "estimate": 100,
          "max": null,
          "is_open": false,
          "remaining": 0,
          "is_earlybird_ending": true
        },
        "waiver": null,
        "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
        "is_early_bird_pricing": true,
        "cost": 10,
        "notice": null,
        "overflow_event": null,
        "has_related_events": true
      },
      "has_related_events": true
    }
  },
  {
    "id": "slc",
    "name": "Salt Lake City",
    "webname": "slc",
    "abbr": "SLC",
    "location": {
      "lat": 40.75,
      "lng": -111.88
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": null
  },
  {
    "id": "stlouis",
    "name": "St Louis",
    "webname": "stlouis",
    "abbr": "STL",
    "location": {
      "lat": 38.63,
      "lng": -90.2
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": {
      "id": "XOsSWLjNuYvx",
      "name": "CodeDay St Louis Fall 2017",
      "region_name": "St Louis",
      "webname": "stlouis",
      "hashtag": "stlouis",
      "urls": {
        "home": "https://codeday.org/stlouis",
        "register": null
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": null,
      "registration_info": {
        "estimate": 100,
        "max": null,
        "is_open": false,
        "remaining": 0,
        "is_earlybird_ending": true
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  {
    "id": "tucson",
    "name": "Tucson",
    "webname": "tucson",
    "abbr": "TUS",
    "location": {
      "lat": 32.22,
      "lng": -110.92
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": null
  },
  {
    "id": "vegas",
    "name": "Las Vegas",
    "webname": "vegas",
    "abbr": "VEG",
    "location": {
      "lat": 36.12,
      "lng": -115.14
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": null
  },
  {
    "id": "wisconsin",
    "name": "Wisconsin",
    "webname": "wisconsin",
    "abbr": "W",
    "location": {
      "lat": 43.07,
      "lng": -89.4
    },
    "timezone": "America/Chicago",
    "timezone_group": "Central",
    "current_event": null
  },
  {
    "id": "yuma",
    "name": "Yuma",
    "webname": "yuma",
    "abbr": "YUM",
    "location": {
      "lat": 32.69,
      "lng": -114.62
    },
    "timezone": "America/Denver",
    "timezone_group": "Mountain",
    "current_event": null
  }
]
 

Get region by webname

Get a certain region by its webname.
Returns a Region object.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/region/webname
curl --request GET \
  --url https://clear.codeday.org/api/region/sandiego
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/region/sandiego' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/region/sandiego")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/region/sandiego");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/region/sandiego"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "sandiego",
  "name": "San Diego",
  "webname": "sandiego",
  "abbr": "SD",
  "location": {
    "lat": 32.72,
    "lng": -117.16
  },
  "timezone": "America/Los_Angeles",
  "timezone_group": "Pacific",
  "current_event": {
    "id": "TiXVuY58YG0Q",
    "name": "CodeDay San Diego Fall 2017",
    "region_name": "San Diego",
    "webname": "sandiego",
    "hashtag": "sandiego",
    "urls": {
      "home": "https://codeday.org/sandiego",
      "register": "https://codeday.org/sandiego/register"
    },
    "starts_at": 1510430400,
    "ends_at": 1510516800,
    "venue": {
      "name": "NEST CoWork",
      "address": {
        "line_1": "1855 1st Ave",
        "line_2": null,
        "city": "San Diego",
        "state": "CA",
        "postal": "92101",
        "country": "US"
      },
      "full_address": "1855 1st Ave, San Diego CA 92101, US"
    },
    "registration_info": {
      "estimate": 100,
      "max": 100,
      "is_open": true,
      "remaining": 91,
      "is_earlybird_ending": false
    },
    "waiver": null,
    "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
    "is_early_bird_pricing": true,
    "cost": 10,
    "notice": null,
    "overflow_event": null,
    "has_related_events": false
  }
}

Path Params

webname
string
required

The region's webname

 

Get nearby regions

Get regions close to a certain location with the specified radius.
Returns an array of Region objects.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/regions/nearby
curl --request GET \
  --url 'https://clear.codeday.org/api/regions/nearby?lat=lat&lng=lng'
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/regions/nearby',
  qs: 
   { lat: 'lat',
     lng: 'lng' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/regions/nearby?lat=lat&lng=lng")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/regions/nearby?lat=lat&lng=lng");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/regions/nearby"

querystring = {"lat":"lat","lng":"lng"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

lat
float
required

Latitude of the location to search near

lng
float
required

Longitude of the location to search near

radius
int32

The radius, in meters, to search

limit
int32

Maximum regions to return

with_current_event
boolean

If specified, will only return regions that have a current event

 

Get event by ID

Get a CodeDay event (and all related events) by its ID.
Returns an Event object.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/event/id
curl --request GET \
  --url https://clear.codeday.org/api/event/TiXVuY58YG0Q
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/event/TiXVuY58YG0Q' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/event/TiXVuY58YG0Q")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/event/TiXVuY58YG0Q");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/event/TiXVuY58YG0Q"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "TiXVuY58YG0Q",
  "name": "CodeDay San Diego Fall 2017",
  "region_name": "San Diego",
  "webname": "sandiego",
  "hashtag": "sandiego",
  "urls": {
    "home": "https://codeday.org/sandiego",
    "register": "https://codeday.org/sandiego/register"
  },
  "starts_at": 1510430400,
  "ends_at": 1510516800,
  "venue": {
    "name": "NEST CoWork",
    "address": {
      "line_1": "1855 1st Ave",
      "line_2": null,
      "city": "San Diego",
      "state": "CA",
      "postal": "92101",
      "country": "US"
    },
    "full_address": "1855 1st Ave, San Diego CA 92101, US"
  },
  "registration_info": {
    "estimate": 100,
    "max": 100,
    "is_open": true,
    "remaining": 91,
    "is_earlybird_ending": false
  },
  "waiver": null,
  "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
  "is_early_bird_pricing": true,
  "schedule": {
    "Saturday, November 11": [
      {
        "time": -1,
        "title": "Doors open",
        "type": "event",
        "description": "Please don't show up earlier, you'll be waiting outside!",
        "timestamp": {
          "date": "2017-11-11 11:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "11:00am",
        "day": "Saturday, November 11"
      },
      {
        "time": -0.5,
        "title": "Lunch",
        "type": "event",
        "description": "All food is included with your ticket!",
        "timestamp": {
          "date": "2017-11-11 11:30:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "11:30am",
        "day": "Saturday, November 11"
      },
      {
        "time": 0,
        "title": "Kickoff & Pitches",
        "type": "event",
        "description": "Not sure what you want to work on? Our Code Evangelists will help you get some ideas and form a team.",
        "timestamp": {
          "date": "2017-11-11 12:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "12:00pm",
        "day": "Saturday, November 11"
      },
      {
        "time": 1,
        "title": "Start Coding!",
        "type": "event",
        "description": "After forming teams, it's time to get to work on your project! Our Code Evangelists and other mentors will be helping teams throughout the event.",
        "timestamp": {
          "date": "2017-11-11 13:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "1:00pm",
        "day": "Saturday, November 11"
      },
      {
        "time": 1,
        "title": "Beginner: Intro to coding",
        "type": "workshop",
        "url": "https://blog.srnd.org/jumping-over-chairs-and-learning-to-make-a-game-with-construct-2-a796f4def9e9#.v37wzagti",
        "description": "Totally new to coding? No problem! Attend this workshop and our Code Evangelists will walk you through creating your first game.",
        "timestamp": {
          "date": "2017-11-11 13:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "1:00pm",
        "day": "Saturday, November 11"
      },
      {
        "time": 5,
        "title": "Splunk: Make your game better with data",
        "type": "workshop",
        "url": "https://blog.srnd.org/making-better-games-with-splunk-975cd2a605ce",
        "description": "Learn how others play your game and use that knowledge to make it more fun with minimal work.",
        "timestamp": {
          "date": "2017-11-11 17:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "5:00pm",
        "day": "Saturday, November 11"
      },
      {
        "time": 6,
        "title": "Dinner",
        "type": "event",
        "description": "All food is included with your ticket!",
        "timestamp": {
          "date": "2017-11-11 18:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "6:00pm",
        "day": "Saturday, November 11"
      },
      {
        "time": 6.5,
        "title": "CodeCup",
        "type": "workshop",
        "url": "https://cup.codeday.org/",
        "description": "Work with other attendees to make your city #1 nationwide!",
        "timestamp": {
          "date": "2017-11-11 18:30:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "6:30pm",
        "day": "Saturday, November 11"
      }
    ],
    "Sunday, November 12": [
      {
        "time": 12,
        "title": "Midnight Snack",
        "type": "event",
        "description": "All food is included with your ticket!",
        "timestamp": {
          "date": "2017-11-12 00:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "12:00am",
        "day": "Sunday, November 12"
      },
      {
        "time": 19,
        "title": "Breakfast",
        "type": "event",
        "description": "All food is included with your ticket!",
        "timestamp": {
          "date": "2017-11-12 07:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "7:00am",
        "day": "Sunday, November 12"
      },
      {
        "time": 20,
        "title": "Presentation sign-up",
        "type": "event",
        "description": "The final few hours. Teams with something to show are encouraged to sign up to present at the end.",
        "timestamp": {
          "date": "2017-11-12 08:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "8:00am",
        "day": "Sunday, November 12"
      },
      {
        "time": 21,
        "title": "Judges arrive",
        "type": "event",
        "description": "Judges will go around to demo the projects before the final presentations.",
        "timestamp": {
          "date": "2017-11-12 09:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "9:00am",
        "day": "Sunday, November 12"
      },
      {
        "time": 22,
        "title": "Presentations",
        "type": "event",
        "description": "Everyone who created something during CodeDay is asked to give a brief presentation.",
        "timestamp": {
          "date": "2017-11-12 10:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "10:00am",
        "day": "Sunday, November 12"
      },
      {
        "time": 23.5,
        "title": "Awards",
        "type": "event",
        "description": "Awards given for Top Overall, Best App, Best Game, and more.",
        "timestamp": {
          "date": "2017-11-12 11:30:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "11:30am",
        "day": "Sunday, November 12"
      },
      {
        "time": 24,
        "title": "Clean-up",
        "type": "event",
        "description": "Thank the venue for hosting CodeDay by helping clean up!",
        "timestamp": {
          "date": "2017-11-12 12:00:00.000000",
          "timezone_type": 3,
          "timezone": "America/Los_Angeles"
        },
        "hour": "12:00pm",
        "day": "Sunday, November 12"
      }
    ]
  },
  "sponsors": [],
  "cost": 10,
  "notice": null,
  "region": {
    "id": "sandiego",
    "name": "San Diego",
    "webname": "sandiego",
    "abbr": "SD",
    "location": {
      "lat": 32.72,
      "lng": -117.16
    },
    "timezone": "America/Los_Angeles",
    "timezone_group": "Pacific",
    "current_event": {
      "id": "TiXVuY58YG0Q",
      "name": "CodeDay San Diego Fall 2017",
      "region_name": "San Diego",
      "webname": "sandiego",
      "hashtag": "sandiego",
      "urls": {
        "home": "https://codeday.org/sandiego",
        "register": "https://codeday.org/sandiego/register"
      },
      "starts_at": 1510430400,
      "ends_at": 1510516800,
      "venue": {
        "name": "NEST CoWork",
        "address": {
          "line_1": "1855 1st Ave",
          "line_2": null,
          "city": "San Diego",
          "state": "CA",
          "postal": "92101",
          "country": "US"
        },
        "full_address": "1855 1st Ave, San Diego CA 92101, US"
      },
      "registration_info": {
        "estimate": 100,
        "max": 100,
        "is_open": true,
        "remaining": 91,
        "is_earlybird_ending": false
      },
      "waiver": null,
      "stripe_public_key": "pk_v0AIOIy377403GN0FKltGR9gOAAUe",
      "is_early_bird_pricing": true,
      "cost": 10,
      "notice": null,
      "overflow_event": null,
      "has_related_events": false
    }
  },
  "batch": {
    "id": "3QqcbLULzrLM",
    "name": "Fall 2017",
    "starts_at": "2017-11-11",
    "ends_at": "2017-11-12",
    "is_loaded": true
  },
  "overflow_event": null,
  "has_related_events": false,
  "related_events": []
}

Path Params

id
string
required

The ID of the event, usually found by the regions endpoint

 

Get events managed by someone

Get CodeDay events managed by a user.
Returns an array of Event objects.

Requires internal permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/events/managed-by
curl --request GET \
  --url 'https://clear.codeday.org/api/events/managed-by?username=tjhorner'
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/events/managed-by',
  qs: { username: 'tjhorner' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/events/managed-by?username=tjhorner")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/events/managed-by?username=tjhorner");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/events/managed-by"

querystring = {"username":"tjhorner"}

response = requests.request("GET", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

username
string
required

The username of the manager

 

Get events a user has access to

Get a list of events this user has access to.
Returns an array of Event objects.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/events/has-access/username
curl --request GET \
  --url https://clear.codeday.org/api/events/has-access/username
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/events/has-access/username' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/events/has-access/username")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/events/has-access/username");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/events/has-access/username"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

username
string
required

The username of the user

 

Get event registrations

Get an event's registrations.
Returns an array of Registration objects.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/event/event/registrations
curl --request GET \
  --url https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "yeaayxrx2q7vw6p",
    "email": "charlielol@codeday.org",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/8b61de0a824f8252700c76e53844edf1?s=300&d=mm",
    "name": "Charlie Qinberg",
    "first_name": "Charlie",
    "last_name": "Qinberg",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": []
  },
  {
    "id": "ufxgdcp7c3gk2ax",
    "email": "jrc+real.ethan@srnd.org",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/a1064bc851bb7d96e2d76e6e1635ac25?s=300&d=mm",
    "name": "Ethan Lee",
    "first_name": "Ethan",
    "last_name": "Lee",
    "parent_information_exempt": true,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 2147483647,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": [
      {
        "id": 7,
        "service": "messenger",
        "token": "1562876337077767"
      }
    ]
  },
  {
    "id": "ywv6f699bke2hav",
    "email": "[redacted]",
    "type": "student",
    "profile_image": "https://d2ojpxxtu63wzl.cloudfront.net/static/87aab92d1a8861d30117579188ec2de1_13e0b05cb0242ceaaf56797c134300f63056c3e56a0fbc2bed3bf5c920fd7ccf",
    "name": "Jaimie Bougie",
    "first_name": "Jaimie",
    "last_name": "Bougie",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 10,
    "amount_refunded": 0,
    "order_amount_paid": 10,
    "is_earlybird_pricing": true,
    "registered_at": null,
    "checked_in_at": null,
    "devices": []
  },
  {
    "id": "dxyhx9feg7236cy",
    "email": "jrc@srnd.org",
    "type": "volunteer",
    "profile_image": "http://www.gravatar.com/avatar/724463996dc93ba15b7331b2cfc056ed?s=300&d=mm",
    "name": "James Chicken",
    "first_name": "James",
    "last_name": "Chicken",
    "parent_information_exempt": true,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 420,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": [
      {
        "id": 4,
        "service": "sms",
        "token": "[redacted]"
      }
    ]
  },
  {
    "id": "4mpfbcfcwhfcruk",
    "email": "[redacted]",
    "type": "volunteer",
    "profile_image": "https://d2ojpxxtu63wzl.cloudfront.net/static/1fb62eb892b76e3f86025491018b1245_78a70efd9cd83821fefac131e78779ec2e8a45658a1993840368f4048efd729c",
    "name": "Ronak Shah",
    "first_name": "Ronak",
    "last_name": "Shah",
    "parent_information_exempt": true,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": []
  },
  {
    "id": "dfmhc76v4krnpk7",
    "email": "me@tjhorner.com",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/f31e403f83439b631e96e1e03584a05a?s=300&d=mm",
    "name": "TJ Horner",
    "first_name": "TJ",
    "last_name": "Horner",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": {
      "date": "2017-07-20 22:11:44.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "devices": [
      {
        "id": 9,
        "service": "messenger",
        "token": "1371282459653795"
      }
    ]
  },
  {
    "id": "pq7c7w4fmh2avev",
    "email": "me@tjhorner.com",
    "type": "volunteer",
    "profile_image": "https://d2ojpxxtu63wzl.cloudfront.net/static/d80c0c5f97ba502440315dc81928349e_d0f076f36ea896fd57aa653030fcad61db868cff869ecca86499678078f09b9c",
    "name": "TJ Horner",
    "first_name": "TJ",
    "last_name": "Horner",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": [
      {
        "id": 5,
        "service": "messenger",
        "token": "1371282459653795"
      }
    ]
  },
  {
    "id": "wprhpegyqpn7dwk",
    "email": "me@tjhorner.com",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/f31e403f83439b631e96e1e03584a05a?s=300&d=mm",
    "name": "TJ Horner",
    "first_name": "TJ",
    "last_name": "Horner",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "devices": [
      {
        "id": 8,
        "service": "messenger",
        "token": "1371282459653795"
      }
    ]
  },
  {
    "id": "2kppknchy4cgran",
    "email": "[redacted]",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/b5a2c828981e5c659186dba8255bdcbb?s=300&d=mm",
    "name": "Warren Young",
    "first_name": "Warren",
    "last_name": "Young",
    "parent_information_exempt": true,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 30,
    "waiver_pdf": null,
    "amount_paid": 10,
    "amount_refunded": 0,
    "order_amount_paid": 10,
    "is_earlybird_pricing": true,
    "registered_at": null,
    "checked_in_at": null,
    "devices": []
  }
]

Path Params

event
string
required

The ID of the event, usually found by the regions endpoint

 

Get event announcements

Get a list of announcements for the event.
Returns an array of Announcement objects.

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/event/event/announcements
curl --request GET \
  --url https://clear.codeday.org/api/event/TiXVuY58YG0Q/announcements
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/event/TiXVuY58YG0Q/announcements' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/event/TiXVuY58YG0Q/announcements")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/event/TiXVuY58YG0Q/announcements");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/event/TiXVuY58YG0Q/announcements"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

[
  {
    "id": "74hagq2e9accqnm",
    "posted_at": {
      "date": "2017-07-20 19:40:55.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "asdasd",
    "urgency": 3,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "36mynybc7nen9ex",
    "posted_at": {
      "date": "2017-07-20 19:24:40.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "Am I shouting into a well? Seriously what",
    "urgency": 3,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "pk3d9rwf9x4gcb6",
    "posted_at": {
      "date": "2017-07-20 19:21:51.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "ANNOUNCE.",
    "urgency": 2,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "6w2q6nybanyyeuh",
    "posted_at": {
      "date": "2017-07-20 19:20:36.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "what's a code day?",
    "urgency": 3,
    "link": {
      "url": "https://google.com",
      "text": "look it up you dummy"
    },
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "4bnyh7bgbwk6vph",
    "posted_at": {
      "date": "2017-07-20 19:16:52.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "lol",
    "urgency": 3,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "qh9yv2kn7kbpdyk",
    "posted_at": {
      "date": "2017-07-20 19:01:41.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "b!",
    "urgency": 2,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "u9pwd7u2db9xrdp",
    "posted_at": {
      "date": "2017-07-20 18:59:32.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "announcement test sorry james",
    "urgency": 3,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "wmx7g32p43q3nqu",
    "posted_at": {
      "date": "2017-07-20 00:00:16.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "Announcing test",
    "urgency": 3,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "37xuk9dabradefc",
    "posted_at": {
      "date": "2017-07-19 23:59:53.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "I am announcing",
    "urgency": 2,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "yfgqebhn3e23m7y",
    "posted_at": {
      "date": "2017-07-19 21:23:05.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "test announcement please ignore",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "dxe7y79bu4kvkrq",
    "posted_at": {
      "date": "2017-07-19 21:21:15.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "sfdghjkl",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "hdxp2f3h4vpap6b",
    "posted_at": {
      "date": "2017-07-19 21:14:09.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "ddd",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "b7rxruaqvd296wq",
    "posted_at": {
      "date": "2017-07-19 21:10:28.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "hello",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "mfr2q2bmwa2g9v2",
    "posted_at": {
      "date": "2017-07-19 21:07:33.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "fdfsddsfsdfdsfdsfdsfsdfsdfsdfdsf",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "4y7y9wgaqkkycw9",
    "posted_at": {
      "date": "2017-07-19 21:05:53.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "It's not CodeDay, lol",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "hkeb9bwvydkxvg6",
    "posted_at": {
      "date": "2017-07-19 21:04:12.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "asdasdasd",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "f2waph2u4barc9a",
    "posted_at": {
      "date": "2017-07-19 20:49:06.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "sdfsdf",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "f96nhchmu77ue3a",
    "posted_at": {
      "date": "2017-07-19 20:47:11.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "sdfhdgfhj",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "d7rnvkmpgpyfx99",
    "posted_at": {
      "date": "2017-07-19 20:44:34.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "hi test",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  },
  {
    "id": "6gnm3bx24acrvge",
    "posted_at": {
      "date": "2017-07-19 20:40:14.000000",
      "timezone_type": 3,
      "timezone": "America/Los_Angeles"
    },
    "body": "hi",
    "urgency": 1,
    "link": null,
    "creator": {
      "username": "tjhorner",
      "name": "TJ Horner"
    }
  }
]

Path Params

event
string
required

The ID of the event to retrieve announcements for

 

Create event registration

Registers someone for the event.
Returns the newly created Registration object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/event/event/registrations
curl --request POST \
  --url https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/event/TiXVuY58YG0Q/registrations"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "3kgxv6uqkrum4mx",
  "email": "someone@codeday.org",
  "type": "student",
  "profile_image": "http://www.gravatar.com/avatar/ee8e743e4137228d684f7fbe977f2801?s=300&d=mm",
  "name": "TJ Tester",
  "first_name": "TJ",
  "last_name": "Tester",
  "parent_information_exempt": false,
  "parent_name": null,
  "parent_email": null,
  "parent_phone": null,
  "parent_secondary_phone": null,
  "age": 0,
  "waiver_pdf": null,
  "amount_paid": 0,
  "amount_refunded": 0,
  "order_amount_paid": 0,
  "is_earlybird_pricing": false,
  "registered_at": null,
  "checked_in_at": null,
  "event": {
    // related Event object
  },
  "devices": []
}

Path Params

event
string
required

ID of the event to create the registration for

Form Data

first_name
string
required

The first name of the attendee.

last_name
string
required

The last name of the attendee.

email
string

The attendee's email. Not required since schools or other groups might not provide emails for attendees.

type
string

The type of attendee this registration belongs to.

age
int32

The attendee's age.

parent_name
string

The name of the attendee's parent. Only required if attendee is < 18.

parent_email
string

The email of the attendee's parent. Only required if attendee is < 18.

parent_phone
string

The primary phone number of the attendee's parent. Only required if attendee is < 18.

parent_secondary_phone
string

A phone number to be used if the parent cannot be contacted via the primary. Only required if attendee is < 18.

stripe_pi
string

A Stripe PaymentIntent ID to link the registration to. (This will fill the amount_paid field and allow for refunds.)

 

Get registration by ID

Get a CodeDay registration by its ID.
Returns a Registration object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/registration/id
curl --request GET \
  --url https://clear.codeday.org/api/registration/dfmhc76v4krnpk7
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/registration/dfmhc76v4krnpk7' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/registration/dfmhc76v4krnpk7")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "3kgxv6uqkrum4mx",
  "email": "someone@codeday.org",
  "type": "student",
  "profile_image": "http://www.gravatar.com/avatar/ee8e743e4137228d684f7fbe977f2801?s=300&d=mm",
  "name": "TJ Tester",
  "first_name": "TJ",
  "last_name": "Tester",
  "parent_information_exempt": false,
  "parent_name": null,
  "parent_email": null,
  "parent_phone": null,
  "parent_secondary_phone": null,
  "age": 0,
  "waiver_pdf": null,
  "amount_paid": 0,
  "amount_refunded": 0,
  "order_amount_paid": 0,
  "is_earlybird_pricing": false,
  "registered_at": null,
  "checked_in_at": null,
  "event": {
    // related Event object
  },
  "devices": []
}

Path Params

id
string
required

The ID of the registration

 

Get registrations by email

Get a list of CodeDay registrations by an email.
Returns a JSON object with latest_registration being the latest Registration for the specified email, and all_registrations being all matching Registrations.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/registration/by-email/email
curl --request GET \
  --url https://clear.codeday.org/api/registration/by-email/someone%40codeday.org
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/registration/by-email/someone%40codeday.org' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/registration/by-email/someone%40codeday.org")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/registration/by-email/someone%40codeday.org");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/registration/by-email/someone%40codeday.org"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "latest_registration": {
    "id": "3kgxv6uqkrum4mx",
    "email": "someone@codeday.org",
    "type": "student",
    "profile_image": "http://www.gravatar.com/avatar/ee8e743e4137228d684f7fbe977f2801?s=300&d=mm",
    "name": "TJ Tester",
    "first_name": "TJ",
    "last_name": "Tester",
    "parent_information_exempt": false,
    "parent_name": null,
    "parent_email": null,
    "parent_phone": null,
    "parent_secondary_phone": null,
    "age": 0,
    "waiver_pdf": null,
    "amount_paid": 0,
    "amount_refunded": 0,
    "order_amount_paid": 0,
    "is_earlybird_pricing": false,
    "registered_at": null,
    "checked_in_at": null,
    "event": {
      // related Event object
    },
    "devices": []
  },
  "all_registrations": [
    {
      "id": "3kgxv6uqkrum4mx",
      "email": "someone@codeday.org",
      "type": "student",
      "profile_image": "http://www.gravatar.com/avatar/ee8e743e4137228d684f7fbe977f2801?s=300&d=mm",
      "name": "TJ Tester",
      "first_name": "TJ",
      "last_name": "Tester",
      "parent_information_exempt": false,
      "parent_name": null,
      "parent_email": null,
      "parent_phone": null,
      "parent_secondary_phone": null,
      "age": 0,
      "waiver_pdf": null,
      "amount_paid": 0,
      "amount_refunded": 0,
      "order_amount_paid": 0,
      "is_earlybird_pricing": false,
      "registered_at": null,
      "checked_in_at": null,
      "event": {
        // related Event object
      },
      "devices": []
    }
  ]
}

Path Params

email
string
required

The email to look up

 

Sync waiver

Force sync with Legalesign.
Returns nothing.

Requires internal permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/registration/registration/sync-waiver
curl --request GET \
  --url https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/sync-waiver
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/sync-waiver' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/sync-waiver")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/sync-waiver");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/sync-waiver"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

registration
string
required

The ID of the registration

 

Set parent info

Sets the parent info for the specified registration
Returns the edited Registration object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/registration/registration/parent-info
curl --request POST \
  --url https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/parent-info
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/parent-info' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/parent-info")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/parent-info");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/parent-info"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "id": "3kgxv6uqkrum4mx",
  "email": "someone@codeday.org",
  "type": "student",
  "profile_image": "http://www.gravatar.com/avatar/ee8e743e4137228d684f7fbe977f2801?s=300&d=mm",
  "name": "TJ Tester",
  "first_name": "TJ",
  "last_name": "Tester",
  "parent_information_exempt": false,
  "parent_name": "TJ's Dad",
  "parent_email": "tjsdad@gmail.com",
  "parent_phone": "911",
  "parent_secondary_phone": "2124797990",
  "age": 0,
  "waiver_pdf": null,
  "amount_paid": 0,
  "amount_refunded": 0,
  "order_amount_paid": 0,
  "is_earlybird_pricing": false,
  "registered_at": null,
  "checked_in_at": null,
  "event": {
    // related Event object
  },
  "devices": []
}

Path Params

registration
string
required

The ID of the registration

Form Data

parent_name
string
required

Name of the attendee's parent

parent_email
string
required

Email of the attendee's parent

parent_phone
string
required

Primary phone number of the attendee's parent

parent_secondary_phone
string
required

Secondary phone number of the attendee's parent

 

Add a device

Add a device to the specified registration.
Returns { "ok": true } if successful.

Requires internal permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/registration/registration/devices
curl --request POST \
  --url https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/devices
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/devices' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/devices")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/devices");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/registration/dfmhc76v4krnpk7/devices"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "ok": true
}

Path Params

registration
string
required

The ID of the registration

Form Data

service
string
required

The service that this device belongs to. Must be one of sms, messenger, or app.

device_token
string
required

The token for this device. This can either be a phone number, Facebook page-scoped ID, or Firebase IID, depending on the service

 

Register attendees

Create registrations with a valid Stripe token.

 
posthttps://clear.codeday.org/api/register/event/register
curl --request POST \
  --url https://clear.codeday.org/api/register/TiXVuY58YG0Q/register
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/register/TiXVuY58YG0Q/register' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/register/TiXVuY58YG0Q/register")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/register/TiXVuY58YG0Q/register");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/register/TiXVuY58YG0Q/register"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "status": 200,
  "ids": [
    "e2bw9kpnmwkqana"
  ]
}

Path Params

event
string
required

The ID of the event to register for

Form Data

first_names
array of strings
required

The first names of the attendees to register

last_names
array of strings
required

The last names of the attendees to register

emails
array of strings
required

The emails of the attendees to register

quoted_price
float
required

The quoted price of registration. Used to verify that the price has not changed

card_token
string

The Stripe token for the card to be charged. Only needs to be passed if quoted price is > 0

code
string

Promotion code to be applied

 

Check in/out attendee

Check the specified attendee in or out of the event.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/checkin
curl --request POST \
  --url https://clear.codeday.org/api/checkin
var request = require("request");

var options = { method: 'POST', url: 'https://clear.codeday.org/api/checkin' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/checkin")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/checkin");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/checkin"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

{
  "success": true,
  "has_parent_info": true,
  "has_waiver": true,
  "registration": { /* registration object */ }
}

Form Data

r
string
required

Registration ID

check
string
required

Use in for checking in, and out for checking out

event
string
required

The event ID that the attendee belongs to

allow_missing
boolean

Should we allow the attendee to check in, even with a missing waiver or parent info?

 

Get promotion by ID

Get the specified promotion.
Returns a Promotion object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
gethttps://clear.codeday.org/api/promotion/promotion
curl --request GET \
  --url https://clear.codeday.org/api/promotion/promotion
var request = require("request");

var options = { method: 'GET',
  url: 'https://clear.codeday.org/api/promotion/promotion' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/promotion/promotion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("GET", "https://clear.codeday.org/api/promotion/promotion");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/promotion/promotion"

response = requests.request("GET", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Path Params

promotion
string
required

The ID of the promotion

 

Create promotion

Create a promotion for an event. Percentage will always be 20.
Returns a Promotion object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/promotion
curl --request POST \
  --url https://clear.codeday.org/api/promotion
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/promotion' };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/promotion")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/promotion");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/promotion"

response = requests.request("POST", url)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Form Data

event
string
required

The ID of the event to add the promotion to

code
string
required

The code to associate the promotion to

 

Delete promotion

Delete the specified promotion
Returns a Promotion object.

Requires admin permission

 

Query Auth

 Authentication is required for this endpoint.
posthttps://clear.codeday.org/api/promotion/delete
curl --request POST \
  --url 'https://clear.codeday.org/api/promotion/delete?id=id'
var request = require("request");

var options = { method: 'POST',
  url: 'https://clear.codeday.org/api/promotion/delete',
  qs: { id: 'id' } };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
require 'uri'
require 'net/http'

url = URI("https://clear.codeday.org/api/promotion/delete?id=id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body
var data = JSON.stringify(false);

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://clear.codeday.org/api/promotion/delete?id=id");

xhr.send(data);
import requests

url = "https://clear.codeday.org/api/promotion/delete"

querystring = {"id":"id"}

response = requests.request("POST", url, params=querystring)

print(response.text)
A binary file was returned

You couldn't be authenticated

Try the API to see results

Query Params

id
string
required

The ID of the promotion to delete

 

Registration.Register

The Registration.Register webhook is fired when an attendee registers.
Payload is a Registration object.

 

Registration.Checkin

The Registration.Checkin webhook is fired when an attendee checks into their event.
Payload is a Registration object.

 

Registration.Checkout

The Registration.Checkout webhook is fired when an attendee checks out of their event.
Payload is a Registration object.