Skip to main content

Discover API

DiscoverClient discovers available resources and operations in the n8n instance.

This is especially useful for tooling, schema-aware integrations, or admin interfaces that need to adapt to the caller's scopes.

Access

const discover = client.discover();

Methods

Common Tasks

  • inspect what the current credentials are allowed to access
  • fetch request schemas for dynamic tools or generators
  • filter to a single resource or operation family

get(params?)

Discover available resources, optionally filtered by type.

const resources = await client.discover().get({
include: 'schemas',
resource: 'workflow',
operation: 'list',
});

The response includes:

  • data.scopes: active scopes for the current credentials
  • data.resources: grouped operations and endpoints
  • data.filters: filter metadata for discovery queries
  • data.specUrl: URL for the full OpenAPI document