Credential

Operations about credentials

List credentials

get

Retrieve all credentials from your instance. Only available for the instance owner and admin. Credential data (secrets) is not included.

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.

Responses

200

Operation successful.

application/json

nextCursorstring · nullableOptional

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

HTTPcURLJavaScriptPython

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

{
  "data": [
    {
      "id": "vHxaz5UaCghVYl9C",
      "name": "John's Github account",
      "type": "githubApi",
      "isManaged": false,
      "isGlobal": false,
      "isResolvable": false,
      "resolvableAllowFallback": false,
      "resolverId": null,
      "createdAt": "2022-04-29T11:02:29.842Z",
      "updatedAt": "2022-04-29T11:02:29.842Z",
      "shared": [
        {
          "id": "text",
          "name": "text",
          "role": "text",
          "createdAt": "2026-07-19T15:39:55.846Z",
          "updatedAt": "2026-07-19T15:39:55.846Z"
        }
      ]
    }
  ],
  "nextCursor": "MTIzZTQ1NjctZTg5Yi0xMmQzLWE0NTYtNDI2NjE0MTc0MDA"
}

Create a credential

post

Creates a credential that can be used by nodes of the specified type.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Body

application/json

idstringRead-onlyOptionalExample: R2DjclaysHbqn778

namestringRequiredExample: Joe's Github Credentials

typestringRequiredExample: githubApi

dataobjectWrite-onlyRequiredExample: {"accessToken":"ada612vad6fa5df4adf5a5dsf4389adsf76da7s"}

isResolvablebooleanOptional

Whether this credential has resolvable fields

Example: false

createdAtstring · date-timeRead-onlyOptionalExample: 2022-04-29T11:02:29.842Z

updatedAtstring · date-timeRead-onlyOptionalExample: 2022-04-29T11:02:29.842Z

projectIdstringOptional

Project to create the credential in. Defaults to the user's personal project.

Example: VmwOO9HeTEj20kxM

Responses

200

Operation successful.

application/json

idstringRead-onlyRequiredExample: vHxaz5UaCghVYl9C

namestringRequiredExample: John's Github account

typestringRequiredExample: githubApi

isManagedbooleanRead-onlyRequired

Whether the credential is managed by n8n (managed credentials cannot be edited via the API).

Example: false

isGlobalbooleanRead-onlyRequired

Whether the credential is available for use by all users.

Example: false

isResolvablebooleanRead-onlyRequired

Whether the credential can be dynamically resolved by a resolver.

Example: false

resolvableAllowFallbackbooleanRead-onlyRequired

Whether the credential resolver may fall back to static credentials if dynamic resolution fails.

Example: false

resolverIdstring · nullableRead-onlyOptional

ID of the dynamic credential resolver associated with this credential, if any.

createdAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

updatedAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

400

The request is invalid or provides malformed data.

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

415

Unsupported media type.

post/credentials

HTTPcURLJavaScriptPython

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

{
  "name": "Joe's Github Credentials",
  "type": "githubApi",
  "data": {
    "accessToken": "ada612vad6fa5df4adf5a5dsf4389adsf76da7s"
  },
  "isResolvable": false,
  "projectId": "VmwOO9HeTEj20kxM"
}

{
  "id": "vHxaz5UaCghVYl9C",
  "name": "John's Github account",
  "type": "githubApi",
  "isManaged": false,
  "isGlobal": false,
  "isResolvable": false,
  "resolvableAllowFallback": false,
  "resolverId": null,
  "createdAt": "2022-04-29T11:02:29.842Z",
  "updatedAt": "2022-04-29T11:02:29.842Z"
}

Get credential by ID

get

Retrieves a credential by ID. Credential data (secrets) is not included.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The credential ID

Responses

200

Operation successful.

application/json

idstringRead-onlyRequiredExample: vHxaz5UaCghVYl9C

namestringRequiredExample: John's Github account

typestringRequiredExample: githubApi

isManagedbooleanRead-onlyRequired

Whether the credential is managed by n8n (managed credentials cannot be edited via the API).

Example: false

isGlobalbooleanRead-onlyRequired

Whether the credential is available for use by all users.

Example: false

isResolvablebooleanRead-onlyRequired

Whether the credential can be dynamically resolved by a resolver.

Example: false

resolvableAllowFallbackbooleanRead-onlyRequired

Whether the credential resolver may fall back to static credentials if dynamic resolution fails.

Example: false

resolverIdstring · nullableRead-onlyOptional

ID of the dynamic credential resolver associated with this credential, if any.

createdAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

updatedAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

401

Unauthorized

403

Forbidden

404

The specified resource was not found.

get/credentials/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "vHxaz5UaCghVYl9C",
  "name": "John's Github account",
  "type": "githubApi",
  "isManaged": false,
  "isGlobal": false,
  "isResolvable": false,
  "resolvableAllowFallback": false,
  "resolverId": null,
  "createdAt": "2022-04-29T11:02:29.842Z",
  "updatedAt": "2022-04-29T11:02:29.842Z"
}

Delete credential by ID

