API Reference

Use the FlexiPort API to access your transformed data.

Authentication
How to get and use an access key for the API

All API requests require an access key, which is specific to a pipeline. The API supports two authentication methods:

1. Query Parameter

Include the access key as a query parameter: ?access_key=your-access-key

GET /exports?access_key=your-access-key

2. Authorization Header

Send the access key as a Bearer token in the Authorization header:

Authorization: Bearer your-access-key

How to get an access key:

  1. On the Pipelines Dashboard, select the desired pipeline from the list
  2. Click the three-dots menu (...) in the right part of the row
  3. Select "Generate Access Key"
  4. Copy the generated key

Base URL

https://flexiport.ai/integrations/v1

API Endpoints

Rate Limits and Best Practices
  • The API has a rate limit of 100 requests per minute per access key
  • For large datasets, use pagination to retrieve data in manageable chunks
  • Access keys are tied to specific pipelines and should be kept secure
HTTP Status Codes
CodeDescription
200OK - Request successful
400Bad Request - Error in request parameters
401Unauthorized - Invalid or missing access key
404Not Found - Resource not found
429Too Many Requests - Rate limit exceeded