Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

N8n User API

Operations about users

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

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, and authentication docs.

This API exposes 5 operations across 3 paths. It is described by OpenAPI 3.0.0, at version 1.1.1.

Requests are made against 2 base URLs: https://app.n8n.cloud/api/v1, {baseUrl}/api/v1.

5 operations 3 paths 0 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.1.1
Base URL
https://app.n8n.cloud/api/v1
Authentication
API Key, HTTP Bearer
Contact
Terms of Service
Resource Areas
1

Authentication & Security 2

N8n User API declares 2 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). By default, every request must be authenticated.

Paths & Operations 5

Across 3 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

User 5

Operations about users

GET
/users
Retrieve all users
getUsers 4 params → 200
POST
/users
Create multiple users
createUsers → 200
GET
/users/{id}
Get user by ID/Email
getUser 2 params → 200
DELETE
/users/{id}
Delete a user
deleteUser 1 param → 204
PATCH
/users/{id}/role
Change a user's global role
changeUserRole 1 param → 200

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

n8n-user-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