--- title: "List Audit Log" method: POST path: "/audit-log/get-list" tags: ["Audit Log"] --- # List Audit Log `POST /audit-log/get-list` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/audit-log/get-list` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to list all Audit Log items ## Request body - object - `query` AuditLogV2QuerySchema: Query schema for AuditLogV2. A field takes a plain value, which it matches exactly, or an operator its type allows. Telemetry tables are large: bound every query by createdAt. - `projectId` union: Query operators for projectId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `resourceType` union: Query operators for resourceType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `resourceId` union: Query operators for resourceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `resourceName` union: Query operators for resourceName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `rootResourceType` union: Query operators for rootResourceType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `rootResourceId` union: Query operators for rootResourceId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `action` union: Query operators for action field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `userId` union: Query operators for userId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `userName` union: Query operators for userName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `userEmail` union: Query operators for userEmail field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `userType` union: Query operators for userType field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `apiKeyId` union: Query operators for apiKeyId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `apiKeyName` union: Query operators for apiKeyName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `mcpOAuthGrantId` union: Query operators for mcpOAuthGrantId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `mcpClientName` union: Query operators for mcpClientName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `workflowId` union: Query operators for workflowId field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `workflowName` union: Query operators for workflowName field of type Text. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes, EqualToOrNull, Search. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - object - `_type` 'EqualToOrNull', required - `value` string, required - object - `_type` 'Search', required - `value` string, required - `changes` union: Query operators for changes field of type JSON Array. Supported operators: IsNull, NotNull. - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - `_id` union: Query operators for _id field of type Object ID. Supported operators: EqualTo, NotEqual, IsNull, NotNull, Includes. - string - object - `_type` 'NotEqual', required - `value` string, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'Includes', required - `value` string[], required - `createdAt` union: Query operators for createdAt field of type Date. Supported operators: EqualTo, NotEqual, IsNull, NotNull, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual, InBetween. Times are ISO-8601, such as 2026-01-01T00:00:00.000Z. - string, date-time - object - `_type` 'NotEqual', required - `value` string, date-time, required - object - `_type` 'IsNull', required - object - `_type` 'NotNull', required - object - `_type` 'GreaterThan', required - `value` string, date-time, required - object - `_type` 'GreaterThanOrEqual', required - `value` string, date-time, required - object - `_type` 'LessThan', required - `value` string, date-time, required - object - `_type` 'LessThanOrEqual', required - `value` string, date-time, required - object - `_type` 'InBetween', required - `startValue` string, date-time, required - `endValue` string, date-time, required - `select` AuditLogV2SelectSchema: Select schema for AuditLogV2. Set fields to true to include them in the response. - `projectId` boolean - `resourceType` boolean - `resourceId` boolean - `resourceName` boolean - `rootResourceType` boolean - `rootResourceId` boolean - `action` boolean - `userId` boolean - `userName` boolean - `userEmail` boolean - `userType` boolean - `apiKeyId` boolean - `apiKeyName` boolean - `mcpOAuthGrantId` boolean - `mcpClientName` boolean - `workflowId` boolean - `workflowName` boolean - `changes` boolean - `_id` boolean - `createdAt` boolean - `sort` AuditLogV2SortSchema: Sort schema for AuditLogV2. Only sortable fields are included. - `projectId` 'ASC' | 'DESC': Sort order for projectId field - `resourceType` 'ASC' | 'DESC': Sort order for resourceType field - `resourceId` 'ASC' | 'DESC': Sort order for resourceId field - `resourceName` 'ASC' | 'DESC': Sort order for resourceName field - `rootResourceType` 'ASC' | 'DESC': Sort order for rootResourceType field - `rootResourceId` 'ASC' | 'DESC': Sort order for rootResourceId field - `action` 'ASC' | 'DESC': Sort order for action field - `userId` 'ASC' | 'DESC': Sort order for userId field - `userName` 'ASC' | 'DESC': Sort order for userName field - `userEmail` 'ASC' | 'DESC': Sort order for userEmail field - `userType` 'ASC' | 'DESC': Sort order for userType field - `apiKeyId` 'ASC' | 'DESC': Sort order for apiKeyId field - `apiKeyName` 'ASC' | 'DESC': Sort order for apiKeyName field - `mcpOAuthGrantId` 'ASC' | 'DESC': Sort order for mcpOAuthGrantId field - `mcpClientName` 'ASC' | 'DESC': Sort order for mcpClientName field - `workflowId` 'ASC' | 'DESC': Sort order for workflowId field - `workflowName` 'ASC' | 'DESC': Sort order for workflowName field - `retentionDate` 'ASC' | 'DESC': Sort order for retentionDate field - `_id` 'ASC' | 'DESC': Sort order for _id field - `createdAt` 'ASC' | 'DESC': Sort order for createdAt field - `groupBy` AuditLogV2GroupBySchema: Group by schema for AuditLogV2. Only one field can be set to true for grouping. - `projectId` boolean: Group by projectId field. Only one field can be selected for grouping. - `resourceType` boolean: Group by resourceType field. Only one field can be selected for grouping. - `resourceId` boolean: Group by resourceId field. Only one field can be selected for grouping. - `resourceName` boolean: Group by resourceName field. Only one field can be selected for grouping. - `rootResourceType` boolean: Group by rootResourceType field. Only one field can be selected for grouping. - `rootResourceId` boolean: Group by rootResourceId field. Only one field can be selected for grouping. - `action` boolean: Group by action field. Only one field can be selected for grouping. - `userId` boolean: Group by userId field. Only one field can be selected for grouping. - `userName` boolean: Group by userName field. Only one field can be selected for grouping. - `userEmail` boolean: Group by userEmail field. Only one field can be selected for grouping. - `userType` boolean: Group by userType field. Only one field can be selected for grouping. - `apiKeyId` boolean: Group by apiKeyId field. Only one field can be selected for grouping. - `apiKeyName` boolean: Group by apiKeyName field. Only one field can be selected for grouping. - `mcpOAuthGrantId` boolean: Group by mcpOAuthGrantId field. Only one field can be selected for grouping. - `mcpClientName` boolean: Group by mcpClientName field. Only one field can be selected for grouping. - `workflowId` boolean: Group by workflowId field. Only one field can be selected for grouping. - `workflowName` boolean: Group by workflowName field. Only one field can be selected for grouping. - `_id` boolean: Group by _id field. Only one field can be selected for grouping. - `createdAt` boolean: Group by createdAt field. Only one field can be selected for grouping. - `limit` number: Maximum number of items to return. Defaults to 10. - `skip` number: Number of items to skip for pagination. Defaults to 0. ## Response `200` Successful response - object - `data` AuditLogV2[] - `projectId` string, required: Project ID - `resourceType` string, required: Resource Type - `resourceId` string, required: Resource ID - `resourceName` string: Resource Name - `rootResourceType` string: Root Resource Type - `rootResourceId` string: Root Resource ID - `action` string, required: Action - `userId` string: User ID - `userName` string: User Name - `userEmail` string: User Email - `userType` string: User Type - `apiKeyId` string: API Key ID - `apiKeyName` string: API Key Name - `mcpOAuthGrantId` string: MCP Client Authorization ID - `mcpClientName` string: MCP Client Name - `workflowId` string: Workflow ID - `workflowName` string: Workflow Name - `changes` object[]: Changes - `count` number ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)