Obtain your API key and make a successful request in less than 5 minutes.

📘

Sandbox environment

We’ll be using the sandbox environment of our API. The sandbox lets you develop on the Tremendous API using mock data. The sandbox environment's URL is https://testflight.tremendous.com.

:key: Getting an API key

To get an API key:

  1. Sign up or log in to your sandbox account at: https://app.testflight.tremendous.com/
  2. Navigate to Team Settings > Developers
  3. Click on Add API key on the top right to generate a new API key

:tada: Making your first request

To verify that we are authenticated, let's make a request to the API using curl.

curl --url 'https://testflight.tremendous.com/api/v2/organizations' \
     --header 'Authorization: Bearer YOUR-API-KEY'

🚧

Make sure to replace YOUR-API-KEY with the actual API key you have obtained above.

A successful response here will include the name of the organization that you signed up with.

{
  "organizations": [
    {
      "id": "GJM92EA70OJW",
      "name": "Test Company",
      "website": "tremendous.com",
      "status": "APPROVED"
    }
  ]
}

Congrats, you've authenticated and made your first request!