Endpoint reference

This section is the complete endpoint reference for n8n's public REST API, generated from the OpenAPI specification. Use it to explore every available operation and view the parameters, request bodies, and response schemas.

Feature availability

The n8n API is available on:

• n8n Cloud: Starter, Pro, Enterprise

• Self-hosted: All editions

It isn't available on the free trial.

Before you start

• Authenticate: every request needs an API key. Refer to Authentication.

• Set your base URL:

  • n8n Cloud: https://<your-instance>.app.n8n.cloud/api/v1

  • Self-hosted: https://<your-domain>/api/v1

• Paginate large result sets. Refer to Pagination.

Browse the endpoints

The endpoints are grouped by resource in the left sidebar under n8n API: Workflow, Execution, Credential, User, Audit, Tags, Source Control, Variables, Data Table, Projects, and more. Each page documents that resource's operations and schemas.

Try the API safely

To experiment with live calls, use the built-in API playground (self-hosted n8n only), or point requests at a test workflow or test instance.

Related resources

• n8n API

• Authentication

• Pagination

• Use an API playground