Projects

Operations about projects

Retrieve projects

get

Retrieve projects from your instance.

Authorizations

X-N8N-API-KEYstringRequired

Query parameters

limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100

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.

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

Paginate through projects 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/projects

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

{
  "data": [
    {
      "id": "text",
      "name": "text",
      "type": "text"
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Create a project

post

Create a project on your instance.

Authorizations

X-N8N-API-KEYstringRequired

Body

idstringRead-onlyOptional

namestringRequired

typestringRead-onlyOptional

Responses

201

Operation successful.

No content

400

The request is invalid or provides malformed data.

401

Unauthorized

post/projects

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

{
  "name": "text"
}

No content

Update a project

put

Update a project on your instance.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

Body

idstringRead-onlyOptional

namestringRequired

typestringRead-onlyOptional

Responses

204

Operation successful.

No content

400

The request is invalid or provides malformed data.

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

put/projects/{projectId}

PUT /api/v1/projects/{projectId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "name": "text"
}

No content

Delete a project

delete

Delete a project from your instance.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

Responses

204

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/projects/{projectId}

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

No content

List project members

get

Returns a list of all members of a project including their role. Requires user:list scope.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

Query parameters

limitnumber · max: 250Optional

The maximum number of items to return.

Default: 100Example: 100

cursorstringOptional

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

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

Example: MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/projects/{projectId}/users

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

{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "email": "john.doe@company.com",
      "firstName": "john",
      "lastName": "Doe",
      "createdAt": "2026-07-19T15:04:36.706Z",
      "updatedAt": "2026-07-19T15:04:36.706Z",
      "role": "project:viewer"
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Add one or more users to a project

post

Add one or more users to a project on your instance.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

Body

Responses

201

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

post/projects/{projectId}/users

POST /api/v1/projects/{projectId}/users HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "relations": [
    {
      "userId": "91765f0d-3b29-45df-adb9-35b23937eb92",
      "role": "project:viewer"
    }
  ]
}

No content

Delete a user from a project

delete

Delete a user from a project on your instance.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

userIdstringRequired

The ID of the user.

Responses

204

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

delete/projects/{projectId}/users/{userId}

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

No content

Change a user's role in a project

patch

Change a user's role in a project.

Authorizations

X-N8N-API-KEYstringRequired

Path parameters

projectIdstringRequired

The ID of the project.

userIdstringRequired

The ID of the user.

Body

rolestringRequired

The role assigned to the user in the project.

Example: project:viewer

Responses

204

Operation successful.

No content

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

patch/projects/{projectId}/users/{userId}

PATCH /api/v1/projects/{projectId}/users/{userId} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 25

{
  "role": "project:viewer"
}

No content

PreviousData Table NextCommunity Package

Last updated 5 days ago

Was this helpful?