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

NameTypeDescription
modulestring

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: assignment, shift, client, consumer, service_provider, service-provider, finance, finances, organization, settings, broadcast, forms, fido, admin-scheduler. Example assignment.

userIdstring

Filter by user ID who performed the action

rolestring

Filter by actor role (admin, client, consumer, service-provider)

auditEventTypestring

Filter by audit event type (created, updated, deleted, status_changed, etc.)

Example updated.

auditableTypestring

Fully qualified auditable model type

Example Client.

auditableIdstring

ID of the auditable entity

fromstring (date)

Start date (YYYY-MM-DD)

tostring (date)

End date (YYYY-MM-DD)

searchstring

Search term across audit message & metadata

sortBystring

Sort by field (default: created_at)

sortOrderstring

Sort order (asc or desc)

One of: asc, desc.

perPageinteger

Records per page (default: 10)

pageinteger

Page number (default: 1)

Example 1.

startDatestring (date)

Alias of from; read only when from is absent.

endDatestring (date)

Alias of to; read only when to is absent.

Every call also sends Authorization and X-Tenant-ID; see Getting started.

Example request

Shell
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

JSON
{
  "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.

FieldTypeDescription
successboolean

Example true.

dataarray of object (58 nested)
metaobject (6 nested)

Nested fields

data 58 fields
FieldTypeDescription
data[].idinteger

Example 1.

data[].eventstring

User-friendly event label

Example Status changed.

data[].categorystring or null
data[].modulestring
data[].summarystring

Human-readable description of what happened

Example Assignment status changed from Pending to Confirmed..

data[].descriptionstring

Example Short human-readable description..

data[].occurredAtstring

Example 2026-01-15 09:00:00.

data[].occurredAtUtcstring
data[].occurredAtIsostring or null
data[].timezonestring or null

Example America/New_York.

data[].actorobject

Who initiated the action

data[].actor.namestring

Example Example name.

data[].actor.rolestring

Example Administrator.

data[].actor.typestring

Canonical actor type label

Example Administrator.

data[].actor.imagestring or null
data[].subjectobject or null

Whose record was acted on, when distinct from the actor

data[].subject.namestring

Example Example name.

data[].subject.rolestring

Example admin.

data[].subject.imagestring or null
data[].initiationstring

Manual / Automated / System-generated

Example Manual.

data[].triggerstring or null
data[].impersonationobject or null
data[].impersonation.activeboolean

Example true.

data[].impersonation.impersonatorobject
data[].impersonation.targetobject
data[].impersonation.startedAtstring or null

Example 2026-01-15 09:00:00.

data[].entityobject
data[].entity.typestring

Example Assignment.

data[].entity.referencestring or null

Example ASN-12345.

data[].entity.labelstring or null

Example Tuesday morning interpretation.

data[].changesarray of object

What changed (humanized field labels, FK ints resolved, PHI redacted for non-privileged viewers)

data[].changes[].fieldstring

Example Status.

data[].changes[].fromstring

Example Pending.

data[].changes[].tostring

Example Confirmed.

data[].eventLabelstring

Example Example label.

data[].auditableTypestring

Example App\\Models\\Assignment.

data[].auditableIdstring

Example ASG-XY9EML.

data[].oldValuesarray of any
data[].newValuesarray of any
data[].logMessagestring

Example Request processed successfully..

data[].actionSourcestring or null

Example manual.

data[].actorTypeobject or null
data[].actorType.codestring or null
data[].actorType.labelstring

Example Example label.

data[].userobject or null
data[].user.namestring

Example Example name.

data[].user.rolestring

Example admin.

data[].user.typestring
data[].user.imagestring

Example https://cdn.example.com/image.png.

data[].subjectUserobject or null
data[].subjectUser.namestring or null

Example Example name.

data[].subjectUser.rolestring or null

Example admin.

data[].subjectUser.typestring or null
data[].subjectUser.imagestring or null

Example https://cdn.example.com/image.png.

data[].timestring

Example 09:00:00.

data[].convertedTimestring

Example 09:00:00.

data[].createdAtstring or null

Example 2026-01-15 09:00:00.

data[].internalobject or null

Only populated for admin/scheduler/super-admin roles — contains raw codes for support & filtering.

meta 6 fields
FieldTypeDescription
meta.currentPageinteger

Example 1.

meta.lastPageinteger

Example 1.

meta.perPageinteger

Example 1.

meta.totalinteger

Example 1.

meta.startDatestring

Example 2026-01-15.

meta.endDatestring

Example 2026-01-15.

401 Not signed in

Unauthorized

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example Invalid API key. Org and user tier keys must send an X-Tenant-ID header naming the organization the key was issued for..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: API_KEY_MISSING, API_KEY_INVALID, API_KEY_EXPIRED. Example API_KEY_MISSING.

403 Not allowed

Scope, tenant, IP allow-list or RBAC check failed.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You don't have permission to access this endpoint. This API key is missing the 'history_logs:read' scope..

errorsany or null

Null on this status.

codestring

Always empty on this status.

Example .

429 Too many requests

Rate limit exceeded. See Retry-After.

JSON
{
  "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)
FieldTypeDescription
successboolean

Example false.

messagestring

Example You've exceeded this API key's rate limit of 120 requests per minute. Try again in 37 seconds..

errorsany or null

Null on this status.

codestring

Machine-readable reason, for branching on in client code.

One of: RATE_LIMITED. Example RATE_LIMITED.

500 Server error

Internal Server Error

JSON
{
  "success": false,
  "message": "An unexpected error occurred — please try again."
}
Response fields (2)
FieldTypeDescription
successboolean

Example false.

messagestring

Example An unexpected error occurred — please try again..