Audit Log

Our new Audit Log API endpoint is now generally available. This endpoint is designed to offer enhanced performance, advanced features, and greater scalability to better meet the needs of our users.

The legacy Audit API will be deprecated in September 2024. To ensure uninterrupted service and to take advantage of the enhanced features, we strongly encourage all customers to migrate to the new Audit Log API endpoint as soon as possible. For any questions or feedback, reach out to our team at product-feedback@outreach.io.

action
string <= 255 characters

The action taken.

additionalInfo
Array of objects

Additional information related to the action.

agent
object

Details about the agent involved in the action.

changes
Array of objects

The list of changes made.

eventName
string <= 255 characters

Audit event name.

globalId
string <= 36 characters

The global UUID.

orgId
string <= 36 characters

The orgId UUID.

requestId
string <= 36 characters

The UUID of the request. RequestId groups dependent events.

result
string <= 255 characters

The result of the action.

timestamp
string <date-time>

The timestamp of the action.

{
}

Audit Log Custom Filters

NAME VALUE TYPE VALUE KIND VALUE LENGTH
agentEmail string single N/A
agentIpAddress string single N/A

⌵ Audit Log Actions

Get a Collection of Audit Logs

SecuritybearerAuth
Responses
200

OK

422

JSON error message

get/auditLogs
Request samples 
Response samples 
application/vnd.api+json
{
}