Let's Do This API (0.1.0)

The Let's Do This API provides a REST interface for much of the data essential for the day-to-day operation of planning, promoting and running an event.

To use the API, you need an API Key. To generate one, go to the settings / credentials tab in your account.

The API uses signed JSON Web Tokens (JWTs). These tokens are not encrypted, and the contents can be read by anyone. Rather, a signed token can be used to verify the integrity of claims contained within the token. For example, your token may contain your Organiser ID. And even though anybody with access to your token can read the claims contained within it, they are unable to modify those claims without destroying the integrity of the token.

Because JWTs are not encrypted, your API Key should be treated like any other secret. Do not share it with others, and do not use it in any software shipped to the public — for example, a website or native app.

The REST API requires you to authenticate requests to fetch information about your events. If you are not authenticated, the API will not return any information.

You can authenticate your request by sending a token in the Authorization header of your request. In the following example, replace YOUR-API-KEY with a reference to your API Key:

curl --request GET \
 --url "https://api.letsdothis.com/v0/applications" \
 --header "Authorization: Bearer YOUR-API-KEY"

If you believe your API Key has been shared with a third party who should not have access to your data, you can invalidate the key in your account settings.

There are a number of error codes that can be returned by the API. These are detailed below.

Successful requests to the API will generate a response in JSON format.

When querying a list of entities, the response will be wrapped in a top-level object, and the result of the query will be returned in the value of the data property on that object.

In addition, responses will contain a page property which contains data about the current page.

{
  "data": [
    {
      "id": "6399c20015d60ae3ff28f24c",
      ...
    }
  ],
  "page": {
    "totalResults": 1,
    "first": "6399c20015d60ae3ff28f24c",
    "last": "64577f3fa6449247e0322e8e",
    "prev": "6399c20015d60ae3ff28f24c",
    "next": "6399c20015d60ae3ff28f24c"
  }
}

In this response the first, last, prev and next properties are cursors that can be used to navigate to earlier or later pages in the set of results. For instance, using the next cursor from fetches the next set of results. See more details on specific endpoints.

Several endpoints accept a features query parameter that lets you opt into additional fields and behaviors per request — for example, ?features=tags,waves. See the parameter description on the relevant endpoint (e.g. GET /v0/participants) for the full list of available features and what each one adds.

The easiest way to get started querying the API is to use a tool like RapidAPI or Postman.

You can either set up the requests yourself or use our generated OpenAPI schema and import it to both tools.

Import OpenAPI schema

Step 1: Download our OpenAPI schema

Can access it at the top of this documentation or by accessing it here.

Step 2: Import it to your preferred tool

Example guides:

• RapidApi
• Postman

Step 4: Submit

Now you should have access to all our endpoints and can start using your tool to make requests. Remember to also set your API KEY in the Authorization Header!

Manual set up

Step 1: Set URL

First, set the URL to https://api.letsdothis.com/v0/participants.

Step 2: Include Credentials

Set an Authorization Header in the Headers tab:

Step 3: Submit

And that's it! Now submit your request, and the API will return the first page of Participants in your account.

cURL is a command line utility available on most Linux and Unix like systems as well as Windows. It allows you to make network requests to a remote server (like the Let's Do This Public API) from your terminal.

You can send a GET request to the API in the following manner:

curl --request GET \
 --url "https://api.letsdothis.com/v0/applications" \
 --header "Authorization: Bearer YOUR-TOKEN"

Query parameters must be URL Encoded manually when using cURL. For example, setting the page size should look like:

curl --request GET \
 --url "https://api.letsdothis.com/v0/applications?page%3Fsize%5B=100" \
 --header "Authorization: Bearer YOUR-TOKEN"

and not

curl --request GET \
 --url "https://api.letsdothis.com/v0/applications?page[size]=100" \
 --header "Authorization: Bearer YOUR-TOKEN"

There are many ways of fetching data over the network with Node and Typescript or Javascript. The snippet below shows one simple approach using Typescript.

const YOUR_TOKEN = 'xxxxxxxxxxxx';
const LDT_API_BASE_URL = 'https://api.letsdothis.com/v0';

enum Endpoint {
  Applications = '/applications',
  Participants = '/participants',
}

const getURLForEndpoint = (endpoint: Endpoint): URL => {
  return new URL(LDT_API_BASE_URL + endpoint);
};

const applicationsURL = getURLForEndpoint(Endpoint.Applications);
const applicationsResponse = await fetch(applicationsURL, {
  method: 'GET',
  headers: new Headers({
    Authorization: `Bearer ${YOUR_TOKEN}`,
  }),
});

if (applicationsResponse.ok) {
  const applications = await applicationsResponse.json();
  console.log(applications);
}

Applications are created when a user applies for tickets that are set up to require an application process, such as balloted or "Good For Age" entries.

Participants are users who successfully booked an event.