How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

N8n

Build with the precision of code or the speed of drag-n-drop. Host with on-prem control or in-the-cloud convenience. n8n gives you more freedom to implement multi-step AI agents and integrate apps than any other tool.

N8n is one of 15 APIs that n8n publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Agents, Artificial Intelligence, and Integration. The published artifact set on APIs.io includes API documentation, an OpenAPI specification, and an API reference.

This API exposes 86 operations across 52 paths, organized into 22 resource areas, and defines 18 schemas. It is described by OpenAPI 3.0.0, at version 1.1.1.

Requests are made against 2 base URLs: /api/v1, {url}/api/v1.

86 operations 52 paths 18 schemas 13 DELETE31 GET8 PATCH24 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.1.1
Servers
/api/v1
{url}/api/v1
Authentication
API Key, HTTP Bearer, API Key
Terms of Service
Resource Areas
22

Authentication & Security 3

N8n declares 3 security schemes for authenticating requests. An API key is passed in the header as X-N8N-API-KEY (ApiKeyAuth). It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the cookie as n8n-auth (CookieAuth). By default, every request must be authenticated.

Paths & Operations 86

Across 52 paths, the API surfaces 86 operations — 13 DELETE, 31 GET, 8 PATCH, 24 POST, 10 PUT. They span 22 resource areas, including Audit, SettingsLdap, SecurityPolicy, SettingsOtel, SettingsSsoOidc, SettingsSsoSaml, Credential, Executions, and 14 more. Each is listed below with its method, path, parameters, and response codes.

Audit 1

Operations about security audit

POST
/audit
Generate an audit
body → 200401500
SettingsLdap 4

Operations about LDAP settings

GET
/settings/ldap
Retrieve the LDAP configuration
→ 200401403
PUT
/settings/ldap
Set the LDAP configuration
body → 200400401403
GET
/settings/ldap/sync
Retrieve LDAP synchronization history
2 params → 200401403
POST
/settings/ldap/sync
Trigger an LDAP synchronization
body → 200400401403
SecurityPolicy 2

Operations about the instance security policy settings

GET
/settings/security-policy
Retrieve the security policy
→ 200401403
PUT
/settings/security-policy
Set the security policy
body → 200400401403409
SettingsOtel 3

Operations about OpenTelemetry settings

GET
/settings/otel
Retrieve the OpenTelemetry configuration
→ 200401403
PUT
/settings/otel
Set the OpenTelemetry configuration
body → 200400401403409
POST
/settings/otel/test-trace
Test the connection to an OTLP collector
body → 200400401403
SettingsSsoOidc 2

Operations about OIDC SSO settings

GET
/settings/sso/oidc
Retrieve the OIDC SSO configuration
→ 200401403
PUT
/settings/sso/oidc
Set the OIDC SSO configuration
body → 200400401403409
SettingsSsoSaml 2

Operations about SAML SSO settings

GET
/settings/sso/saml
Retrieve the SAML SSO configuration
→ 200401403
PUT
/settings/sso/saml
Set the SAML SSO configuration
body → 200400401403409
Credential 8

Operations about credentials

GET
/credentials
List credentials
getCredentials 2 params → 200401
POST
/credentials
Create a credential
createCredential body → 200400401403404415
GET
/credentials/{id}
Get credential by ID
getCredential 1 param → 200401403404
PATCH
/credentials/{id}
Update credential by ID
updateCredential 1 param body → 200400401404
DELETE
/credentials/{id}
Delete credential by ID
deleteCredential 1 param → 200401404
POST
/credentials/{id}/test
Test credential by ID
testCredential 1 param → 200401404
GET
/credentials/schema/{credentialTypeName}
Show credential data schema
1 param → 200401404
PUT
/credentials/{id}/transfer
Transfer a credential to another project.
1 param body → 200400401404
Executions 1

Operations about executions

POST
/executions/{id}/retry
Retry an execution
1 param body → 200401404409
Tags 4

Operations about tags

POST
/tags
Create a tag
body → 201400409401
GET
/tags/{id}
Retrieves a tag
1 param → 200401404
DELETE
/tags/{id}
Delete a tag
1 param → 200401403404
PUT
/tags/{id}
Update a tag
1 param body → 200400401404409
Workflow 1

Operations about workflows

GET
/workflows/{id}/{versionId}deprecated
Retrieves a specific version of a workflow
2 params → 200401404
Evaluation 5

Operations about evaluation test runs

GET
/workflows/{id}/test-runs
Retrieve test runs
4 params → 200401403404
POST
/workflows/{id}/test-runs
Trigger a test run
1 param → 201401402403404409
GET
/workflows/{id}/test-runs/{runId}
Retrieve a test run
2 params → 200401403404
POST
/workflows/{id}/test-runs/{runId}/cancel
Cancel a test run
2 params → 202401403404409
GET
/workflows/{id}/test-runs/{runId}/test-cases
Retrieve test run cases
4 params → 200401403404
User 5

Operations about users

GET
/users
Retrieve all users
5 params → 200401
POST
/users
Create multiple users
body → 200401403
GET
/users/{id}
Get user by ID/Email
2 params → 200401
DELETE
/users/{id}
Delete a user
1 param → 204401403404
PATCH
/users/{id}/role
Change a user's global role
1 param body → 200401403404
SourceControl 1

Operations about source control

POST
/source-control/pull
Pull changes from the remote repository
body → 200400409
Variables 4

Operations about variables

POST
/variables
Create a variable
body → 201400401
GET
/variables
Retrieve variables
4 params → 200401
DELETE
/variables/{id}
Delete a variable
1 param → 204401404
PUT
/variables/{id}
Update a variable
1 param body → 204400401403404
DataTable 15

Operations about data tables and their rows

