Platform · Published API
API Call Log
Every call to the published API, allowed or refused, with the reason for each refusal. A call that came with no key, or a key nobody issued, is logged refused with the Client column empty: that includes anyone probing the address and an AI app's first call before it has signed in. To see how your own integrations are doing, filter on Client. This is not the audit log — that records what the record actually did, because a published call goes through the ordinary route and the ordinary route audits itself. This records what was asked, from where, and by which key.
/api/platform/api-callsPublished as /api/v1/api-callsOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › API Call Log on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Table | platform.api_calls · kept per company (and organisational unit where it has one) |
| Record | Read only; key id |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
6 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/api-callsList api call log
Query parameters
| Name | Description | Example |
|---|---|---|
limit | Rows per page (50 by default, at most 200) | limit=100 |
offset | Rows to skip | offset=200 |
q | Free-text search over the search columns | q=acme |
sort | column:asc or column:desc, several separated by commas | sort=created_at:desc |
filter | A JSON condition or group (see the filter language), URL-encoded; any field below can be filtered and sorted | filter={"col":"status","op":"eq","value":"open"} |
<field>=<value> | Shorthand for "field is value" |
Response 200
{
"rows": [
{
"id": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exposure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"at": "2026-10-30T09:00:00Z",
"protocol": "text",
"method": "text",
"path": "text",
"tool_name": "Example",
"module_key": "text",
"resource_key": "text",
"status": 10,
"outcome": "text",
"refusal": "text"
}
],
"count": 1
}Sample request
curl "https://demo.tranxact.ai/api/platform/api-calls?limit=20" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/api-calls/{id}Read one api call
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response 200
{
"id": "1250.00",
"org_unit_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"client_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"exposure_id": "3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73",
"at": "2026-10-30T09:00:00Z",
"protocol": "text",
"method": "text",
"path": "text",
"tool_name": "Example",
"module_key": "text",
"resource_key": "text",
"status": 10,
"outcome": "text",
"refusal": "text"
}404 when no record with that id is visible to the caller.
Sample request
curl "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-callsPost api call log
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-calls" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/api-calls/{id}/copyCopy
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
overrides, preview, withLinesResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/copy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"overrides":"value","preview":"value","withLines":"value"}'PUT/api/platform/api-calls/{id}Put api call log
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"DELETE/api/platform/api-calls/{id}Delete api call log
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/api-calls/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"Data model
Every field of a api call, as the API returns it. Field names are the JSON keys; any of them can be filtered and sorted on a list.
| Field | Type | Access | Description |
|---|---|---|---|
id | bigint | read only | Id |
org_id | uuid | read only | Org id |
org_unit_id | uuid | read only | Org unit id |
client_id | uuid | read only | Client id |
exposure_id | uuid | read only | Exposure id |
at | timestamp with time zone | read only | At |
protocol | text | read only | Protocol |
method | text | read only | Method |
path | text | read only | Path |
tool_name | text | read only | Tool name |
module_key | text | read only | Module key |
resource_key | text | read only | Resource key |
status | integer | read only | Status |
outcome | text | read only | Outcome |
refusal | text | read only | Refusal |
row_count | integer | read only | Row count |
duration_ms | integer | read only | Duration ms |
remote_ip | text | read only | Remote ip |
origin | text | read only | Origin |
user_agent | text | read only | User agent |
created_at | timestamp with time zone | read only | Created at |
created_by | uuid | read only | Created by |
updated_at | timestamp with time zone | read only | Updated at |
updated_by | uuid | read only | Updated by |
xf_text_1 | text | read only | Xf text 1 |
xf_text_2 | text | read only | Xf text 2 |
xf_text_3 | text | read only | Xf text 3 |
xf_text_4 | text | read only | Xf text 4 |
xf_text_5 | text | read only | Xf text 5 |
xf_num_1 | numeric | read only | Xf num 1 |
xf_num_2 | numeric | read only | Xf num 2 |
xf_num_3 | numeric | read only | Xf num 3 |
xf_date_1 | date | read only | Xf date 1 |
xf_date_2 | date | read only | Xf date 2 |
Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › API Call Log for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.