API Reference List Audit Entries
List Audit Entries
Retrieve the audit trail of actions taken in a project
Session token
Returns a paginated, newest-first list of audit entries for a project. Every state-changing action taken through the dashboard or API — settings updates, API key lifecycle events, custom domain changes, manual build triggers, audience profile changes, and webhook endpoint changes — is recorded automatically.
Plan availability
The audit log is a paid feature, and how far back you can read depends on the workspace's plan. The window is applied on the server, so entries outside it are never returned, whatever you ask for.
| Plan | History returned | actor filter | Export |
|---|---|---|---|
| Free | None — 402 plan_required (feature: audit_log, requiredTier: starter) | — | — |
| Starter | Last 7 days | 402 (feature: audit_actor_filter) | 402 (feature: audit_export) |
| Pro | Last 365 days | Yes | Yes |
| Enterprise | Unlimited | Yes | Yes |
See Plan errors for the 402 body.
Path Parameters
NameDescription
projectIdThe project to read audit entries for. The caller must be a member of the organization that owns the project.
Query Parameters
NameDescription
pagePage number for pagination.
Default
1limitNumber of entries per page. Maximum:
100.Default
50actorFilter by actor email (case-insensitive substring match), e.g.
jane@. Pro or higher — on Starter, sending actor returns 402 plan_required.resourceFilter by resource type, e.g.
settings, build, domain, api_key, webhook, audience, page, approval_gate, glossary, project, content, asset, change, org_theme.Response
NameDescription
dataArray of audit entry objects.
Show 7 child attributesarray
idUnique audit entry identifier.
actionWhat happened, e.g.
settings.updated, api_key.created, domain.removed, build.triggered.actorWho performed the action:
id, name, and email. Fields are empty strings when the actor account was deleted.resourceWhat was acted on:
type, id, and an optional human-readable name (e.g. the domain or API key name).metadataAction-specific details, such as the fields changed in a settings update. When the entry has an
ipAddress and the stored metadata has no ip key of its own, the address is copied into metadata.ip as well.ipAddressThe IP address the action was made from: the first
x-forwarded-for hop, else cf-connecting-ip, else x-real-ip. Only literal IPv4 or IPv6 addresses are kept. null for actions taken by background jobs rather than a request, and for entries recorded before IP capture was added.createdAtISO 8601 timestamp of when the action happened.
hasMoretrue when more pages are available.totalThe number of entries that match the same
actor and resource filters inside your plan's window — across all pages, not just this one. Use it to render page counts.Recorded Actions
| Action | Resource type | When |
|---|---|---|
settings.updated | settings | Project settings changed |
project.deleted | settings | Project deleted |
api_key.created / api_key.rotated / api_key.revoked | api_key | API key lifecycle |
domain.added / domain.removed | domain | Custom domain changes |
build.triggered | build | Manual build trigger |
build.cancelled | build | A build was cancelled |
deployment.promote | build | A preview deploy was promoted |
deployment.rollback | build | A rollback was queued — the target is the new build |
page.delete | page | A page was deleted in the editor |
approval_gate.update / approval_gate.delete | approval_gate | Approval gate edited or deleted |
glossary.import | glossary | Glossary terms imported from CSV |
ownership_alerts.update | project | Stale-page alert settings changed |
audience.created / audience.updated / audience.deleted | audience | Audience profile changes |
webhook.created / webhook.deleted | webhook | Webhook endpoint changes |
webhook.secret_rotated | webhook | An endpoint's signing secret was rotated. The secret is never logged |
content.restore / content.import | content | Hosted content restored or imported |
brand_asset.uploaded | project | A logo or favicon was uploaded |
appearance.published / appearance.previewed / appearance.v2_previewed | project | Appearance changes published or previewed, or a doc engine v2 preview built |
home.convert | page | A generated home page was converted to home components |
org_theme.applied | org_theme | An organization theme was applied to the project |
source.github.connected / source.github.disconnected / source.github.pull_request_opened / source.github.link_cancelled | project | The project's GitHub repository was connected or disconnected |
mcp.<tool> — e.g. mcp.create_page, mcp.update_page, mcp.delete_page, mcp.upload_image | page, change, build or asset | A change made through the MCP connector |
Was this page helpful? Yes No
Previous
Next
Request
bashJavaScriptPythonGoRubyPHPJavaC#bash
curl "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25" \
-H "Authorization: Bearer $SYNTEXT_TOKEN"
// A browser has no environment variables: set these to your values.
const SYNTEXT_TOKEN = '<SYNTEXT_TOKEN>';
const response = await fetch('https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25', {
method: 'GET',
headers: {
'Authorization': `Bearer ${SYNTEXT_TOKEN}`,
},
});
const data = await response.json();
console.log(response.status, data);
import os
import requests
url = "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25"
headers = {
"Authorization": f"Bearer {os.environ['SYNTEXT_TOKEN']}",
}
response = requests.get(url, headers=headers)
print(response.status_code)
print(response.json())
package main
import (
"fmt"
"io"
"net/http"
"os"
)
func main() {
req, err := http.NewRequest("GET", "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25", nil)
if err != nil {
panic(err)
}
req.Header.Set("Authorization", "Bearer "+os.Getenv("SYNTEXT_TOKEN"))
res, err := http.DefaultClient.Do(req)
if err != nil {
panic(err)
}
defer res.Body.Close()
body, err := io.ReadAll(res.Body)
if err != nil {
panic(err)
}
fmt.Println(res.Status)
fmt.Println(string(body))
}
require "net/http"
require "uri"
uri = URI("https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25")
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "Bearer #{ENV.fetch("SYNTEXT_TOKEN")}"
response = http.request(request)
puts response.code
puts response.body
<?php
$ch = curl_init();
curl_setopt_array($ch, [
CURLOPT_URL => 'https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25',
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('SYNTEXT_TOKEN'),
],
]);
$response = curl_exec($ch);
if ($response === false) {
throw new RuntimeException(curl_error($ch));
}
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
curl_close($ch);
echo $status, PHP_EOL, $response, PHP_EOL;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25"))
.header("Authorization", "Bearer " + System.getenv("SYNTEXT_TOKEN"))
.GET()
.build();
HttpResponse<String> response = HttpClient.newHttpClient()
.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
using System.Net.Http;
using System.Text;
using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/audit-log?resource=api_key&limit=25");
request.Headers.TryAddWithoutValidation("Authorization", "Bearer " + Environment.GetEnvironmentVariable("SYNTEXT_TOKEN"));
using var response = await client.SendAsync(request);
Console.WriteLine((int)response.StatusCode);
Console.WriteLine(await response.Content.ReadAsStringAsync());
Responseapplication/json
json
{
"data": [
{
"id": "log_9f2c1e",
"action": "api_key.created",
"actor": { "id": "usr_1", "name": "Jane Doe", "email": "jane@example.com" },
"resource": { "type": "api_key", "id": "key_42", "name": "CI Key" },
"metadata": { "name": "CI Key", "scope": "build", "ip": "203.0.113.24" },
"ipAddress": "203.0.113.24",
"createdAt": "2026-07-12T09:30:00.000Z"
}
],
"hasMore": false,
"total": 1
}