Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/gnmyt/Nexterm/llms.txt

Use this file to discover all available pages before exploring further.

Organizations enable multi-user collaboration in Nexterm. Members of an organization share access to entries, folders, identities, scripts, and snippets that are assigned to the organization. The authenticated user who creates an organization becomes its owner and is responsible for managing membership. All endpoints require authentication via Authorization: Bearer YOUR_TOKEN.

​
GET /api/organization

Returns a list of all organizations that the authenticated user belongs to or owns.

​
Response

Returns an array of organization summaries.
​
[].id
number
Unique organization identifier.
​
[].name
string
Display name of the organization.
​
[].description
string
Optional description of the organization.
​
[].role
string
The authenticated user’s role within the organization (e.g. owner, member).
curl --request GET \
  --url http://your-server:6989/api/organization \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
PUT /api/organization

Creates a new organization. The authenticated user is automatically set as the owner.

​
Request body

​
name
string
required
Display name for the organization. Between 1 and 100 characters.
​
description
string
Optional description. Maximum 500 characters.

​
Response (201)

​
id
number
ID of the newly created organization.
​
name
string
Organization name.
curl --request PUT \
  --url http://your-server:6989/api/organization \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Acme Ops", "description": "Operations team"}'

​
GET /api/organization/:id

Returns detailed information about a specific organization. The authenticated user must be a member.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Response

​
id
number
Organization identifier.
​
name
string
Organization name.
​
description
string
Organization description.
curl --request GET \
  --url http://your-server:6989/api/organization/2 \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
PATCH /api/organization/:id

Updates an existing organization’s name or description. Only the organization owner can call this endpoint.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Request body

At least one field is required.
​
name
string
New display name. Between 1 and 100 characters.
​
description
string
New description. Maximum 500 characters. Pass an empty string to clear it.

​
Response

Returns the updated organization object. 
curl --request PATCH \
  --url http://your-server:6989/api/organization/2 \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"name": "Acme Infrastructure"}'

​
DELETE /api/organization/:id

Permanently deletes an organization and all associated data. Only the organization owner can call this endpoint.
This action is irreversible. All shared resources assigned to the organization — entries, folders, identities, scripts, and snippets — will be affected.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Response

Returns a confirmation object. 
curl --request DELETE \
  --url http://your-server:6989/api/organization/2 \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
GET /api/organization/:id/members

Returns a list of all members in an organization. The authenticated user must be a member of the organization.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Response

Returns an array of member objects.
​
[].accountId
number
Account ID of the member.
​
[].username
string
Username of the member.
​
[].role
string
The member’s role within the organization.
curl --request GET \
  --url http://your-server:6989/api/organization/2/members \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
POST /api/organization/:id/invite

Sends an invitation to another user to join the organization. Only the organization owner can invite users.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Request body

​
username
string
required
Username of the account to invite.

​
Response

Returns a confirmation object. 
curl --request POST \
  --url http://your-server:6989/api/organization/2/invite \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"username": "alice"}'

​
DELETE /api/organization/:id/members/:accountId

Removes a member from an organization. Only the organization owner can remove members.

​
Path parameters

​
id
string
required
Unique identifier of the organization.
​
accountId
string
required
Account ID of the member to remove.

​
Response

Returns a confirmation object. 
curl --request DELETE \
  --url http://your-server:6989/api/organization/2/members/5 \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
GET /api/organization/invitations/pending

Returns a list of all pending organization invitations for the authenticated user.

​
Response

Returns an array of invitation objects.
​
[].id
number
Invitation identifier.
​
[].organizationId
number
ID of the inviting organization.
​
[].organizationName
string
Name of the inviting organization.
curl --request GET \
  --url http://your-server:6989/api/organization/invitations/pending \
  --header 'Authorization: Bearer YOUR_TOKEN'

​
POST /api/organization/invitations/:id/respond

Accepts or declines a pending organization invitation.

​
Path parameters

​
id
string
required
Unique identifier of the invitation.

​
Request body

​
accept
boolean
required
Pass true to accept the invitation, false to decline.

​
Response

Returns a confirmation object. 
curl --request POST \
  --url http://your-server:6989/api/organization/invitations/9/respond \
  --header 'Authorization: Bearer YOUR_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{"accept": true}'

​
POST /api/organization/:id/leave

Allows the authenticated user to leave an organization they are a member of. Organization owners cannot leave — they must transfer ownership or delete the organization first.

​
Path parameters

​
id
string
required
Unique identifier of the organization.

​
Response

Returns a confirmation object. 
curl --request POST \
  --url http://your-server:6989/api/organization/2/leave \
  --header 'Authorization: Bearer YOUR_TOKEN'

Build docs developers (and LLMs) love

Get started for freeTalk to us