User

Operations about users

Retrieve all users

get

/users

Retrieve all users from your instance. Only available for the instance owner.

Authorizations

X-N8N-API-KEYstringRequired

Query parameters

limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100

offsetnumberOptional

The number of items to skip before starting to collect the result set.

Default: 0Example: 0

cursorstringOptional

Paginate by setting the cursor parameter to the nextCursor attribute returned by the previous request's response. Default value fetches the first "page" of the collection. See pagination for more detail.

includeRolebooleanOptional

Whether to include the user's role or not.

Default: falseExample: true

projectIdstringOptionalExample: VmwOO9HeTEj20kxM

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

Paginate through users by setting the cursor parameter to a nextCursor attribute returned by a previous request. Default value fetches the first "page" of the collection.

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA

401

Unauthorized

get/users

GET /api/v1/users HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "firstName": "john",
      "lastName": "Doe",
      "isPending": true,
      "createdAt": "2026-01-01T00:00:00.000Z",
      "updatedAt": "2026-01-01T00:00:00.000Z",
      "role": "global:owner",
      "mfaEnabled": false
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Create multiple users

post

/users

Create one or more users.

Authorizations

X-N8N-API-KEYstringRequired

Bodyobject[]

emailstring · emailRequired

rolestringOptionalExample: global:member

Responses

200

Operation successful.

application/json

errorstringOptional

401

Unauthorized

403

Forbidden

post/users

POST /api/v1/users HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 51

[
  {
    "email": "[e-mail]",
    "role": "global:member"
  }
]

{
  "user": {
    "id": "text",
    "email": "text",
    "inviteAcceptUrl": "text",
    "emailSent": true
  },
  "error": "text"
}

Get user by ID/Email

get

/users/{id}

Retrieve a user from your instance. Only available for the instance owner.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstring · identifierRequired

The ID or email of the user.

Query parameters

includeRolebooleanOptional

Whether to include the user's role or not.

Default: falseExample: true

Responses

200

Operation successful.

application/json

idstringRead-onlyOptionalExample: 123e4567-e89b-12d3-a456-426614174000

emailstring · emailRequiredExample: [e-mail]

firstNamestring · max: 32Read-onlyOptional

User's first name

Example: john

lastNamestring · max: 32Read-onlyOptional

User's last name

Example: Doe

isPendingbooleanRead-onlyOptional

Whether the user finished setting up their account in response to the invitation (true) or not (false).

createdAtstring · date-timeRead-onlyOptional

Time the user was created.

updatedAtstring · date-timeRead-onlyOptional

Last time the user was updated.

rolestringRead-onlyOptionalExample: global:owner

mfaEnabledbooleanRead-onlyOptional

Whether the user has multi-factor authentication (MFA/2FA) enabled.

Example: false

401

Unauthorized

get/users/{id}

GET /api/v1/users/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "[e-mail]",
  "firstName": "john",
  "lastName": "Doe",
  "isPending": true,
  "createdAt": "2026-01-01T00:00:00.000Z",
  "updatedAt": "2026-01-01T00:00:00.000Z",
  "role": "global:owner",
  "mfaEnabled": false
}

Delete a user

delete

/users/{id}

Delete a user from your instance.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstring · identifierRequired

The ID or email of the user.

Responses

204

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/users/{id}

DELETE /api/v1/users/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

No content

Change a user's global role

patch

/users/{id}/role

Change a user's global role

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

idstring · identifierRequired

The ID or email of the user.

Body

newRoleNamestringRequiredExample: global:member

Responses

200

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

patch/users/{id}/role

PATCH /api/v1/users/{id}/role HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 31

{
  "newRoleName": "global:member"
}

No content