GET/api/users/invites

List user invites

Lists all pending invites for the account. Only available when embedded IdP is enabled.

5 status codes
200List of invites
auto_groupsarray<string>required
Group IDs to auto-assign to peers registered by this user
created_atstringrequired
Invite creation time
emailstringrequired
User's email address
expiredbooleanrequired
Whether the invite has expired
expires_atstringrequired
Invite expiration time
idstringrequired
Invite ID
invite_tokenstringoptional
The invite link to be shared with the user. Only returned when the invite is created or regenerated.
namestringrequired
User's full name
rolestringrequired
User's NetBird account role
401Requires authentication
403Forbidden
412Precondition failed - embedded IdP is not enabled
500Internal Server Error

Error handling

A 401 is returned: Requires authentication. A 403 is returned: Forbidden. A 412 is returned: Precondition failed - embedded IdP is not enabled. A 500 is returned: Internal Server Error.