API reference › History and logs › Audits
Retrieve audit logs
GET /v1/audits
- Scope
history_logs:read
Fetches a paginated list of audit trail records with filters such as module, user, entity, audit event type, and date range.
Parameters
Query parameters
| Name | Type | Description |
|---|---|---|
module | string | Filter by module. Accepted values: assignment, shift, client, consumer, service_provider (or service-provider), finance (or finances), organization, settings, broadcast, forms, fido, admin-scheduler. One of: |
userId | string | Filter by user ID who performed the action |
role | string | Filter by actor role (admin, client, consumer, service-provider) |
auditEventType | string | Filter by audit event type (created, updated, deleted, status_changed, etc.) Example |
auditableType | string | Fully qualified auditable model type Example |
auditableId | string | ID of the auditable entity |
from | string (date) | Start date (YYYY-MM-DD) |
to | string (date) | End date (YYYY-MM-DD) |
search | string | Search term across audit message & metadata |
sortBy | string | Sort by field (default: created_at) |
sortOrder | string | Sort order (asc or desc) One of: |
perPage | integer | Records per page (default: 10) |
page | integer | Page number (default: 1) Example |
startDate | string (date) | Alias of |
endDate | string (date) | Alias of |
Every call also sends Authorization and X-Tenant-ID; see Getting started.
Example request
curl "https://api.fetchfido.ai/v1/audits" \
-H "Authorization: Bearer $FIDO_API_KEY" \
-H "X-Tenant-ID: $FIDO_TENANT_ID"Try it
Responses
200 Audit logs retrieved successfully
Audit logs retrieved successfully
{
"success": true,
"data": [
{
"id": 1,
"event": "Status changed",
"category": "string",
"module": "string",
"summary": "Assignment status changed from Pending to Confirmed.",
"description": "Short human-readable description.",
"occurredAt": "2026-01-15 09:00:00",
"occurredAtUtc": "string",
"occurredAtIso": "string",
"timezone": "America/New_York",
"actor": {
"name": "Example name",
"role": "Administrator",
"type": "Administrator",
"image": "string"
},
"subject": {
"name": "Example name",
"role": "admin",
"image": "string"
},
"initiation": "Manual",
"trigger": "string",
"impersonation": {
"active": true,
"impersonator": {},
"target": {},
"startedAt": "2026-01-15 09:00:00"
},
"entity": {
"type": "Assignment",
"reference": "ASN-12345",
"label": "Tuesday morning interpretation"
},
"changes": [
{
"field": "Status",
"from": "Pending",
"to": "Confirmed"
}
],
"eventLabel": "Example label",
"auditableType": "App\\\\Models\\\\Assignment",
"auditableId": "ASG-XY9EML",
"oldValues": [
null
],
"newValues": [
null
],
"logMessage": "Request processed successfully.",
"actionSource": "manual",
"actorType": {
"code": "string",
"label": "Example label"
},
"user": {
"name": "Example name",
"role": "admin",
"type": "string",
"image": "https://cdn.example.com/image.png"
},
"subjectUser": {
"name": "Example name",
"role": "admin",
"type": "string",
"image": "https://cdn.example.com/image.png"
},
"time": "09:00:00",
"convertedTime": "09:00:00",
"createdAt": "2026-01-15 09:00:00",
"internal": {}
}
],
"meta": {
"currentPage": 1,
"lastPage": 1,
"perPage": 1,
"total": 1,
"startDate": "2026-01-15",
"endDate": "2026-01-15"
}
}Response fields (67)
3 top-level fields; 2 hold nested fields, listed below.
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
data | array of object (58 nested) | |
meta | object (6 nested) |
Nested fields
data 58 fields
| Field | Type | Description |
|---|---|---|
data[].id | integer | Example |
data[].event | string | User-friendly event label Example |
data[].category | string or null | |
data[].module | string | |
data[].summary | string | Human-readable description of what happened Example |
data[].description | string | Example |
data[].occurredAt | string | Example |
data[].occurredAtUtc | string | |
data[].occurredAtIso | string or null | |
data[].timezone | string or null | Example |
data[].actor | object | Who initiated the action |
data[].actor.name | string | Example |
data[].actor.role | string | Example |
data[].actor.type | string | Canonical actor type label Example |
data[].actor.image | string or null | |
data[].subject | object or null | Whose record was acted on, when distinct from the actor |
data[].subject.name | string | Example |
data[].subject.role | string | Example |
data[].subject.image | string or null | |
data[].initiation | string | Manual / Automated / System-generated Example |
data[].trigger | string or null | |
data[].impersonation | object or null | |
data[].impersonation.active | boolean | Example |
data[].impersonation.impersonator | object | |
data[].impersonation.target | object | |
data[].impersonation.startedAt | string or null | Example |
data[].entity | object | |
data[].entity.type | string | Example |
data[].entity.reference | string or null | Example |
data[].entity.label | string or null | Example |
data[].changes | array of object | What changed (humanized field labels, FK ints resolved, PHI redacted for non-privileged viewers) |
data[].changes[].field | string | Example |
data[].changes[].from | string | Example |
data[].changes[].to | string | Example |
data[].eventLabel | string | Example |
data[].auditableType | string | Example |
data[].auditableId | string | Example |
data[].oldValues | array of any | |
data[].newValues | array of any | |
data[].logMessage | string | Example |
data[].actionSource | string or null | Example |
data[].actorType | object or null | |
data[].actorType.code | string or null | |
data[].actorType.label | string | Example |
data[].user | object or null | |
data[].user.name | string | Example |
data[].user.role | string | Example |
data[].user.type | string | |
data[].user.image | string | Example |
data[].subjectUser | object or null | |
data[].subjectUser.name | string or null | Example |
data[].subjectUser.role | string or null | Example |
data[].subjectUser.type | string or null | |
data[].subjectUser.image | string or null | Example |
data[].time | string | Example |
data[].convertedTime | string | Example |
data[].createdAt | string or null | Example |
data[].internal | object or null | Only populated for admin/scheduler/super-admin roles — contains raw codes for support & filtering. |
meta 6 fields
| Field | Type | Description |
|---|---|---|
meta.currentPage | integer | Example |
meta.lastPage | integer | Example |
meta.perPage | integer | Example |
meta.total | integer | Example |
meta.startDate | string | Example |
meta.endDate | string | Example |
401 Not signed in
Unauthorized
{
"success": false,
"message": "Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for.",
"errors": null,
"code": "API_KEY_MISSING"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
403 Not allowed
Scope, tenant, IP allow-list or RBAC check failed.
{
"success": false,
"message": "You don't have permission to access this endpoint. This API key is missing the 'history_logs:read' scope.",
"errors": null,
"code": ""
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Always empty on this status. Example |
429 Too many requests
Rate limit exceeded. See Retry-After.
{
"success": false,
"message": "You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds.",
"errors": null,
"code": "RATE_LIMITED"
}Response fields (4)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |
errors | any or null | Null on this status. |
code | string | Machine-readable reason, for branching on in client code. One of: |
500 Server error
Internal Server Error
{
"success": false,
"message": "An unexpected error occurred — please try again."
}Response fields (2)
| Field | Type | Description |
|---|---|---|
success | boolean | Example |
message | string | Example |