Quickstart

This guide will get you all set up and ready to use the Typeflow.us API. We'll cover how to get started using one of our API routes 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 REST API.

Before you can make requests to the Typeflow.us API, you will need to grab your API key from your dashboard. You find it under Settings » API.

Making your first Typeflow.us API request

For the purpose of this guide, we will use the API route to retrieve a flow you implemented in Typeflow.us.

GET

https://app.typeflow.us/api/retrieve-all-flows

  curl -G https://app.typeflow.us/api/retrieve-all-flows \
    -d appId="{appId}" \
    -d tableId="{tableId}" \
    -d apiKey="{apiKey}"

Read the docs for the Retrieve Flow endpoint

What's next?

Great, you have made your first request to the API. Here are a few links that might be handy as you venture further into the Typeflow API:

Grab your API key from the Typeflow developer Dashboard
Check out the Retrieve Flow endpoint