Skip to main content

Getting Started

This guide will get you up and running with the Turquoise API in no time.

Prerequisites​

To make the most of this guide, you’ll need to:

info

To get started, you'll need a Turquoise Health account. If you don't have one yet, create one here.

API keys​

Turquoise Health authenticates your API requests using your account's API key. If a request doesn't include a valid key, Turquoise Health returns an invalid request error. If a request includes a deleted or expired key, Turquoise Health returns an authentication error.

Authentication​

The Turquoise API uses API keys to authenticate requests, which you can view and manage in the Turquoise Health Platform.

Since your API keys grant significant access, be sure to keep them secure! Avoid sharing your secret API keys in publicly accessible areas like GitHub, client-side code, and similar locations. All API requests must be made over HTTPS; any requests made over plain HTTP will fail, as will any requests missing proper authentication.

curl -G "https://lab.turquoise.health/api/v1/gfe/" \
    -H "Authorization Bearer TURQUOISE_API_KEY"
On this page: