---
title: "Get Nodes"
method: GET
path: "/v1/nodes"
tags: ["V1 - Platform"]
---

# Get Nodes

`GET /v1/nodes`

## Request

- Base URL: `https://api.app.noxus.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.app.noxus.ai/v1/nodes`
- Auth: API key in header `X-API-Key`

## Response `200`

Successful Response

- NodeDefinition[]
  - `inputs` unknown[], required
    - unknown
  - `outputs` unknown[], required
    - unknown
  - `details` unknown[], required
    - unknown
  - `config` object, required
  - `type` string, required
  - `color` string, required
  - `image` string, nullable
  - `title` string, nullable
  - `description` string, nullable
  - `small_description` string, nullable
  - `documentation_url` string, nullable
  - `category` string, nullable
  - `sub_category` string, nullable
  - `example` string, nullable
  - `ai_instructions` string, nullable
  - `integrations` union[], nullable
    - union
      - string
      - string[]
  - `providers` string[], nullable
  - `config_endpoint` string, nullable
  - `subflow_config` SubflowConfig
    - `workflow_id` string, required
    - `workflow_name` string, required
    - `workflow_nodes` string[]
  - `is_valid` boolean, nullable
  - `visible` boolean
  - `superseded_by` string, nullable
  - `is_tool` boolean
  - `is_available` boolean
  - `show_to_user` boolean
  - `paywalled` boolean
  - `plugin_id` string, nullable
  - `plugin_name` string, nullable
  - `supports_mocking` boolean
  - `deletable` boolean
  - `unique` boolean
  - `supports_error_handling` boolean
  - `supports_iteration` boolean
  - `no_repeated_names` boolean
  - `allowed_in_flow_types` string[]
  - `pinned_fields` string[]
  - `picker_priority` integer
  - `output_paths` string[]
  - `input_paths` string[]
  - `v2_ready` boolean
  - `accepts_inline_files` boolean
  - `default_output_type` unknown[], nullable
    - unknown
  - `gathers_list` boolean
  - `gather_fields` string[]
  - `is_loop_scope` boolean
  - `scope_only_outputs` string[]
  - `referenced_assets` ReferencedAssetField[]
    - `config_field` string, required
    - `kind` 'workflow' | 'assistant', required
    - `label` string, nullable

---

[API](https://skmtc.dev/noxus/apis/noxus-backend.md) - [All operations](https://skmtc.dev/noxus/apis/noxus-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/noxus/apis/noxus-backend/revisions/0e37810b7ad5?raw)