Create Node - NearNode

curl -X POST https://nearnode.io/api/v1/nodes \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Lobby Entrance",
    "function_type": "redirect",
    "payload": {
      "url": "https://acme.com/checkin"
    }
  }'

const response = await fetch('https://nearnode.io/api/v1/nodes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    label: 'Lobby Entrance',
    function_type: 'redirect',
    payload: {
      url: 'https://acme.com/checkin',
    },
  }),
});

const { data } = await response.json();
console.log(data.url); // https://nearnode.io/v/o1ulpplq

import requests

response = requests.post(
    "https://nearnode.io/api/v1/nodes",
    headers={"Authorization": "Bearer sk_live_..."},
    json={
        "label": "Lobby Entrance",
        "function_type": "redirect",
        "payload": {
            "url": "https://acme.com/checkin",
        },
    },
)

data = response.json()["data"]
print(data["url"])  # https://nearnode.io/v/o1ulpplq

{
  "data": {
    "id": "node_123abc-def4-5678-ghij-klmnopqrstuv",
    "slug": "o1ulpplq",
    "url": "https://nearnode.io/v/o1ulpplq",
    "function_type": "redirect",
    "status": "active"
  }
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Validation failed",
  "details": {
    "function_type": "Must be one of: redirect, vcard, wifi, microsite, digital_card, action"
  }
}

POST

api

nodes

curl -X POST https://nearnode.io/api/v1/nodes \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Lobby Entrance",
    "function_type": "redirect",
    "payload": {
      "url": "https://acme.com/checkin"
    }
  }'

const response = await fetch('https://nearnode.io/api/v1/nodes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    label: 'Lobby Entrance',
    function_type: 'redirect',
    payload: {
      url: 'https://acme.com/checkin',
    },
  }),
});

const { data } = await response.json();
console.log(data.url); // https://nearnode.io/v/o1ulpplq

import requests

response = requests.post(
    "https://nearnode.io/api/v1/nodes",
    headers={"Authorization": "Bearer sk_live_..."},
    json={
        "label": "Lobby Entrance",
        "function_type": "redirect",
        "payload": {
            "url": "https://acme.com/checkin",
        },
    },
)

data = response.json()["data"]
print(data["url"])  # https://nearnode.io/v/o1ulpplq

{
  "data": {
    "id": "node_123abc-def4-5678-ghij-klmnopqrstuv",
    "slug": "o1ulpplq",
    "url": "https://nearnode.io/v/o1ulpplq",
    "function_type": "redirect",
    "status": "active"
  }
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Validation failed",
  "details": {
    "function_type": "Must be one of: redirect, vcard, wifi, microsite, digital_card, action"
  }
}

Body

label

string

required

The internal name for this node (e.g., “Conference Room A”).

function_type

string

required

The payload type. One of redirect, vcard, wifi, microsite, digital_card, or action.

payload

object

required

Type-specific configuration object. See Node Types for payload schemas per type.Redirect: { "url": "https://..." }vCard: { "first_name": "...", "last_name": "...", "email": "...", "phone": "..." }WiFi: { "ssid": "...", "password": "...", "security": "WPA2" }Action: { "action_type": "whatsapp", "phone": "...", "message": "..." }

template_id

string

Bind to a template for enforced brand consistency. Locked fields cannot be overridden.

Response

data

object

Show properties

string

The UUID of the node.

slug

string

The 8-char short code (e.g., o1ulpplq).

url

string

The public scan URL (e.g., https://nearnode.io/v/o1ulpplq).

function_type

string

The payload type.

status

string

The lifecycle status. New nodes start as active.

curl -X POST https://nearnode.io/api/v1/nodes \
  -H "Authorization: Bearer sk_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "label": "Lobby Entrance",
    "function_type": "redirect",
    "payload": {
      "url": "https://acme.com/checkin"
    }
  }'

const response = await fetch('https://nearnode.io/api/v1/nodes', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer sk_live_...',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    label: 'Lobby Entrance',
    function_type: 'redirect',
    payload: {
      url: 'https://acme.com/checkin',
    },
  }),
});

const { data } = await response.json();
console.log(data.url); // https://nearnode.io/v/o1ulpplq

import requests

response = requests.post(
    "https://nearnode.io/api/v1/nodes",
    headers={"Authorization": "Bearer sk_live_..."},
    json={
        "label": "Lobby Entrance",
        "function_type": "redirect",
        "payload": {
            "url": "https://acme.com/checkin",
        },
    },
)

data = response.json()["data"]
print(data["url"])  # https://nearnode.io/v/o1ulpplq

{
  "data": {
    "id": "node_123abc-def4-5678-ghij-klmnopqrstuv",
    "slug": "o1ulpplq",
    "url": "https://nearnode.io/v/o1ulpplq",
    "function_type": "redirect",
    "status": "active"
  }
}

{
  "error": "Invalid or missing API key"
}

{
  "error": "Validation failed",
  "details": {
    "function_type": "Must be one of: redirect, vcard, wifi, microsite, digital_card, action"
  }
}

API Reference List Nodes

​Body

​Response

Body

Response