Getting Started
Introduction to the HeyTaco API.
The HeyTaco API allows users and admins alike to access HeyTaco data from wherever they may need it.
The HeyTaco API currently supports requests for leaderboards for HeyTaco teams on Slack. We have lots of plans for expansion and improvement! If you would like to stay up to date with the latest changes to the HeyTaco API, check out our changelog.
Have questions? Comments? Ideas for how you and your team would like to extend and integrate HeyTaco into your workplace's tools and systems? Please reach out! We love hearing from the taco community 🌮
Quickstart guide
Getting started with the HeyTaco API is easy! For your first foray into your team's taco data, we'll walk you through getting a leaderboard in two simple steps.
Pre-reqs
What you'll need: a HeyTaco account (any role will do, you don't need to be an admin).
Create a token
- Head over to Profile > API in the HeyTaco app.
- Once there, select "New Token." You'll be prompted to name the token and attach scopes. For this example, attach the
leaderboardscope. - Save the token secret before finishing creation.
The token secret only appears once. If you lose it, you'll need to create a new token.
Get your team's leaderboard
Once you have your token, it's time to make a call. Open a terminal and drop in the following, swapping YOUR_TOKEN_SECRET for the one you just created:
curl -H "Authorization: Bearer YOUR_TOKEN_SECRET" \
"https://api.heytaco.com/leaderboard?type=received&timeframe=month"You should get back a JSON response with your team's top taco receivers for the current month. Try swapping type for given or combined, or timeframe for week, year, alltime, today, or a custom date range. You can also test this out on the GET/leaderboard reference page.
That's it! 🌮 Two steps and you've got your team's leaderboard.
