Skip to content

API Endpoints

Полная документация всех доступных endpoints в n8n API.

Base URL

https://n8n.chapiro.space/api/v1

Workflows

GET /workflows

Получить список всех воркфлоу.

Запрос:

bash
curl -X GET https://n8n.chapiro.space/api/v1/workflows \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": [
    {
      "id": "1",
      "name": "Daily Report",
      "active": true,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-20T15:30:00.000Z",
      "nodes": [...],
      "connections": {...},
      "settings": {...}
    }
  ]
}

GET /workflows/:id

Получить конкретный воркфлоу по ID.

Параметры:

  • id (string, required) - ID воркфлоу

Запрос:

bash
curl -X GET https://n8n.chapiro.space/api/v1/workflows/1 \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": {
    "id": "1",
    "name": "Daily Report",
    "active": true,
    "nodes": [
      {
        "id": "node-1",
        "name": "Schedule Trigger",
        "type": "n8n-nodes-base.scheduleTrigger",
        "position": [250, 300],
        "parameters": {...}
      }
    ],
    "connections": {
      "Schedule Trigger": {
        "main": [[{"node": "HTTP Request", "type": "main", "index": 0}]]
      }
    }
  }
}

POST /workflows

Создать новый воркфлоу.

Body:

json
{
  "name": "New Workflow",
  "nodes": [
    {
      "name": "Start",
      "type": "n8n-nodes-base.start",
      "position": [250, 300],
      "parameters": {}
    }
  ],
  "connections": {},
  "active": false
}

Запрос:

bash
curl -X POST https://n8n.chapiro.space/api/v1/workflows \
  -H "X-N8N-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "New Workflow", "nodes": [...], "connections": {}}'

Ответ:

json
{
  "data": {
    "id": "2",
    "name": "New Workflow",
    "active": false,
    "createdAt": "2026-02-07T10:00:00.000Z"
  }
}

PUT /workflows/:id

Обновить существующий воркфлоу.

Параметры:

  • id (string, required) - ID воркфлоу

Body: Полное описание воркфлоу (как при создании)

Запрос:

bash
curl -X PUT https://n8n.chapiro.space/api/v1/workflows/1 \
  -H "X-N8N-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"name": "Updated Workflow", "nodes": [...], "connections": {}}'

DELETE /workflows/:id

Удалить воркфлоу.

Параметры:

  • id (string, required) - ID воркфлоу

Запрос:

bash
curl -X DELETE https://n8n.chapiro.space/api/v1/workflows/1 \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": {
    "success": true
  }
}

POST /workflows/:id/activate

Активировать воркфлоу.

Запрос:

bash
curl -X POST https://n8n.chapiro.space/api/v1/workflows/1/activate \
  -H "X-N8N-API-KEY: your_api_key"

POST /workflows/:id/deactivate

Деактивировать воркфлоу.

Запрос:

bash
curl -X POST https://n8n.chapiro.space/api/v1/workflows/1/deactivate \
  -H "X-N8N-API-KEY: your_api_key"

Executions

GET /executions

Получить список выполнений воркфлоу.

Query параметры:

  • limit (number, optional) - Количество результатов (default: 20, max: 100)
  • cursor (string, optional) - Курсор для пагинации
  • workflowId (string, optional) - Фильтр по ID воркфлоу
  • status (string, optional) - Фильтр по статусу: success, error, running, waiting

Запрос:

bash
curl -X GET "https://n8n.chapiro.space/api/v1/executions?limit=10&status=success" \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": [
    {
      "id": "exec-1",
      "workflowId": "1",
      "mode": "trigger",
      "startedAt": "2026-02-07T09:00:00.000Z",
      "finishedAt": "2026-02-07T09:00:05.000Z",
      "status": "success",
      "data": {...}
    }
  ],
  "nextCursor": "cursor_string"
}

GET /executions/:id

Получить детали выполнения.

Параметры:

  • id (string, required) - ID выполнения

Запрос:

bash
curl -X GET https://n8n.chapiro.space/api/v1/executions/exec-1 \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": {
    "id": "exec-1",
    "workflowId": "1",
    "mode": "trigger",
    "startedAt": "2026-02-07T09:00:00.000Z",
    "finishedAt": "2026-02-07T09:00:05.000Z",
    "status": "success",
    "data": {
      "resultData": {
        "runData": {
          "Start": [...],
          "HTTP Request": [...]
        }
      }
    }
  }
}

DELETE /executions/:id

Удалить запись о выполнении.

Запрос:

bash
curl -X DELETE https://n8n.chapiro.space/api/v1/executions/exec-1 \
  -H "X-N8N-API-KEY: your_api_key"

POST /workflows/:id/execute

Запустить воркфлоу вручную.

Параметры:

  • id (string, required) - ID воркфлоу

Body (optional):

json
{
  "data": {
    "customField": "value"
  }
}

Запрос:

bash
curl -X POST https://n8n.chapiro.space/api/v1/workflows/1/execute \
  -H "X-N8N-API-KEY: your_api_key" \
  -H "Content-Type: application/json" \
  -d '{"data": {"customField": "value"}}'

Ответ:

json
{
  "data": {
    "executionId": "exec-2",
    "status": "running"
  }
}

Credentials

⚠️ Внимание: Credentials endpoints требуют повышенных прав доступа.

GET /credentials

Получить список credentials (без sensitive данных).

Запрос:

bash
curl -X GET https://n8n.chapiro.space/api/v1/credentials \
  -H "X-N8N-API-KEY: your_api_key"

Ответ:

json
{
  "data": [
    {
      "id": "cred-1",
      "name": "GitHub API",
      "type": "githubApi",
      "createdAt": "2026-01-10T10:00:00.000Z",
      "updatedAt": "2026-01-10T10:00:00.000Z"
    }
  ]
}

POST /credentials

Создать новый credential.

Body:

json
{
  "name": "My API Key",
  "type": "httpHeaderAuth",
  "data": {
    "name": "X-API-Key",
    "value": "secret_key_value"
  }
}

DELETE /credentials/:id

Удалить credential.

Запрос:

bash
curl -X DELETE https://n8n.chapiro.space/api/v1/credentials/cred-1 \
  -H "X-N8N-API-KEY: your_api_key"

Rate Limiting

API имеет лимит: 100 запросов в минуту на API ключ.

Headers в ответе:

X-RateLimit-Limit: 100
X-RateLimit-Remaining: 95
X-RateLimit-Reset: 1675765200

При превышении лимита:

json
{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Too many requests. Please try again later.",
    "retryAfter": 60
  }
}

Pagination

Для endpoints с большим количеством результатов используется cursor-based pagination:

bash
# Первый запрос
curl "https://n8n.chapiro.space/api/v1/executions?limit=20"

# Следующая страница
curl "https://n8n.chapiro.space/api/v1/executions?limit=20&cursor=next_cursor_value"

Коды ошибок

КодОписание
200OK
201Created
204No Content
400Bad Request
401Unauthorized
403Forbidden
404Not Found
429Too Many Requests
500Internal Server Error

Следующие шаги

Документация n8n