Quick Start

Welcome to Flow's Customer API. You can use our API to access information available in your Flow organization (or organizations you are associated with) to build a customized experience.

If you have questions that are not addressed in this documentation or need additional help, reach out to [e-mail]. We'd be happy to assist.

Get your API keys

Your API requests are authenticated using JWT.

You can generate a JWT by reaching out to our support team at [e-mail]. Our support team will get you the token you need.

Make your first request

Authentication is based on an API key. You need to set the Authorization header to this value:

Authorization: Bearer YOUR_JWT

You must replace YOUR_JWT with your corresponding API key.

curl

curl "https://api.flowinc.app/customerapi/funds" \
  -H "Authorization: bearer YOUR_JWT"

Ruby

require 'json'
require 'net/http'

uri = URI('https://api.flowinc.app/customerapi/funds')
params = Net::HTTP::Get.new(uri)
jwt = 'YOUR_JWT'
params['Authorization'] = "Bearer #{jwt}"

response = Net::HTTP.start(uri.hostname, uri.port) { |http| http.request(params) }
puts JSON.parse(response.body)

Js

const url = 'https://api.flowinc.app/customerapi/funds'

fetch(url, {
    method: "GET",
    headers: {
      "Authorization": `Bearer ${YOUR_JWT}`,
      "Content-Type": "application/json"
    }
})
.then(response => {
    return response.json();
})