---
title: "Get Node List"
method: GET
path: "/nodes"
tags: ["Nodes"]
---

# Get Node List

`GET /nodes`

Get a list of nodes with their associated node groups

## Query parameters

- `filter` string — Filter query
- `page` integer — Page number
- `size` integer — Page size
- `sort` string — Sort options

## Response `200`

OK

- ControllersListResponseGithubModelsNodeDTO
  - `data` ModelsNodeDTO[]
    - `Node` ModelsNode — The data to update
      - `_id` string, objectid — ID
      - `active` boolean — Active
      - `active_at` string, date-time — Active at
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `current_runners` integer — Current runners
      - `description` string — Description
      - `enabled` boolean — Enabled
      - `hostname` string — Hostname
      - `ip` string — IP
      - `is_master` boolean — Is master
      - `key` string — Type
      - `mac` string — MAC
      - `max_runners` integer — Max runners
      - `name` string — Name
      - `status` string — Status
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
    - `node_groups` ModelsNodeGroup[] — Associated node group
      - `_id` string, objectid — ID
      - `active_count` integer — Active nodes in group (computed)
      - `created_at` string, date-time — Created timestamp
      - `created_by` string, objectid — Created by
      - `description` string — Node group description
      - `name` string — Node group name
      - `node_ids` string[] — Node IDs in this group
      - `total_count` integer — Total nodes in group (computed)
      - `updated_at` string, date-time — Updated timestamp
      - `updated_by` string, objectid — Updated by
  - `error` string
  - `message` string
  - `status` string
  - `total` integer

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `500` — Internal Server Error

---

[API](https://skmtc.net/crawlab-team/apis/crawlab-api.md) · [All operations](https://skmtc.net/crawlab-team/apis/crawlab-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/crawlab-team/crawlab-api/revisions/c7a4715c1f13/schema)