Quickstart

This guide will get you all set up and ready to use the Elements API. We'll cover how to get started using the GraphQL API and how to make your first API request. We'll also look at where to go next to find all the information you need to take full advantage of our powerful GraphQL API.

Getting started with the API

The Elements API is a GraphQL API. GraphQL is a query language for APIs and a runtime for fulfilling those queries with your existing data. GraphQL provides a complete and understandable description of the data in your API, gives clients the power to ask for exactly what they need and nothing more, makes it easier to evolve APIs over time, and enables powerful developer tools.

The base url for the API is https://api.getelements.com/v1/graphql. This is the endpoint you will send all your requests to, and is hitting the production API. There is no publicly accessible staging or lower-lane environment currently available. An example request to the API might look like this:

# cURL is most likely already installed on your machine
curl -X "POST" "https://api.getelements.com/v1/graphql" \
  -H 'Content-Type: application/json; charset=utf-8' \
  -d $'{
  "query": "query Healthcheck{healthcheck}",
  "variables": {}
}'

What's next?

Great, you're now familiar with the basics of the API and have made the first request to the API. Here are a few links that might be handy as you venture further into the Elements API:

• Learn about how Authentication works