How to fetch your company data using Flowbox's API

This guide will walk you through the process of retrieving your company data using Flowbox's API.

Prerequisites

Before you start, ensure you have the following:

API key: Your unique API authentication key. If you don't have it yet, please contact your CSM and they'll provide it to you.

To retrieve the list of flows in your Flowbox account, you need to send a GET request to the following endpoint:

https://external-api.getflowbox.com/v2/company

You can find more information and make test calls in our Swaggerhub page.

Parameter	Type	Location	Description
`api-key`	string	header	Your API authentication key. Must be included in every request.

Here is an example request with both required and optional parameters:

curl -X 'GET' \  
'https://external-api.getflowbox.com/v2/company' \   
-H 'accept: application/json' \   
-H 'api-key: INSERT_API_KEY_HERE'

The response will be a JSON containing the company data associated to the API key provided.

Root:

Field	Type	Description
`status`	string	Request status. One of:`"success"`,`"error"`.
`data.company.name`	string	Name of company.
`data.company.country`	string	Country code for the company, e.g: `"ES"`, `"US"`
`data.company.currency`	string	Currency code for the company, e.g `"EUR"`, `"USD"`. This is the currency in which the analytics will be displayed within the Flowbox platform.