delete

Deletes a credential from your instance. You must be the owner of the credentials

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The credential ID that needs to be deleted

Responses

200

Operation successful.

application/json

idstringRead-onlyOptionalExample: R2DjclaysHbqn778

namestringRequiredExample: Joe's Github Credentials

typestringRequiredExample: githubApi

dataobjectWrite-onlyRequiredExample: {"accessToken":"ada612vad6fa5df4adf5a5dsf4389adsf76da7s"}

isResolvablebooleanOptional

Whether this credential has resolvable fields

Example: false

createdAtstring · date-timeRead-onlyOptionalExample: 2022-04-29T11:02:29.842Z

updatedAtstring · date-timeRead-onlyOptionalExample: 2022-04-29T11:02:29.842Z

401

Unauthorized

404

The specified resource was not found.

delete/credentials/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "R2DjclaysHbqn778",
  "name": "Joe's Github Credentials",
  "type": "githubApi",
  "isResolvable": false,
  "createdAt": "2022-04-29T11:02:29.842Z",
  "updatedAt": "2022-04-29T11:02:29.842Z"
}

Update credential by ID

patch

Updates an existing credential. You must be the owner of the credential.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The credential ID that needs to be updated

Body

application/json

namestringOptional

The name of the credential

Example: Updated Credential Name

typestringOptional

The credential type. If changing type, data must also be provided.

Example: githubApi

dataobjectWrite-onlyOptional

The credential data. Required when changing credential type.

Example: {"accessToken":"new_token_value"}

isGlobalbooleanOptional

Whether this credential is available globally

Example: false

isResolvablebooleanOptional

Whether this credential has resolvable fields

Example: false

isPartialDatabooleanOptional

If true, unredacts and merges existing credential data with the provided data. If false, replaces the entire data object.

Default: falseExample: false

Responses

200

Operation successful.

application/json

idstringRead-onlyRequiredExample: vHxaz5UaCghVYl9C

namestringRequiredExample: John's Github account

typestringRequiredExample: githubApi

isManagedbooleanRead-onlyRequired

Whether the credential is managed by n8n (managed credentials cannot be edited via the API).

Example: false

isGlobalbooleanRead-onlyRequired

Whether the credential is available for use by all users.

Example: false

isResolvablebooleanRead-onlyRequired

Whether the credential can be dynamically resolved by a resolver.

Example: false

resolvableAllowFallbackbooleanRead-onlyRequired

Whether the credential resolver may fall back to static credentials if dynamic resolution fails.

Example: false

resolverIdstring · nullableRead-onlyOptional

ID of the dynamic credential resolver associated with this credential, if any.

createdAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

updatedAtstring · date-timeRead-onlyRequiredExample: 2022-04-29T11:02:29.842Z

400

Bad request - invalid credential type or data.

401

Unauthorized

404

The specified resource was not found.

patch/credentials/{id}

HTTPcURLJavaScriptPython

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

{
  "name": "Updated Credential Name",
  "type": "githubApi",
  "data": {
    "accessToken": "new_token_value"
  },
  "isGlobal": false,
  "isResolvable": false,
  "isPartialData": false
}

{
  "id": "vHxaz5UaCghVYl9C",
  "name": "John's Github account",
  "type": "githubApi",
  "isManaged": false,
  "isGlobal": false,
  "isResolvable": false,
  "resolvableAllowFallback": false,
  "resolverId": null,
  "createdAt": "2022-04-29T11:02:29.842Z",
  "updatedAt": "2022-04-29T11:02:29.842Z"
}

Test credential by ID

post

Tests a credential by ID using the stored credential data.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The credential ID

Responses

200

Operation successful.

application/json

statusstring · enumRequiredPossible values:

messagestringRequired

401

Unauthorized

404

The specified resource was not found.

post/credentials/{id}/test

HTTPcURLJavaScriptPython

POST /api/v1/credentials/{id}/test HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "status": "OK",
  "message": "text"
}

Show credential data schema

get

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

credentialTypeNamestringRequired

The credential type name that you want to get the schema for

Responses

200

Operation successful.

application/json

objectOptional

401

Unauthorized

404

The specified resource was not found.

get/credentials/schema/{credentialTypeName}

HTTPcURLJavaScriptPython

GET /api/v1/credentials/schema/{credentialTypeName} HTTP/1.1
X-N8N-API-KEY: YOUR_API_KEY
Accept: */*

{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "apiKey": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "apiKey",
    "domain"
  ]
}

Transfer a credential to another project.

put

Transfer a credential to another project.

Authorizations

ApiKeyAuthBearerAuth

X-N8N-API-KEYstringRequired

Path parameters

idstringRequired

The ID of the credential.

Body

application/json

destinationProjectIdstringRequired

The ID of the project to transfer the credential to.

Responses

200

Operation successful.

No content

400

The request is invalid or provides malformed data.

401

Unauthorized

404

The specified resource was not found.

put/credentials/{id}/transfer

HTTPcURLJavaScriptPython

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

{
  "destinationProjectId": "text"
}

No content