Audit Logs

Audit logs record actions performed on your ClearFeed account, and calls ClearFeed makes to connected systems on your behalf, for compliance and security auditing.

These endpoints require an admin API token. Non-admin tokens receive a 403 Forbidden response.

Audit Log Entry Object

Each audit log entry is a JSON object with the following properties.

Name	Type	Description
created_at	string (ISO 8601)	Timestamp when the action occurred.
integration	enum	System the action was performed against. One of: clearfeed or hubspot.
actor_name	string	Display name of the user who performed the action. ClearFeed System for system-performed actions.
actor_email	string	Email of the user who performed the action. Unknown for system-performed actions.
operation	enum	One of: access (read operations) or update (write operations).
action	string	Description of the action (e.g., "Updated customer", "Sent message to HubSpot conversation").
resource_type	enum	Type of resource affected. See Resource Types.
resource_ids	string array | null	Identifiers of the affected resource(s). Null when no identifiers were captured.
details	object | null	Additional structured context. See Details. Null for most clearfeed entries.
source	enum	Channel through which the action was performed. One of: API, Dashboard, Slack, Microsoft Teams, Discord, Telegram, ClearFeed Support, System.
ip_address	string | null	IP address of the requester.

Details

Keys present on entries for calls to connected systems (integration: "hubspot"). Optional keys are omitted when they do not apply.

Key	Type	Description
method	string	HTTP method of the call. One of: GET, POST, PUT, PATCH, DELETE.
outcome	enum	One of: success or failure.
statusCode	integer	HTTP status code returned. Omitted when the call failed without an HTTP response.
retries	integer	Number of retry attempts. Omitted when the call was not retried.
requestIds	integer array	ClearFeed request number(s) the call is attributed to. Omitted when no request applies.
jobName	enum	Job that made the call, when source is System. One of: CRM Sync, Automation, AI-Agent.
automationId	integer	Automation number, when jobName is Automation.
aiAgentId	integer	AI agent number, when jobName is AI-Agent.

Resource Types

clearfeed: Account, Request, Collection, SlackChannel, TelegramChannel, DiscordChannel, Customer, CustomField, CustomStatus, Rotation, EmailDomain, EmailBlocklist, Agent, Announcement, Automation, QuickReply

hubspot: HubSpotAccount, HubSpotAssociation, HubSpotCompany, HubSpotContact, HubSpotConversation, HubSpotDeal, HubSpotEmail, HubSpotFile, HubSpotNote, HubSpotPipeline, HubSpotProperty, HubSpotTask, HubSpotTicket, HubSpotUser

List Audit Logs

GET https://api.clearfeed.app/v1/rest/audit-logs

Retrieve a paginated list of audit log entries for the account.

Query Parameters

All parameters are optional.

Name	Type	Description
integration	enum	Filter by system. One of: clearfeed or hubspot.
actor_email	string	Filter by actor email address (max 255 chars, case-insensitive).
operation	enum	Filter by operation type. One of: access or update.
resource_type	enum	Filter by resource type. Any value listed in Resource Types.
source	enum	Filter by source. One of: API, Dashboard, Slack, Microsoft Teams, Discord, Telegram, ClearFeed Support, System.
before	string	Fetch records created before this timestamp (ISO 8601). Cannot be in the future.
after	string	Fetch records created after this timestamp (ISO 8601). Cannot be in the future. Must be earlier than before when both are provided.
sort_order	enum	Sort order for results. One of: asc or desc. Defaults to desc (newest first).
limit	integer	Number of results to return (1–100). Defaults to 50.
next_cursor	string	Base64-encoded cursor for pagination. Obtained from metadata.next_cursor in a previous response.

200

{
  "data": [
    {
      "created_at": "2026-04-15T10:30:00.000Z",
      "integration": "clearfeed",
      "actor_name": "Alice Smith",
      "actor_email": "[e-mail]",
      "operation": "update",
      "action": "Updated customer",
      "resource_type": "Customer",
      "resource_ids": ["42"],
      "details": null,
      "source": "API",
      "ip_address": "203.0.113.5"
    },
    {
      "created_at": "2026-04-15T10:29:00.000Z",
      "integration": "hubspot",
      "actor_name": "Alice Smith",
      "actor_email": "[e-mail]",
      "operation": "update",
      "action": "Sent message to HubSpot conversation",
      "resource_type": "HubSpotConversation",
      "resource_ids": ["7391104456", "47806069113"],
      "details": {
        "method": "POST",
        "outcome": "success",
        "statusCode": 201,
        "requestIds": [1026]
      },
      "source": "Slack",
      "ip_address": null
    }
  ],
  "metadata": {
    "next_cursor": "MTIz",
    "count": 2
  }
}

metadata.next_cursor is null when there are no more pages. metadata.count is the number of entries in the current data array.

403: Forbidden Permission denied

Export Audit Logs

GET https://api.clearfeed.app/v1/rest/audit-logs/export

Download audit log entries as a CSV file. Accepts the same filter parameters as the List endpoint.

Query Parameters

All parameters are optional.

Name	Type	Description
integration	enum	Filter by system. One of: clearfeed or hubspot.
actor_email	string	Filter by actor email address (max 255 chars, case-insensitive).
operation	enum	Filter by operation type. One of: access or update.
resource_type	enum	Filter by resource type. Any value listed in Resource Types.
source	enum	Filter by source. One of: API, Dashboard, Slack, Microsoft Teams, Discord, Telegram, ClearFeed Support, System.
before	string	Fetch records created before this timestamp (ISO 8601). Cannot be in the future.
after	string	Fetch records created after this timestamp (ISO 8601). Cannot be in the future. Must be earlier than before when both are provided.
limit	integer	Maximum number of rows in the CSV (1–10000). Defaults to 1000. To export a large date range completely, partition it into time-bounded batches using before and after.

200: Success

Returns a CSV file.

Response Headers:

• Content-Type: text/csv

• Content-Disposition: attachment; filename="audit-logs-{accountId}-{YYYY-MM-DD}.csv"

CSV Columns (in order): timestamp, actor_name, actor_email, operation, action, resource_type, resource_ids, details, source, ip_address, integration

Column notes:

• timestamp — ISO 8601 UTC (e.g., 2026-04-15T10:30:00.000Z)

• resource_ids — comma-and-space-separated list; empty string if none

• details — JSON-serialized; empty string if null

• ip_address — empty string if not available

403: Forbidden Permission denied