> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nearnode.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List Nodes

> Retrieve all nodes in your organization.

### Query Parameters

<ParamField query="status" type="string">
  Filter by lifecycle status. One of `draft`, `in_production`, `active`, `paused`, `lost`, `retired`.
</ParamField>

<ParamField query="function_type" type="string">
  Filter by payload type. One of `redirect`, `vcard`, `wifi`, `microsite`, `digital_card`, `action`.
</ParamField>

<ParamField query="batch_id" type="string">
  Filter by batch ID to list nodes from a specific batch.
</ParamField>

<ParamField query="limit" type="integer" default="50">
  Number of results per page (max 100).
</ParamField>

<ParamField query="offset" type="integer" default="0">
  Pagination offset.
</ParamField>

### Response

<ResponseField name="data" type="array">
  Array of node objects.
</ResponseField>

<ResponseField name="total" type="integer">
  Total number of matching nodes.
</ResponseField>

<RequestExample>
  ```bash cURL theme={null}
  curl https://nearnode.io/api/v1/nodes?status=active&limit=10 \
    -H "Authorization: Bearer sk_live_..."
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "data": [
      {
        "id": "node_abc123...",
        "slug": "k9m2xp4q",
        "label": "Office Front Door",
        "url": "https://nearnode.io/v/k9m2xp4q",
        "function_type": "redirect",
        "payload": {
          "url": "https://acme.com/welcome"
        },
        "status": "active",
        "scan_count": 1247,
        "created_at": "2026-02-10T10:00:00Z"
      }
    ],
    "total": 42
  }
  ```
</ResponseExample>