---
updatedAt: 2026-05-12T09:59:18.000Z
---

# Retrieve activity log

This operation returns an object that contains the activity log for the current organization.
It can be filtered by date and time, activity type, asset type, user, and vuln ID.

# OpenAPI definition

```json
{
  "components": {
    "schemas": {
      "ActivityLogClient": {
        "description": "Client holds info about the client associated with an activity record",
        "properties": {
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "name": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ActivityRecordSwagger": {
        "description": "ActivityRecordSwagger holds information about a single activity",
        "properties": {
          "assetName": {
            "type": "string"
          },
          "assetType": {
            "type": "string"
          },
          "client": {
            "$ref": "#/components/schemas/ActivityLogClient"
          },
          "id": {
            "format": "int64",
            "type": "integer"
          },
          "modifiedBy": {
            "type": "string"
          },
          "resources": {
            "additionalProperties": {
              "$ref": "#/components/schemas/Resource"
            },
            "type": "object"
          },
          "time": {
            "format": "int64",
            "type": "integer"
          },
          "type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "ErrorMessage": {
        "description": "ErrorMessage describes the error",
        "properties": {
          "code": {
            "format": "int64",
            "type": "integer"
          },
          "reason": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "Resource": {
        "description": "Resource is a tuple holding info associated with an activity record\nthat will be used to build the user visible info about that activity",
        "properties": {
          "string": {
            "type": "string"
          },
          "value": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "activityLogPageData": {
        "properties": {
          "filteredCount": {
            "format": "int64",
            "type": "integer"
          },
          "totalCount": {
            "format": "int64",
            "type": "integer"
          }
        },
        "type": "object"
      },
      "activityLogSwagger": {
        "properties": {
          "collection": {
            "items": {
              "$ref": "#/components/schemas/ActivityRecordSwagger"
            },
            "type": "array"
          },
          "page": {
            "$ref": "#/components/schemas/activityLogPageData"
          }
        },
        "type": "object"
      }
    }
  },
  "info": {
    "license": {
      "name": "(c) Copyright 2020 WhiteHat Security"
    },
    "title": "Activity Log API",
    "version": "2.0.0"
  },
  "openapi": "3.0.1",
  "paths": {
    "/api/activityLog": {
      "get": {
        "description": "This operation returns an object that contains the activity log for the current organization.\nIt can be filtered by date and time, activity type, asset type, user, and vuln ID.",
        "operationId": "activityLog",
        "parameters": [
          {
            "description": "Offset begin showing results from item number n.",
            "in": "query",
            "name": "offset",
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "Offset"
            },
            "x-go-name": "Offset"
          },
          {
            "description": "Limit results to n number of items.\nUse a 0 value to indicate that all results should be returned",
            "in": "query",
            "name": "limit",
            "schema": {
              "format": "int64",
              "type": "integer",
              "x-go-name": "Limit"
            },
            "x-go-name": "Limit"
          },
          {
            "description": "Sort order results by the given field.\nPrefix the field name with '-' to order in descending order.\nE.g., '-time' sorts results in descending order using the  field 'time'",
            "in": "query",
            "name": "sort",
            "schema": {
              "type": "string",
              "x-go-name": "Sort"
            },
            "x-go-name": "Sort"
          },
          {
            "description": "Filter results from that date",
            "in": "query",
            "name": "dateStart",
            "schema": {
              "format": "date-time",
              "type": "string",
              "x-go-name": "DateStart"
            },
            "x-go-name": "DateStart"
          },
          {
            "description": "Filter results to that date",
            "in": "query",
            "name": "dateEnd",
            "schema": {
              "format": "date-time",
              "type": "string",
              "x-go-name": "DateEnd"
            },
            "x-go-name": "DateEnd"
          },
          {
            "description": "Filter results to activities with particular activity type(s)\n<b>Example to fetch activities with these two types:</b>\nactivityType=vulnerability_opened,scan_completed",
            "explode": false,
            "in": "query",
            "name": "activityType",
            "schema": {
              "items": {
                "type": "string"
              },
              "type": "array",
              "x-go-name": "ActivityType"
            },
            "style": "form"
          },
          {
            "description": "Filter results to activities related to the chosen asset type (i.e. \"site\", \"application\", \"mobile_application\" and \"api_site\")",
            "in": "query",
            "name": "assetType",
            "schema": {
              "type": "string",
              "x-go-name": "AssetType"
            },
            "x-go-name": "AssetType"
          },
          {
            "description": "Filter results to this modified by value",
            "in": "query",
            "name": "modifiedBy",
            "schema": {
              "type": "string",
              "x-go-name": "ModifiedBy"
            },
            "x-go-name": "ModifiedBy"
          },
          {
            "description": "Filter activities to those related with a specific vuln (via vuln_id)",
            "explode": false,
            "in": "query",
            "name": "vulnID",
            "schema": {
              "items": {
                "format": "int64",
                "type": "integer"
              },
              "type": "array",
              "x-go-name": "VulnID"
            },
            "style": "form"
          }
        ],
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/activityLogSwagger"
                }
              }
            },
            "description": "ActivityLogResponse provides a log of activities"
          },
          "400": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ErrorMessage"
                }
              }
            },
            "description": "BadRequestResponse indicates a request with invalid parameters"
          },
          "401": {
            "description": "UnauthorizedResponse signals an unauthorized API access"
          },
          "403": {
            "description": "ForbiddenResponse signals a request for a resource that does not exist or is not authorized"
          },
          "500": {
            "description": "GenericError generic error"
          }
        },
        "summary": "Retrieve activity log",
        "tags": [
          "Activity Log API v2.0"
        ]
      }
    }
  },
  "servers": [
    {
      "url": "https://sentinel.whitehatsec.com/"
    }
  ],
  "tags": [
    {
      "name": "Activity Log API v2.0"
    }
  ],
  "x-explorer-enabled": false,
  "x-readme": {
    "proxy-enabled": true
  }
}
```