Skip to content

API 分页#

默认页面大小为 100 个结果。您可以更改页面大小限制。允许的最大大小为 250。

当响应包含多个页面时，它包含一个游标，您可以使用它来请求下一页。

例如，假设您想要获取所有活动工作流，每次 150 个。

获取第一页：

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# 对于自托管的 n8n 实例
curl -X 'GET' \
  '<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true&limit=150' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

# 对于 n8n Cloud
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true&limit=150' \
  -H 'accept: application/json' \
  -H 'X-N8N-API-KEY: <your-api-key>'

响应是 JSON 格式，并包含一个 nextCursor 值。这是一个示例响应。

1
2
3
4
5
6
7
8
9
{
  "data": [
    // 响应包含每个工作流的对象
    {
      // 工作流数据
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

然后请求下一页：

1
2
3
4
5
6
7
8
9
# 对于自托管的 n8n 实例
curl -X 'GET' \
  '<N8N_HOST>:<N8N_PORT>/<N8N_PATH>/api/v<version-number>/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \
  -H 'accept: application/json'

# 对于 n8n Cloud
curl -X 'GET' \
  '<your-cloud-instance>/api/v<version-number>/workflows?active=true&limit=150&cursor=MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA' \
  -H 'accept: application/json'