> ## Documentation Index > Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt > Use this file to discover all available pages before exploring further. # List automations > List automations. ## OpenAPI ````yaml /en/automations-api/api-reference/openapi-automations.json get /v1/automations openapi: 3.0.3 info: title: 'Notifique API v1: Automations and events' version: 1.0.0 description: >- Definition of **events** (name + optional `payload` schema), **automations** as a graph (trigger by event or **inbound message** on a channel, delays, conditions, including **`source: "message"`** on inbound, **`endFlow`** to end a branch, multi-channel sends, contact updates, etc.) and **trigger** via `POST /v1/events/send`. Auth: `Authorization: Bearer sk_live_...` or `x-api-key` header. All bodies use **camelCase**. **Scopes:** `events:read` | `events:write` | `automations:read` | `automations:write`. Send steps (`sendTemplate`, direct emails, etc.) still require the matching channel send keys. **Pagination:** query `page` (≥1, default 1) and `limit` (1 to 100, default 20), as strings or coherent numbers. **Blocked workspace** returns **402** with `Payment Required`. **Onboarding:** on any `/v1` route, if onboarding is incomplete, middleware returns **403** with `code: ONBOARDING_REQUIRED` (body similar to other 403s). **Escopos adicionais:** `assistants:read` | `assistants:write` | `assistants:invoke` | `knowledge_bases:read` | `knowledge_bases:write` | `mcp_connections:read` | `mcp_connections:write` | `http_tools:read` | `http_tools:write`. servers: - url: https://api.notifique.dev description: Production security: - ntfAutoBearerAuth: [] - ntfAutoApiKeyHeader: [] tags: - name: Eventos description: CRUD de definições de evento + disparo `POST /v1/events/send`. - name: Automações description: CRUD de automações, stop e listagem de runs. - name: Runs description: Histórico e detalhe de execuções (`AutomationRun` + passos). - name: Assistentes description: CRUD de WorkspaceAssistant, invoke de teste e bindings MCP/HTTP. - name: Bases de conhecimento description: CRUD de bases RAG e documentos. - name: MCP description: Conexões MCP do workspace (CUSTOM_URL via API; OAuth curado no painel). - name: HTTP tools description: Ferramentas REST allowlist para assistentes. - name: Inbox description: Unified conversations and metrics (premium feature). paths: /v1/automations: get: tags: - Automações summary: List automations description: List automations. operationId: ntfAuto_listAutomations parameters: - name: page in: query schema: type: string - name: limit in: query schema: type: string responses: '200': $ref: '#/components/responses/NtfAuto_AutomationList200' content: application/json: schema: $ref: '#/components/schemas/ntfAuto_ListAutomationsResponse' '401': $ref: '#/components/responses/NtfAuto_401' '402': $ref: '#/components/responses/NtfAuto_402' '403': $ref: '#/components/responses/NtfAuto_403AutomationsRead' components: responses: NtfAuto_AutomationList200: description: Lista resumida (sem `graphJson`). content: application/json: schema: $ref: '#/components/schemas/NtfAuto_AutomationListResponse' example: success: true data: items: - id: clxx... name: Exemplo status: ENABLED triggerEventName: string graphVersion: 1 createdAt: '2025-02-10T14:00:00.000Z' updatedAt: '2025-02-10T14:00:00.000Z' triggerKind: EVENT triggerChannel: WHATSAPP triggerInstanceId: clxx... triggerAiWebWidgetId: clxx... page: 1 limit: 1 total: 1 NtfAuto_401: description: >- Chave ausente ou inválida. No middleware global de `/v1` também ocorre quando não há API Key. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorEnvelope401' examples: route: value: success: false error: Unauthorized message: Invalid or missing API Key code: UNAUTHORIZED middleware: value: success: false error: Unauthorized message: >- API Key is required. Provide Authorization: Bearer or x-api-key header. code: UNAUTHORIZED NtfAuto_402: description: >- Expired plan or suspended workspace (`WORKSPACE_BLOCKED`), plan automation limit (`PLAN_LIMIT_AUTOMATIONS`), or plan/trial without balance for automations/events (`PREMIUM_FEATURE_REQUIRES_PLAN_OR_BALANCE`). content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorPaymentRequired' examples: workspaceBlocked: value: success: false error: Payment Required message: Plan expired or suspended code: WORKSPACE_BLOCKED premiumFeature: value: success: false error: Payment Required message: Premium automations require an active plan, trial, or balance code: PREMIUM_FEATURE_REQUIRES_PLAN_OR_BALANCE NtfAuto_403AutomationsRead: description: Sem escopo `automations:read`. content: application/json: schema: $ref: '#/components/schemas/NtfAuto_ErrorForbiddenScope' example: success: false error: Forbidden message: 'Missing scope: automations:read' code: FORBIDDEN schemas: ntfAuto_ListAutomationsResponse: type: object additionalProperties: false description: Resposta JSON vazia (sucesso sem payload). properties: success: type: boolean example: true example: success: true NtfAuto_AutomationListResponse: type: object required: - success - data properties: success: type: boolean enum: - true data: type: object required: - items - page - limit - total properties: items: type: array items: type: object required: - id - name - status - triggerEventName - graphVersion - createdAt - updatedAt properties: id: type: string name: type: string status: type: string enum: - ENABLED - DISABLED triggerEventName: type: string triggerKind: type: string enum: - EVENT - CHANNEL_INBOUND - WEBHOOK - WHATSAPP_CALL triggerChannel: nullable: true type: string enum: - WHATSAPP - TELEGRAM - SMS - WEB_WIDGET - INSTAGRAM triggerInstanceId: type: string nullable: true triggerAiWebWidgetId: type: string nullable: true graphVersion: type: integer createdAt: type: string format: date-time updatedAt: type: string format: date-time page: type: integer limit: type: integer total: type: integer example: success: true data: items: - id: clxx... name: Exemplo status: ENABLED triggerEventName: string graphVersion: 1 createdAt: '2025-02-10T14:00:00.000Z' updatedAt: '2025-02-10T14:00:00.000Z' triggerKind: EVENT triggerChannel: WHATSAPP triggerInstanceId: clxx... triggerAiWebWidgetId: clxx... page: 1 limit: 1 total: 1 NtfAuto_ErrorEnvelope401: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string example: Unauthorized message: type: string code: type: string example: VALIDATION_ERROR example: success: false error: Unauthorized message: string NtfAuto_ErrorPaymentRequired: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string enum: - Payment Required message: type: string example: Plan expired or suspended code: type: string enum: - WORKSPACE_BLOCKED - PLAN_LIMIT_AUTOMATIONS - PREMIUM_FEATURE_REQUIRES_PLAN_OR_BALANCE example: success: false error: Payment Required message: Plan expired or suspended code: WORKSPACE_BLOCKED NtfAuto_ErrorForbiddenScope: type: object required: - success - error - message properties: success: type: boolean enum: - false error: type: string enum: - Forbidden message: type: string code: type: string example: FORBIDDEN example: success: false error: Forbidden message: string securitySchemes: ntfAutoBearerAuth: type: http scheme: bearer bearerFormat: API Key description: '`Authorization: Bearer sk_live_...`' ntfAutoApiKeyHeader: type: apiKey in: header name: x-api-key description: Mesmo valor da chave, sem prefixo Bearer. ````