# Audit API

The **Audit API** enables you to track and retrieve activity logs across the Marketplace Platform, so you have full visibility into key actions taken by users or systems.

With this API, you can create new audit records programmatically, retrieve a list of logged events for monitoring or compliance purposes, and get detailed information about specific events. 

<a href="https://editor-next.swagger.io/?url=https://api.platform.softwareone.com/public/v1/audit/openapi.json" class="button primary">Try API</a><a href="https://api.platform.softwareone.com/public/v1/audit/openapi.json" class="button secondary">Download API</a>

## Core Concepts

The Audit API is built around the following core resources:

* **Audit record** - Represents a detailed record of an event that took place within the platform.
* **Audit event type** - Represents the event that occurred within the platform.

## Collections

The API is organized into collections, each containing a set of operations. Access to these operations varies by role, depending on whether you are a `client`, `vendor`, or `operations` user.&#x20;

Refer to the following capability matrix to see which roles are authorized to perform specific operations within each collection:

### Audit Records

<table><thead><tr><th width="251">Capability</th><th width="155">Client</th><th width="130">Vendor</th><th>Operations</th></tr></thead><tbody><tr><td>List audit records</td><td>✅ </td><td>✅</td><td>✅</td></tr><tr><td>Get audit record</td><td>✅</td><td>✅</td><td>✅</td></tr><tr><td>Create audit record</td><td>❌</td><td>✅</td><td>✅</td></tr></tbody></table>

### Audit Event Type

<table><thead><tr><th width="251">Capability</th><th width="155">Client</th><th width="130">Vendor</th><th>Operations</th></tr></thead><tbody><tr><td>List audit event types</td><td>✅</td><td>✅</td><td>✅</td></tr></tbody></table>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.platform.softwareone.com/developer-resources/rest-api/audit-api.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.