Welcome to the API documentation for the FreePBX Middleware system. This API facilitates data ingestion from FreePBX and data consumption for PowerBI.
This API acts as a secure middleware and requires a Bearer Token for all requests. This ensures that only authorized services (FreePBX, PowerBI) can access the data.
You must include the Authorization header in every HTTP request with your secret token.
Authorization: Bearer YOUR_SECURE_TOKEN
Note: The token is generated securely by the system administrator and is not publicly available. If you lose your token, please contact the administrator to generate a new one from the server environment.
To ensure system stability, the API enforces the following limits:
429 Too Many Requests
response.limit and offset parameters to fetch data in
chunks (e.g., 1000 records at a time) rather than requesting the entire database at once.created_after to fetch only new records since your last
refresh. This is significantly faster and reduces load.429 errors by waiting a few minutes
before retrying.GET /api/v1/data
Fetches flattened call data suitable for PowerBI ingestion.
limit: Number of records to return (default: 500)offset: Pagination offset (default: 0)created_after: Filter by event date (ISO 8601, e.g., 2026-01-27T00:00:00Z)created_before: Filter by event date (ISO 8601)cid_num: Filter by specific CID Num (exact match)eventtype: Filter by specific Event Type (exact match, e.g., "CHAN_START"){
"data": [
{
"id": 1025,
"eventtype": "CHAN_START",
"eventtime": "2026-03-28T08:30:05.000Z",
"cid_name": "John Doe",
"cid_num": "101",
"cid_ani": "101",
"cid_rdnis": "",
"cid_dnid": "900",
"exten": "s",
"context": "from-internal",
"channame": "PJSIP/101-000000a1",
"appname": "",
"appdata": "",
"amaflags": 3,
"accountcode": "",
"uniqueid": "1711611005.161",
"linkedid": "1711611005.161",
"peer": "",
"userdeftype": "",
"extra": "{\"header\":\"value\"}"
}
],
"meta": {
"pagination": {
"total": 1,
"limit": 500,
"offset": 0,
"hasNextPage": false,
"hasPrevPage": false,
"nextOffset": null,
"prevOffset": null
}
}
}