GET
/data-tables
List all data tables
list-data-tables 4 params → 200400401
POST
/data-tables
Create a new data table
create-data-table body → 201400401403409
GET
/data-tables/{dataTableId}
Get a data table
get-data-table 1 param → 200401404
PATCH
/data-tables/{dataTableId}
Update a data table
update-data-table 1 param body → 200400401404409
DELETE
/data-tables/{dataTableId}
Delete a data table
delete-data-table 1 param → 204401404
GET
/data-tables/{dataTableId}/rows
Retrieve rows from a data table
get-data-table-rows 6 params → 200400401404
POST
/data-tables/{dataTableId}/rows
Insert rows into a data table
insert-data-table-rows 1 param body → 200400401404
PATCH
/data-tables/{dataTableId}/rows/update
Update rows in a data table
update-data-table-rows 1 param body → 200400401404
POST
/data-tables/{dataTableId}/rows/upsert
Upsert a row in a data table
upsert-data-table-row 1 param body → 200400401404
DELETE
/data-tables/{dataTableId}/rows/clear
Clear all rows from a data table
clear-data-table-rows 1 param → 200401404
DELETE
/data-tables/{dataTableId}/rows/delete
Delete rows from a data table
delete-data-table-rows 4 params → 200400401404
GET
/data-tables/{dataTableId}/columns
List columns of a data table
list-data-table-columns 1 param → 200401404
POST
/data-tables/{dataTableId}/columns
Add a column to a data table
create-data-table-column 1 param body → 201400401404409
DELETE
/data-tables/{dataTableId}/columns/{columnId}
Delete a column
delete-data-table-column 2 params → 204401404
PATCH
/data-tables/{dataTableId}/columns/{columnId}
Update a column
update-data-table-column 2 params body → 200400401404409
Projects 8

Operations about projects

POST
/projects
Create a project
body → 201400401
GET
/projects
Retrieve projects
2 params → 200401
DELETE
/projects/{projectId}
Delete a project
1 param → 204401403404
PUT
/projects/{projectId}
Update a project
1 param body → 204400401403404
GET
/projects/{projectId}/users
List project members
3 params → 200401403404
POST
/projects/{projectId}/users
Add one or more users to a project
1 param body → 201401403404
DELETE
/projects/{projectId}/users/{userId}
Delete a user from a project
2 params → 204401403404
PATCH
/projects/{projectId}/users/{userId}
Change a user's role in a project
2 params body → 204401403404
CommunityPackage 4

Operations about community packages

POST
/community-packages
Install a community package
body → 200400401
GET
/community-packages
List installed community packages
→ 200401
PATCH
/community-packages/{name}
Update a community package
1 param body → 200400401404
DELETE
/community-packages/{name}
Uninstall a community package
1 param → 204400401404
Discover 1

API capability discovery

GET
/discover
Discover available API capabilities
3 params → 200401
Insights 1

Operations about insights

GET
/insights/summary
Retrieve insights summary
3 params → 200400401403
Folders 5

Operations about folders

POST
/projects/{projectId}/folders
Create a folder
1 param body → 201400401403404
GET
/projects/{projectId}/folders
Retrieve folders
6 params → 200400401403404
DELETE
/projects/{projectId}/folders/{folderId}
Delete a folder
3 params → 204400401403404
GET
/projects/{projectId}/folders/{folderId}
Get folder details
2 params → 200401403404
PATCH
/projects/{projectId}/folders/{folderId}
Update a folder
2 params body → 200400401403404
N8nPackage 2

Beta — breaking changes may still occur without major version bump.

POST
/n8n-packages/export
Beta: Export workflows, folders, or projects as an n8n package
body → 200400401403404
POST
/n8n-packages/import
Beta: Import an n8n package into a project
body → 200409422400401403404
LogStreaming 7

Operations about log streaming destinations

GET
/settings/log-streaming/event-types
List streamable event types
→ 200401403
GET
/settings/log-streaming/destinations
List log streaming destinations
→ 200401403
POST
/settings/log-streaming/destinations
Create a log streaming destination
body → 200400401403409
POST
/settings/log-streaming/destinations/{id}/test
Send a test message to a log streaming destination
1 param → 200401403404
GET
/settings/log-streaming/destinations/{id}
Retrieve a log streaming destination
1 param → 200401403404
PUT
/settings/log-streaming/destinations/{id}
Update a log streaming destination
1 param body → 200400401403404409
DELETE
/settings/log-streaming/destinations/{id}
Delete a log streaming destination
1 param → 200401403404409

Schemas 18

The contract defines 18 schemas that model the data the API accepts and returns. The most detailed are Node (21 properties), Workflow (20 properties), WorkflowSettings (17 properties), SourceControlledFile (15 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties 1 required
Role
object
5 properties
Execution
object
12 properties
Node
object
21 properties
WorkflowNodeGroup
object
4 properties 3 required
Tag
object
4 properties 1 required
Workflow
object
20 properties 4 required
WorkflowSettings
object
17 properties
ExecutionList
object
2 properties
WorkflowList
object
2 properties
Credential
object
7 properties 3 required
CredentialType
object
4 properties
Audit
object
5 properties
Pull
object
2 properties
PullResult
array
SourceControlledFile
object
15 properties 8 required
UserList
object
2 properties
User
object
9 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

n8n-public-api-openapi.yml Raw ↑

Other APIs n8n publishes across the network.

N8n Audit API
N8n CommunityPackage API
N8n Credential API
N8n DataTable API
N8n Discover API
N8n Execution API
N8n Folders API
N8n Insights API
N8n Projects API
N8n SourceControl API
N8n Tags API
N8n User API
Where this information came from

This is an independent, third-party profile of N8n, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.