list-executions
Retrieve and filter workflow executions from your n8n instance to monitor performance and troubleshoot issues.
Instructions
Retrieve all executions from your instance with optional filtering.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| clientId | Yes | ||
| includeData | No | ||
| status | No | ||
| workflowId | No | ||
| limit | No |
Implementation Reference
- src/index.ts:1591-1627 (handler)The main handler for the 'list-executions' tool within the CallToolRequestSchema handler. It retrieves the N8nClient instance and calls getExecutions method with provided parameters, returning the list of executions or an error.
case "list-executions": { const { clientId, includeData, status, workflowId, limit } = args as { clientId: string; includeData?: boolean; status?: 'error' | 'success' | 'waiting'; workflowId?: string; limit?: number; }; const client = clients.get(clientId); if (!client) { return { content: [{ type: "text", text: "Client not initialized. Please run init-n8n first.", }], isError: true }; } try { const executions = await client.getExecutions({ includeData, status, workflowId, limit }); return { content: [{ type: "text", text: JSON.stringify(executions.data, null, 2), }] }; } catch (error) { return { content: [{ type: "text", text: error instanceof Error ? error.message : "Unknown error occurred", }], isError: true }; } } - src/index.ts:690-707 (registration)Registration of the 'list-executions' tool in the ListToolsRequestSchema handler, including its name, description, and input schema.
{ name: "list-executions", description: "Retrieve all executions from your instance with optional filtering.", inputSchema: { type: "object", properties: { clientId: { type: "string" }, includeData: { type: "boolean" }, status: { type: "string", enum: ["error", "success", "waiting"] }, workflowId: { type: "string" }, limit: { type: "number" } }, required: ["clientId"] } }, - src/index.ts:270-283 (schema)The getExecutions method in N8nClient class, which constructs the API request parameters and calls makeRequest to fetch executions from the n8n API.
async getExecutions(options: { includeData?: boolean; status?: 'error' | 'success' | 'waiting'; workflowId?: string; limit?: number; } = {}): Promise<N8nExecutionList> { const params = new URLSearchParams(); if (options.includeData !== undefined) params.append('includeData', String(options.includeData)); if (options.status) params.append('status', options.status); if (options.workflowId) params.append('workflowId', options.workflowId); if (options.limit) params.append('limit', String(options.limit)); return this.makeRequest<N8nExecutionList>(`/executions?${params.toString()}`); } - src/index.ts:61-77 (schema)TypeScript interfaces defining the structure of N8nExecution and N8nExecutionList used by the list-executions tool.
interface N8nExecution { id: number; data?: any; finished: boolean; mode: string; retryOf?: number; retrySuccessId?: number; startedAt: string; stoppedAt?: string; workflowId: number; waitTill?: string; } interface N8nExecutionList { data: N8nExecution[]; nextCursor?: string; }