--- updatedAt: 2025-05-14T20:41:57.000Z agentTools: siteIndex: https://developers.klaxoon.com/llms.txt projectIndex: https://developers.klaxoon.com/klaxoon/llms.txt --- # Get audit logs Retrieves audit logs for your organization ## Guide Usage examples can be found on our [Calling the Audit Log API](/docs/auditlog-examples) guide ### Required scope [ auditlog:read](/docs/scopes) # OpenAPI definition ```json { "openapi": "3.0.3", "info": { "contact": { "email": "contact@klaxoon.com" }, "description": "API for Audit", "title": "Audit", "version": "1.0" }, "components": { "securitySchemes": { "oauth2": { "flows": {}, "type": "oauth2" } }, "schemas": { "V1AuditLogsResponse": { "additionalProperties": false, "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "format": "uuid", "description": "Audit Log ID", "type": "string", "example": "0651b6d9-0a15-4658-b372-dee5ab67ec71" }, "actionDate": { "format": "date-time", "description": "Date and time when the action occurred", "type": "string", "example": "2022-06-20T20:20:20.123Z" }, "action": { "description": "Type of action performed", "maxLength": 255, "type": "string", "example": "ORGANIZATION_INVITATION_ACCESS_RESTRICTED" }, "author": { "type": "object", "properties": { "id": { "description": "ID of the author", "anyOf": [ { "format": "uuid", "type": "string", "example": "8e04eacd-cf33-42b8-85d7-7340f9a2bca8" }, { "type": "number", "example": 1000 }, { "type": "string", "enum": [ "ANONYMOUS" ] }, { "description": "Service Id", "maxLength": 255, "type": "string" } ] }, "type": { "description": "Type of the author", "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "USER" ] }, { "type": "string", "enum": [ "ORGANIZATION" ] }, { "type": "string", "enum": [ "COMPANY" ] } ] }, { "type": "string", "enum": [ "SERVICE" ] } ], "example": "USER" }, "email": { "format": "email", "description": "Email address of the author", "type": "string", "example": "johndoe@company.com" }, "companyId": { "description": "Company ID of the author", "format": "uuid", "type": "string", "example": "0913eaf2-c834-4d62-8794-c5f83a13e45e" }, "companyName": { "description": "Company name of the author", "type": "string", "example": "The author company" }, "ipAddress": { "description": "IP address of the original HTTP Request", "type": "string", "example": "0.0.0.1" }, "requestId": { "description": "ID of the original HTTP request", "maxLength": 255, "type": "string", "example": "ea7670be-c3bd-4a00-8dc2-a249719ebc7c" }, "userAgent": { "description": "User agent of the original HTTP Request", "maxLength": 255, "type": "string", "example": "Mozilla/5.0 (X11; Linux x86_64; rv:101.0) Gecko/20100101 Firefox/101.0" }, "isExternal": { "description": "True if the author does not belong to your organization", "type": "boolean" } }, "required": [ "id", "type", "isExternal" ] }, "affected": { "type": "object", "properties": { "id": { "description": "ID of the affected", "anyOf": [ { "format": "uuid", "type": "string", "example": "965f7af5-5351-4042-a56a-1964fe2946b0" }, { "type": "number", "example": 1000 } ] }, "type": { "description": "Type of the affected", "maxLength": 255, "type": "string", "example": "BOARD" }, "email": { "format": "email", "description": "Email address of the affected", "type": "string", "example": "jackdoe@company.com" }, "companyId": { "description": "Company ID of the affected", "format": "uuid", "type": "string", "example": "3c05e7d9-847f-4438-8d46-3f9168554d95" }, "companyName": { "description": "Company name of the affected", "type": "string", "example": "The affected company" }, "isExternal": { "description": "True if the affected does not belong to your organization", "type": "boolean" } }, "required": [ "id", "type", "isExternal" ] }, "content": { "description": "Extra details on the action", "type": "object", "additionalProperties": {}, "example": { "message": "", "url": "https://klaxoon.com" } } }, "required": [ "id", "actionDate", "action", "author", "affected" ] } }, "self": { "format": "uri", "description": "Current URL", "type": "string", "example": "https://api.klaxoon.com/v1/auditlogs?page=3" }, "first": { "format": "uri", "description": "URL to fetch for first result", "type": "string", "example": "https://api.klaxoon.com/v1/auditlogs" }, "prev": { "format": "uri", "description": "URL to fetch for previous result", "type": "string", "example": "https://api.klaxoon.com/v1/auditlogs?page=2" }, "next": { "format": "uri", "description": "URL to fetch for next result", "type": "string", "example": "https://api.klaxoon.com/v1/auditlogs?page=4" } }, "required": [ "items", "self", "first" ] }, "DatabaseSelectError": { "additionalProperties": false, "title": "Error while querying the database", "type": "object", "properties": { "detail": { "description": "Error details", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem", "type": "string" }, "title": { "type": "string", "enum": [ "Error while querying the database" ] }, "type": { "type": "string", "enum": [ "error" ] } }, "required": [ "detail", "instance", "title", "type" ] }, "TenantReferentialError": { "additionalProperties": false, "title": "Error while fetching Tenant from the repository", "type": "object", "properties": { "detail": { "description": "Error details", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem", "type": "string" }, "title": { "type": "string", "enum": [ "Error while fetching Tenant from the repository" ] }, "type": { "type": "string", "enum": [ "error" ] } }, "required": [ "detail", "instance", "title", "type" ] }, "HttpBadRequest": { "additionalProperties": false, "type": "object", "properties": { "type": { "description": "The problem type", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type", "type": "string" }, "detail": { "description": "Error details", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ] }, "HttpInternalServerError": { "additionalProperties": false, "type": "object", "properties": { "type": { "description": "The problem type", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem type", "type": "string" }, "detail": { "description": "Error details", "type": "string" }, "instance": { "description": "A URI reference that identifies the specific occurrence of the problem", "type": "string" } }, "required": [ "type", "title", "detail", "instance" ] } } }, "paths": { "/v1/auditlogs": { "get": { "operationId": "V1AuditLogGet", "summary": "Get audit logs", "tags": [ "Audit Logs" ], "description": "Retrieves audit logs for your organization", "parameters": [ { "schema": { "type": "string", "example": "ORGANIZATION_INVITATION_ACCESS_RESTRICTED" }, "example": "ORGANIZATION_INVITATION_ACCESS_RESTRICTED", "in": "query", "name": "action", "required": false, "description": "Type of action performed" }, { "schema": { "format": "date-time", "type": "string", "example": "2022-06-13T20:20:20.456Z" }, "example": "2022-06-13T20:20:20.456Z", "in": "query", "name": "from", "required": false, "description": "Return results with an earliest date of (YYYY-MM-DDTHH:mm:ss.sssZ)
If not specified then value is now minus 7 days" }, { "schema": { "format": "date-time", "type": "string", "example": "2022-06-20T20:20:20.789Z" }, "example": "2022-06-20T20:20:20.789Z", "in": "query", "name": "to", "required": false, "description": "Return results with a latest date of (YYYY-MM-DDTHH:mm:ss.sssZ)
If not specified then value is now" }, { "schema": { "default": 1, "minimum": 1, "type": "number", "example": 5 }, "example": 5, "in": "query", "name": "page", "required": false, "description": "Return results of the specified page" }, { "schema": { "default": 50, "maximum": 100, "minimum": 1, "type": "number", "example": 25 }, "example": 25, "in": "query", "name": "perPage", "required": false, "description": "Number of results per page" } ], "security": [ { "oauth2": [] } ], "responses": { "200": { "description": "Audit logs for your organization", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/V1AuditLogsResponse" } ], "description": "Audit logs for your organization" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HttpBadRequest" } ], "description": "Bad request" } } } }, "500": { "description": "Unhandled Error", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/HttpInternalServerError" } ], "description": "Unhandled Error" } } } }, "503": { "description": "External repository errors", "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/TenantReferentialError" }, { "$ref": "#/components/schemas/DatabaseSelectError" } ], "description": "External repository errors" } } } } } } } }, "servers": [ { "url": "https://api.klaxoon.com" } ], "tags": [ { "name": "Audit Logs" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ```