Skip to main content
GET
/
api
/
ee
/
audit
List audit records
curl --request GET \
  --url https://api.example.com/api/ee/audit \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.example.com/api/ee/audit"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.example.com/api/ee/audit', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/ee/audit",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

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

func main() {

	url := "https://api.example.com/api/ee/audit"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.example.com/api/ee/audit")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/ee/audit")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
[
  {
    "id": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "action": "<string>",
    "actorId": "<string>",
    "actorType": "<string>",
    "targetId": "<string>",
    "targetType": "<string>",
    "sourcebotVersion": "<string>",
    "metadata": {},
    "orgId": 123
  }
]
{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}
{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}
{
  "statusCode": 123,
  "errorCode": "<string>",
  "message": "<string>"
}
This API is only available with an active Sourcebot license. More information.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your API key.

Query Parameters

​
since
string<date-time>

Return records at or after this timestamp (ISO 8601).

​
until
string<date-time>

Return records at or before this timestamp (ISO 8601).

​
page
integer
default:1
Required range: x > 0
​
perPage
integer
default:50
Required range: 0 < x <= 100

Response

Paginated audit log.

​
id
string
required
​
timestamp
string<date-time>
required
​
action
string
required

The audited action (e.g. user.read, user.delete, audit.fetch).

​
actorId
string
required
​
actorType
string
required
​
targetId
string
required
​
targetType
string
required
​
sourcebotVersion
string
required
​
metadata
object | null
required
​
orgId
number
required