API reference

Audit log

1 endpoint in this group.

Lists the audit log

GET/api/v1/audit-logs

Newest first. Raw details aren't returned: summary is a cleaned digest (no email, phone, IP, secrets or free text) and the actor appears only as user_id. Needs admin permission. Scope: organization:read.

Scope
organization:read
SDK method
listAuditLogs · list_audit_logs
MCP tool
listAuditLogsread-only

Paginated

Parameters

NameTypeRequiredDescription
categoryqueryenumnoAction categoryauth | account | org | team | bot | conversation | contact | campaign | automation | knowledge | community | post | miniapp | upload | apikey | webhook | plan | billing | affiliate | store
user_idqueryuuidnoUser who performed the action
fromquerydatenoStart day (YYYY-MM-DD, UTC)
toquerydatenoEnd day, inclusive (YYYY-MM-DD, UTC)
limitqueryintegernoPage size (1–200, default 50); 400 if it isn't an integerval 1–200, default 50
cursorquerystringnonext_cursor from the previous response (opaque)

Example request

curl -X GET "https://hiboty.com/api/v1/audit-logs?limit=50" \
  -H "Authorization: Bearer $HIBOTY_API_KEY"

Example response (200)

JSON
{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": "string",
      "action_name": "string",
      "category": "string",
      "user_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "target": "string",
      "summary": "string",
      "created_at": "2026-11-06T09:00:00.000Z"
    }
  ],
  "next_cursor": "string"
}

Possible errors

  • 400Invalid request: a missing or wrong field, or an unknown field name (validation_error).
  • 401The API key is missing, invalid or revoked (unauthorized).
  • 403Missing scope (scope), the plan doesn't allow it (plan_limit), the role isn't enough (forbidden_role), the email isn't verified (email_not_verified) or the organization is suspended.
  • 429A key, user or organization request limit (X-RateLimit-Scope) or the monthly message quota was exceeded; follow the Retry-After header.