Variables

Operations about variables

Retrieve variables

get

Retrieve variables from your instance.

Authorizations

ApiKeyAuthBearerAuth

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.

projectIdstringOptionalExample: VmwOO9HeTEj20kxM

statestring · enumOptionalPossible values:

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

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

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "text",
      "key": "text",
      "value": "test",
      "type": "text",
      "project": {
        "id": "text",
        "name": "text",
        "type": "text"
      }
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Create a variable

post

Create a variable in your instance.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Body

application/json

idstringRead-onlyOptional

keystringRequired

valuestringRequiredExample: test

typestringRead-onlyOptional

projectIdstring · nullableOptionalExample: VmwOO9HeTEj20kxM

Responses

201

Operation successful.

No content

400

The request is invalid or provides malformed data.

401

Unauthorized

post/variables

HTTPcURLJavaScriptPython

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

{
  "key": "text",
  "value": "test",
  "projectId": "VmwOO9HeTEj20kxM"
}

No content

Update a variable

put

Update a variable from your instance.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the variable.

Body

application/json

idstringRead-onlyOptional

keystringRequired

valuestringRequiredExample: test

typestringRead-onlyOptional

projectIdstring · nullableOptionalExample: VmwOO9HeTEj20kxM

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/variables/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/variables/{id} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 60

{
  "key": "text",
  "value": "test",
  "projectId": "VmwOO9HeTEj20kxM"
}

No content

Delete a variable

delete

Delete a variable from your instance.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the variable.

Responses

204

Operation successful.

No content

401

Unauthorized

404

The specified resource was not found.

delete/variables/{id}

HTTPcURLJavaScriptPython

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

No content