Skip to main content
GET
/
api
/
audit-logs
List audit logs
curl --request GET \
  --url https://api.example.com/api/audit-logs \
  --header 'Authorization: Bearer <token>'
{
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "<string>",
      "type": "organisation",
      "action": "<string>",
      "ipAddress": "<string>",
      "userAgent": "<string>",
      "refId": "<string>",
      "user": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "email": "[email protected]",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "project": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>"
      }
    }
  ],
  "paginate": {
    "current": 123,
    "from": 123,
    "to": 123,
    "total": 123,
    "pageSize": 123
  }
}

Authorizations

Authorization
string
header
required

Personal access token is obtained through your profile

Query Parameters

projectId
string<uuid>

Filter by project ID

userId
string<uuid>

Filter by user ID

fromDate
string

Filter entries from this date (inclusive)

toDate
string

Filter entries until this date (inclusive)

type
enum<string>

Filter by audit log type

Available options:
organisation,
user,
group,
accessToken,
project,
document,
release,
member,
personalAccessToken
action
string

Filter by action name

orderBy
string

Field to order results by

sort
string

Sort direction (ASC or DESC)

page
number
default:1

Current page

perPage
number
default:10

Number of items per page

Response

200 - application/json

Paginated list of audit logs

Paginated list of audit logs

results
object[]
required

List of audit log entries

paginate
object
required

Pagination metadata