System

List audit log entries. Administrators only

get/audit-logs

Request

  • Base URL: https://helpspot.example.com/api/v2
  • URL: https://helpspot.example.com/api/v2/audit-logs
  • Auth: one of:
    • HTTP bearer
    • HTTP basic

Query parameters

offsetinteger
per_pageinteger

Response

Administrator-only audit records, newest ID first. created_at is UTC ISO 8601 (null for unset timestamps). staff_id preserves 0 (no staff) and -1 (system). string_value, decimal_value and details preserve stored text, including empty strings; details is not automatically decoded as JSON. Decimal values are strings to avoid precision loss.

Example response

{
  "data": [
    {
      "id": 42,
      "action": "update",
      "object": "HS_Request",
      "staff_id": 7,
      "request_id": 123,
      "created_at": "2023-11-14T22:13:20Z",
      "integer_value": null,
      "string_value": "Status changed",
      "decimal_value": null,
      "ip_address": "192.0.2.1",
      "details": "{\"xStatus\":2}"
    }
  ],
  "meta": {
    "offset": 0,
    "per_page": 10,
    "count": 1,
    "has_more": false,
    "next_offset": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.