Audit Logs

List Audit Logs

get

List audit logs for the organization with keyset pagination. Audit logs provide an audit trail of significant events within Opine. Supports filtering by activity type, deal, actor user, and target user.. Requires the 'activity_logs:read' scope.

Authorizations

ApiKeyAuth

X-API-KeystringRequired

API key for authentication

Query parameters

limitnumber · min: 1 · max: 1000Optional

Number of items to return (1-1000, default 100)

Default: 100

beforestringOptional

Cursor for pagination. Use endCursor from a previous response to get the next page of older logs.

afterstringOptional

Cursor to poll for new logs. Use startCursor from a previous response to get logs created after that point.

activityTypesstringOptional

Filter by activity type(s). Accepts single value or array (activityTypes[]=TYPE1&activityTypes[]=TYPE2)

dealIdsnumberOptional

Filter by deal ID(s). Accepts single value or array (dealIds[]=1&dealIds[]=2). Invalid IDs are silently ignored.

actorUserEmailsstringOptional

Filter by actor user email(s). Accepts single value or array (actorUserEmails[]=email1&actorUserEmails[]=email2)

targetUserEmailsstringOptional

Filter by target user email(s). Accepts single value or array (targetUserEmails[]=email1&targetUserEmails[]=email2)

Responses

200

Response for status 200

application/json

startCursorstring · nullableRequired

endCursorstring · nullableRequired

hasPreviousbooleanRequired

hasMorebooleanRequired

500

An unknown error occurred, trying again might help.

application/json

get

/v1/audit-logs

HTTPcURLJavaScriptPython

GET /v1/audit-logs HTTP/1.1
Host: api.tryopine.com
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": "text",
      "type": "text",
      "occurredAt": "text",
      "createdAt": "text",
      "updatedAt": "text",
      "organizationId": 1,
      "dealId": 1,
      "evaluationId": 1,
      "actorUserId": 1,
      "targetUserId": 1,
      "modifiedTargetUserId": 1,
      "metadata": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "organization": {
        "id": 1,
        "name": "text"
      },
      "evaluation": {
        "id": 1,
        "title": "text",
        "deal": {
          "id": 1,
          "name": "text"
        }
      },
      "deal": {
        "id": 1,
        "name": "text"
      },
      "actorUser": {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "profileImageUrl": "text"
      },
      "targetUser": {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "profileImageUrl": "text"
      },
      "modifiedTargetUser": {
        "id": 1,
        "firstName": "text",
        "lastName": "text",
        "profileImageUrl": "text"
      },
      "task": {
        "id": 1,
        "title": "text",
        "type": "text"
      },
      "requirement": {
        "id": 1,
        "title": "text"
      },
      "meeting": {
        "id": 1,
        "title": "text"
      },
      "ticket": {
        "id": 1,
        "title": "text"
      },
      "teamRequest": {
        "id": 1,
        "status": "text",
        "teamRequestType": {
          "id": 1,
          "name": "text"
        }
      }
    }
  ],
  "startCursor": "text",
  "endCursor": "text",
  "hasPrevious": true,
  "hasMore": true
}