Audit Logs

Search Audit Logs

Returns the activity of a workspace, newest first, one page at a time. Available on the Enterprise plan to workspace owners and admins.

POST/workspaces/{workspaceId}/audit-logs/search

Request

curl --request POST \
  --url 'https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search' \
  --header 'Softr-Api-Key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "entityTypes": [
    "APP"
  ],
  "userIds": [
    "<string>"
  ],
  "entityIds": {
    "APP": [
      "3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c"
    ]
  },
  "startDate": "2026-11-01T00:00:00Z",
  "endDate": "2026-11-02T00:00:00Z",
  "cursor": "<string>",
  "size": 50
}'

import json
import requests

url = "https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search"
headers = {
  "Softr-Api-Key": "<api-key>",
  "Content-Type": "application/json"
}
payload = json.loads("{\"entityTypes\":[\"APP\"],\"userIds\":[\"<string>\"],\"entityIds\":{\"APP\":[\"3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c\"]},\"startDate\":\"2026-11-01T00:00:00Z\",\"endDate\":\"2026-11-02T00:00:00Z\",\"cursor\":\"<string>\",\"size\":50}")

response = requests.request("POST", url, headers=headers, json=payload)
print(response.json())

const response = await fetch("https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search", {
  method: "POST",
  headers: {
    "Softr-Api-Key": "<api-key>",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "entityTypes": [
      "APP"
    ],
    "userIds": [
      "<string>"
    ],
    "entityIds": {
      "APP": [
        "3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c"
      ]
    },
    "startDate": "2026-11-01T00:00:00Z",
    "endDate": "2026-11-02T00:00:00Z",
    "cursor": "<string>",
    "size": 50
  }),
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Softr-Api-Key: <api-key>",
    "Content-Type: application/json",
]);
curl_setopt($client, CURLOPT_POSTFIELDS, "{\"entityTypes\":[\"APP\"],\"userIds\":[\"<string>\"],\"entityIds\":{\"APP\":[\"3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c\"]},\"startDate\":\"2026-11-01T00:00:00Z\",\"endDate\":\"2026-11-02T00:00:00Z\",\"cursor\":\"<string>\",\"size\":50}");
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "bytes"
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("POST", "https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search", bytes.NewBuffer([]byte("{\"entityTypes\":[\"APP\"],\"userIds\":[\"<string>\"],\"entityIds\":{\"APP\":[\"3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c\"]},\"startDate\":\"2026-11-01T00:00:00Z\",\"endDate\":\"2026-11-02T00:00:00Z\",\"cursor\":\"<string>\",\"size\":50}")))
  req.Header.Set("Softr-Api-Key", "<api-key>")
  req.Header.Set("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search"))
    .header("Softr-Api-Key", "<api-key>")
    .header("Content-Type", "application/json")
    .method("POST", HttpRequest.BodyPublishers.ofString("{\"entityTypes\":[\"APP\"],\"userIds\":[\"<string>\"],\"entityIds\":{\"APP\":[\"3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c\"]},\"startDate\":\"2026-11-01T00:00:00Z\",\"endDate\":\"2026-11-02T00:00:00Z\",\"cursor\":\"<string>\",\"size\":50}"))
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search")
request = Net::HTTP::Post.new(uri)
request["Softr-Api-Key"] = "<api-key>"
request["Content-Type"] = "application/json"
request.body = "{\"entityTypes\":[\"APP\"],\"userIds\":[\"<string>\"],\"entityIds\":{\"APP\":[\"3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c\"]},\"startDate\":\"2026-11-01T00:00:00Z\",\"endDate\":\"2026-11-02T00:00:00Z\",\"cursor\":\"<string>\",\"size\":50}"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "entries": [
    {
      "id": "c4e8a1d2-6b3f-4f9a-a7e5-2d1c0b9a8f7e",
      "entityType": "APP",
      "entityId": "3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c",
      "entityName": "Client Portal",
      "entityDeleted": false,
      "action": "APP_PUBLISHED",
      "userId": "7a2b9c4d-1e3f-4a5b-8c6d-9e0f1a2b3c4d",
      "userName": "Ada Lovelace",
      "userEmail": "ada@example.com",
      "details": null,
      "createdAt": "2026-11-02T14:03:27Z"
    }
  ],
  "cursor": "eyJhcHAiOnsiY3JlYXRlZEF0IjoiMjAyNi0xMS0wMlQxNDowMzoyN1oifX0",
  "hasMore": true
}

