How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
NetBird

NetBird Users API

Interact with and view information about users.

Documentation Provider Profile APIs.io OpenAPI GitHub

NetBird Users API is one of 39 APIs that NetBird publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 15 operations across 12 paths, and defines 12 schemas. It is described by OpenAPI 3.2.0, at version 0.0.1.

Requests are made against a single base URL, https://api.netbird.io.

15 operations 12 paths 12 schemas 3 DELETE4 GET6 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.1
Base URL
https://api.netbird.io
Authentication
HTTP Bearer, API Key
Resource Areas
1

Authentication & Security 2

NetBird Users API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). An API key is passed in the header as Authorization (TokenAuth). By default, every request must be authenticated.

  • TokenAuth — Enter the token with the Token prefix, e.g. "Token nbpF3f0d.....".

Paths & Operations 15

Across 12 paths, the API surfaces 15 operations — 3 DELETE, 4 GET, 6 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 15

Interact with and view information about users.

GET
/api/users
List all Users
1 param → 200400401403500
POST
/api/users
Create a User
body → 200400401403500
PUT
/api/users/{userId}
Update a User
1 param body → 200400401403500
DELETE
/api/users/{userId}
Delete a User
1 param → 200400401403500
POST
/api/users/{userId}/invite
Resend user invitation
1 param → 200400401403500
POST
/api/users/{userId}/approve
Approve user
1 param → 200400401403500
DELETE
/api/users/{userId}/reject
Reject user
1 param → 200400401403500
PUT
/api/users/{userId}/password
Change user password
1 param body → 200400401403412500
GET
/api/users/current
Retrieve current user
→ 200400401403500
GET
/api/users/invites
List user invites
→ 200401403412500
POST
/api/users/invites
Create a user invite
body → 200400401403409412422500
DELETE
/api/users/invites/{inviteId}
Delete a user invite
1 param → 200401403404412500
POST
/api/users/invites/{inviteId}/regenerate
Regenerate a user invite
1 param body → 200400401403404412422500
GET
/api/users/invites/{token}
Get invite information
1 param → 200400404500
POST
/api/users/invites/{token}/accept
Accept an invite
1 param body → 200400404412422500

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are User (15 properties), UserInvite (9 properties), UserInviteInfo (5 properties), UserInviteCreateRequest (5 properties). Each schema is shown below with its type and property counts.

UserPermissions
object
2 properties 2 required
UserInviteRegenerateResponse
object
Response after regenerating an invite
2 properties 2 required
PasswordChangeRequest
object
2 properties 2 required
User
object
15 properties 8 required
UserInviteAcceptRequest
object
Request to accept an invite and set password
1 property 1 required
UserInviteRegenerateRequest
object
Request to regenerate an invite link
1 property
UserInviteCreateRequest
object
Request to create a user invite link
5 properties 4 required
UserInvite
object
A user invite
9 properties 8 required
UserInviteAcceptResponse
object
Response after accepting an invite
1 property 1 required
UserRequest
object
3 properties 3 required
UserInviteInfo
object
Public information about an invite
5 properties 5 required
UserCreateRequest
object
5 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

netbird-users-api-openapi.yml Raw ↑

Other APIs NetBird publishes across the network.

NetBird Accounts API
AE Profile APIs.io
NetBird AWS Marketplace API
AE Profile APIs.io
NetBird Checkout API
AE Profile APIs.io
NetBird DNS API
AE Profile APIs.io
NetBird DNS Zones API
AE Profile APIs.io
NetBird EDR Falcon Integrations API
AE Profile APIs.io
NetBird EDR FleetDM Integrations API
AE Profile APIs.io
NetBird EDR Huntress Integrations API
AE Profile APIs.io
NetBird EDR Intune Integrations API
AE Profile APIs.io
NetBird EDR Peers API
AE Profile APIs.io
NetBird EDR SentinelOne Integrations API
AE Profile APIs.io
NetBird Event Streaming Integrations API
AE Profile APIs.io
#User
← Back to N APIs
API Details
ID
netbird:netbird-users-api
Base URL
https://api.netbird.io
Docs
https://docs.netbird.io/
Provider
NetBird
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=netbird-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/netbird-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of NetBird Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.