List all Accounts | NetBird Read-Only MCP Preview

5 status codes

200A JSON array of accounts

created_atstringrequired

Account creation date (UTC)

created_bystringrequired

Account creator

domainstringrequired

Account domain

domain_categorystringrequired

Account domain category

idstringrequired

Account ID

onboardingobjectrequired

settingsobjectrequired

400Bad Request

401Requires authentication

403Forbidden

500Internal Server Error

Error handling

A 400 is returned: Bad Request. A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 500 is returned: Internal Server Error.

import { NetBirdManagementAPIUnofficialOctriFullPreview } from "netbird-read-only-mcp-preview-sdk";

const client = new NetBirdManagementAPIUnofficialOctriFullPreview({
  baseUrl: "https://api.netbird.io",
  auth: { bearerAuth: process.env.API_TOKEN! },
});

const result = await client.accounts.list();

[
  {
    "created_at": "2023-05-05T09:00:35.477782Z",
    "created_by": "google-oauth2|277474792786460067937",
    "domain": "netbird.io",
    "domain_category": "private",
    "id": "ch8i4ug6lnn4g9hqv7l0",
    "onboarding": {
      "onboarding_flow_pending": false,
      "signup_form_pending": true
    },
    "settings": {
      "agent_network_only": false,
      "auto_update_always": false,
      "auto_update_version": "0.51.2",
      "dashboard_features": {
        "agent_network": true
      },
      "dns_domain": "my-organization.org",
      "embedded_idp_enabled": false,
      "extra": {
        "network_traffic_logs_enabled": true,
        "network_traffic_logs_groups": [
          "ch8i4ug6lnn4g9hqv7m0"
        ],
        "network_traffic_packet_counter_enabled": true,
        "peer_approval_enabled": true,
        "user_approval_required": false
      },
      "groups_propagation_enabled": true,
      "ipv6_enabled_groups": [
        "ch8i4ug6lnn4g9hqv7m0"
      ],
      "jwt_allow_groups": [
        "Administrators"
      ],
      "jwt_groups_claim_name": "roles",
      "jwt_groups_enabled": true,
      "lazy_connection_enabled": true,
      "local_auth_disabled": false,
      "local_mfa_enabled": false,
      "metrics_push_enabled": false,
      "network_range": "example_value",
      "network_range_v6": "fd00:1234:5678::/64",
      "peer_expose_enabled": false,
      "peer_expose_groups": [
        "ch8i4ug6lnn4g9hqv7m0"
      ],
      "peer_hostname_collision_rejected": false,
      "peer_inactivity_expiration": 43200,
      "peer_inactivity_expiration_enabled": true,
      "peer_login_expiration": 43200,
      "peer_login_expiration_enabled": true,
      "regular_users_view_blocked": true,
      "routing_peer_dns_resolution_enabled": true
    }
  }
]

Response

Errors