Get Audit Log Search Result

Retrieve a paginated list of audit logs for a specific module with optional filtering and sorting.

Endpoint

GET /dev/v1/audit/{module}/search

Get audit log search result.

URL Format

Query parameters can be appended directly to the URL as a query string.

Example: /dev/v1/audit/audit/search?pageNo=1&pageSize=5

Authentication

All endpoints require authentication via the Nected-Branch header.

Header	Type	Required	Description
Nected-API-Key	string	Yes	Your Nected API key.
Nected-Branch	string	Yes	Branch name (e.g. default branch of the workspace).

Search audit logs

get

Paginated list of audit logs for module, with optional filters (type, status, environment, user, date range) and sort (default date:-1).

200 body: code, message, pageNo, pageSize, totalCount, totalPages, and data as an array of AuditLogEntry.

Example: capturedSearch → examples/audit_search_200.json (canonical Get/GET_SEARCH.json).

Authorizations

DevAuth

Nected-API-KeystringRequired

Dev API key (Nected-API-Key header)

Path parameters

modulestringRequired

Module name (audited area).

Query parameters

typestringOptional

Type of audit log (optional).

statusstringOptional

Status filter (optional).

sortstringOptional

Sort order (optional, default date:-1).

Default: date:-1

environmentstringOptional

Environment filter (optional).

userstringOptional

User who performed the action (optional).

startDatestringOptional

Start of date range (ISO format, optional).

endDatestringOptional

End of date range (ISO format, optional).

pageNointegerOptional

Page number (optional, default 1).

Default: 1

pageSizeinteger · max: 10Optional

Page size (optional, default 10, max 10).

Default: 10

Header parameters

Nected-BranchstringRequired

Branch name (e.g. default branch). Required for audit endpoints.

Responses

200

OK — paginated audit entries.

application/json

Search result; data is an array of audit log entries

codestringOptional

messagestringOptional

pageNointegerOptional

pageSizeintegerOptional

totalCountintegerOptional

totalPagesintegerOptional

401

Unauthorized

application/json

500

Internal Server Error

application/json

get

/dev/v1/audit/{module}/search

HTTPcURLJavaScriptPython

GET /dev/v1/audit/{module}/search HTTP/1.1
Host: api.nected.ai
Nected-API-Key: YOUR_API_KEY
Nected-Branch: text
Accept: */*

No content

Path Parameters

Parameter	Type	Required	Description
module	string	Yes	Module name

Query Parameters

Parameter	Type	Required	Default	Description
type	string	No	-	Type of audit log
status	string	No	-	Status of audit log
sort	string	No	date:-1	Sort order for audit logs
environment	string	No	-	Environment of audit log
user	string	No	-	User who performed the action
startDate	string	No	-	Start date for filtering (ISO format)
endDate	string	No	-	End date for filtering (ISO format)
pageNo	integer	No	1	Page number to retrieve
pageSize	integer	No	10	Number of records per page (max: 10)

---

Response

Status Code: 200 OK

{
  "code": "",
  "data": [
    {
      "branchName": "string",
      "date": "string",
      "entityId": "string",
      "environment": "string",
      "event": "string",
      "executionId": "string",
      "executionTime": "string",
      "input": "string",
      "ip": "string",
      "logId": "string",
      "message": "string",
      "name": "string",
      "output": "string",
      "path": [
        {
          "entity": "string",
          "entityId": "string",
          "entityType": "string",
          "executionId": "string",
          "name": "string",
          "version": "string"
        }
      ],
      "rootNode": {
        "id": "string",
        "logId": "string",
        "name": "string"
      },
      "signed": true,
      "status": "string",
      "traceId": "string",
      "type": "string",
      "user": "string",
      "version": "string",
      "workspaceId": "string"
    }
  ],
  "message": "",
  "pageNo": 0,
  "pageSize": 0,
  "totalCount": 0,
  "totalPages": 0
}

---

Error Responses

401 Unauthorized

Authentication failed.

{
  "code": "",
  "data": {},
  "message": "",
  "pageNo": 0,
  "pageSize": 0,
  "totalCount": 0,
  "totalPages": 0
}

500 Internal Server Error

Server error occurred.

{
  "code": "",
  "data": {},
  "message": "",
  "pageNo": 0,
  "pageSize": 0,
  "totalCount": 0,
  "totalPages": 0
}

---

Data Models

Audit Log Entry

Field	Type	Description
logId	string	Unique identifier for the audit log entry
branchName	string	Branch name associated with the log
date	string	Timestamp of the action
entityId	string	ID of the entity that was modified
environment	string	Environment where the action occurred
event	string	Type of event that occurred
executionId	string	ID of the execution
executionTime	string	Time taken for execution
input	string	Input data for the action
ip	string	IP address of the user
message	string	Descriptive message about the action
name	string	Name of the audit log entry
output	string	Output data from the action
path	array	Array of path objects showing the execution path
rootNode	object	Root node information with id, logId, and name
signed	boolean	Whether the log entry is signed
status	string	Status of the action
traceId	string	Trace ID for tracking
type	string	Type of audit log
user	string	User who performed the action
version	string	Version information
workspaceId	string	Workspace identifier

Path Object

Field	Type	Description
entity	string	Entity name
entityId	string	Entity identifier
entityType	string	Type of entity
executionId	string	Execution identifier
name	string	Name of the path element
version	string	Version of the path element

Root Node Object

Field	Type	Description
id	string	Root node identifier
logId	string	Log identifier
name	string	Root node name

---

Example Usage

curl -X GET "{{NECTED_BASE_URL}}/dev/v1/audit/workflows/search?type=execution&status=success&pageNo=1&pageSize=10" \
  -H "Nected-Branch: {Default Branch of the workspace}"

---

Reference

Reference: Try this endpoint in Swagger UI.