{
  "code": "Bad Request",
  "message": "userIds must not exceed 50 values"
}

{
  "code": "Unauthorized",
  "message": "Invalid API key."
}

{
  "code": "Forbidden",
  "message": "Only workspace owners and admins can read the audit log."
}

{
  "code": "Too many requests",
  "message": "Request limit exceeded!"
}

{
  "code": "Service Unavailable",
  "message": "Some audit log activity is temporarily unavailable. Retry the request with the same cursor."
}

Returns the activity of a workspace, newest first. Send the cursor from a response to get the next page, until hasMore is false. See the Audit Logs API overview for the token it needs, paging, polling and the actions per entity type.

Authorizations

Softr-Api-KeyAPI keyin headerrequired

Path parameters

workspaceIdstringrequired

The workspace ID. Get Databases returns it as workspaceId on every database.

Body

application/json

entityTypesenum<string>[]

Return only these entity types. Empty or missing means all of them.

userIdsstring[]items: ≤ 50 items

Return only activity by these users. At most 50 ids.

entityIdsRecord<string, string[]>

Return only activity on these entities, keyed by entity type. At most 50 ids per type.

startDatestring<date-time>

Return only activity at or after this time (ISO 8601, inclusive).

endDatestring<date-time>

Return only activity at or before this time (ISO 8601, inclusive).

cursorstring

The cursor from the previous page. Leave it out for the first page. Keep the other fields the same while you page.

sizeintegerdefault: 50range: 1–50

Entries per page. Values above 50 are lowered to 50.

Response

application/json

A page of audit log entries.

entriesobject[]

Newest first.

Show child attributes

entries.idstring

The entry ID.

entries.entityTypeenum<string>one of: APP, DATABASE, WORKSPACE, WORKFLOW, AGENT, INTEGRATION

The kind of thing the activity happened to.

entries.entityIdstring

The ID of the app, database, workflow, agent, integration or workspace.

entries.entityNamestring | null

The name of the entity.

entries.entityDeletedboolean

true when the entity no longer exists.

entries.actionstring

What happened, for example APP_PUBLISHED, TABLE_CREATED or WORKFLOW_DISABLED. See the overview for the actions per entity type. New values can appear at any time.

entries.userIdstring | null

The ID of the user who did it.

entries.userNamestring | null

The user's name.

entries.userEmailstring | null

The user's email.

entries.detailsRecord<string, unknown>

Extra information about the activity. Its shape depends on the action.

entries.createdAtstring<date-time>

When it happened (ISO 8601, UTC).

cursorstring | null

Pass it back to get the next page. null on the last page.

hasMoreboolean

true when more entries exist after this page.

curl --request POST \ --url 'https://studio-api.softr.io/v1/api/workspaces/<workspaceId>/audit-logs/search' \ --header 'Softr-Api-Key: <api-key>' \ --header 'Content-Type: application/json' \ --data '{ "entityTypes": [ "APP" ], "userIds": [ "<string>" ], "entityIds": { "APP": [ "3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c" ] }, "startDate": "2026-11-01T00:00:00Z", "endDate": "2026-11-02T00:00:00Z", "cursor": "<string>", "size": 50 }'

{ "entries": [ { "id": "c4e8a1d2-6b3f-4f9a-a7e5-2d1c0b9a8f7e", "entityType": "APP", "entityId": "3f1c2a9e-8b4d-4e7a-9c21-5d6e7f8a9b0c", "entityName": "Client Portal", "entityDeleted": false, "action": "APP_PUBLISHED", "userId": "7a2b9c4d-1e3f-4a5b-8c6d-9e0f1a2b3c4d", "userName": "Ada Lovelace", "userEmail": "ada@example.com", "details": null, "createdAt": "2026-11-02T14:03:27Z" } ], "cursor": "eyJhcHAiOnsiY3JlYXRlZEF0IjoiMjAyNi0xMS0wMlQxNDowMzoyN1oifX0", "hasMore": true }

Search Audit Logs

Authorizations

Path parameters

Body

Response

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown