API overview

Our API enables you to integrate, automate, and extend Flireo phone agents, contacts, calls, phone numbers, and more directly into your applications and workflows.

Base URL

All endpoints use the following base URL:

https://api.flireo.nl/v1/

Authentication

All API requests must be authenticated using a Bearer Token. You can create and manage your API tokens in your Flireo dashboard.

Include your token in the Authorization header for every request:

Authorization: Bearer YOUR_API_TOKEN

Your API token acts as your secure key to access, create, update, and delete resources on the platform.

Response Format

All responses are returned in JSON format.

Successful responses use standard HTTP codes (2xx).
Errors use 4xx (client errors) and 5xx (server errors), with a structured error message in the response body.

Example error response:

{
  "error": {
    "code": "invalid_request",
    "message": "Invalid parameters",
    "details": {
      "name": "This field is required"
    }
  }
}

Rate Limiting

To ensure fair usage and platform reliability, rate limits are applied to all API tokens.

Default rate limit: 100 requests per minute per token.

Rate limit headers are included with every response:

X-RateLimit-Limit: maximum allowed requests

X-RateLimit-Remaining: requests left in the current window

X-RateLimit-Reset: timestamp when the limit resets

If you exceed the limit, you'll receive a 429 Too Many Requests response.

Main API Resources

Flireo's API covers all major platform features. Common resource categories include:

Assistants: Create, view, update, and delete phone agents

Calls: Initiate, log, and analyze phone calls (direct and scheduled)

Contacts: Manage caller information and CRM data

Phone Numbers: Purchase, assign, and release phone numbers

Verification Groups: Manage regulatory compliance and verification for regional numbers

SIP Connections: Integrate with your own telephony infrastructure

Documents: Upload and manage verification documents

Each resource follows REST conventions and supports CRUD operations where applicable.

Making Requests

Use HTTPS for all requests.

Format request bodies as JSON (unless otherwise specified, e.g., file uploads).

Always include your Bearer Token in the authorization header.

Example: Get all assistants

Testing and Exploring Endpoints

Each endpoint in the reference includes:

Parameter tables (required and optional fields)

Request and response examples (cURL, JavaScript, Python)

Error handling details

Start by reviewing the Authentication section, then explore the endpoints relevant to your use case.

Support and Best Practices

Use descriptive names and clear instructions for your agents.

Handle errors and rate limits gracefully in your integrations.

Secure your API tokens—never share them in public code.

Monitor your usage and audit logs via the dashboard.

Ready to build?
Browse the full API reference to get started, or use the quickstart guides for your preferred language.

Base URL#

Authentication#

Response Format#

Rate Limiting#

Main API Resources#

Making Requests#

Testing and Exploring Endpoints#

Support and Best Practices#