Skip to content

Nextvisit API (1.0.0)

API for the Nextvisit Clinical Documentation platform for developers

Download OpenAPI description
openapi.json
openapi.yaml
Overview
Nextvisit Support
hello@nextvisit.ai
License
Proprietary
Terms of Service
Languages
Servers
Mock server
https://developers.nextvisit.app/_mock/openapi
Production API
https://nextvisit.app/api
Beta API
https://ea.nextvisit.app/api

Tokens

User token management endpoints for secure access to the Nextvisit platform. Includes login, logout, and token management operations.

Operations

Create a new access token

Request

Authenticates a user and issues a new access token. When API token verification is enabled (server configuration), users with enhanced security (2FA enabled or linked social providers like Google/Apple) must complete additional verification. Users with 2FA provide their authenticator code via two_factor_code. Users with linked social providers (without 2FA) receive a 6-digit OTP via email and provide it via otp_code.

Bodyapplication/jsonrequired
emailstring(email)required

User's email address

Example: "user@nextvisit.app"
passwordstring(password)required

User's password

Example: "secureP@ssw0rd!"
device_namestringrequired

Name of the device requesting the token

Example: "iPhone 14 Pro"
two_factor_codestring

TOTP code from authenticator app (required for users with 2FA enabled when API token verification is active). Recovery codes can also be used.

Example: "123456"
otp_codestring

6-digit verification code sent via email (required for users with linked social providers when API token verification is active)

Example: "123456"
curl -i -X POST \
  https://developers.nextvisit.app/_mock/openapi/v1/auth/tokens \
  -H 'Content-Type: application/json' \
  -d '{
    "email": "john.doe@example.com",
    "password": "securepassword123",
    "device_name": "iPhone 14 Pro"
  }'

Responses

Token successfully created

Bodyapplication/json
statusstringrequired

Status of the token request

Example: "success"
tokenstringrequired

Authentication token value

Example: "nv-sk-2|4qrD6iCn5FYhHyrdVX1IE4kk6RWg091WpboNklOC"
token_idintegerrequired

Unique identifier for the token

Example: 123
userobjectrequired

Basic information about the authenticated user

user.​idinteger

User's unique identifier

Example: 1
user.​namestring

User's full name

Example: "John Doe"
user.​current_team_idinteger

ID of the user's current team

Example: 5
user.​emailstring(email)

User's email address

Example: "john.doe@example.com"
teamobjectrequired

Basic information about the user's current team

team.​idinteger

Team's unique identifier

Example: 5
team.​namestring

Name of the team

Example: "Medical Practice"
Response
application/json
{
  "status": "success",
  "token": "nv-sk-2|4qrD6iCn5FYhHyrdVX1IE4kk6RWg091WpboNklOC",
  "token_id": 123,
  "user": {
    "id": 1,
    "name": "John Doe",
    "current_team_id": 5,
    "email": "john.doe@example.com"
  },
  "team": {
    "id": 5,
    "name": "Medical Practice"
  }
}

List all access tokens

Request

Returns a list of the authenticated user's access tokens

Security
bearerAuth
curl -i -X GET \
  https://developers.nextvisit.app/_mock/openapi/v1/auth/tokens \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

List of tokens

Bodyapplication/json
tokensArray of objects(TokenInfo)
Response
application/json
{
  "tokens": [
    { … },
    { … }
  ]
}

Revoke current token

Request

Revokes the current access token used for authentication

Security
bearerAuth
curl -i -X DELETE \
  https://developers.nextvisit.app/_mock/openapi/v1/auth/tokens/current \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Token successfully revoked

Bodyapplication/json
messagestring

Status message

Example: "Token revoked"
Response
application/json
{
  "message": "Token revoked"
}

Revoke specific token

Request

Revokes a specific access token by ID

Security
bearerAuth
Path
idinteger(int64)required

Identifier for a token

curl -i -X DELETE \
  'https://developers.nextvisit.app/_mock/openapi/v1/auth/tokens/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Token successfully revoked

Bodyapplication/json
messagestring

Status message

Example: "Token revoked"
Response
application/json
{
  "message": "Token revoked"
}

Authenticate with Google

Request

Authenticates a user using a Google ID token obtained from Google Sign-In (OAuth 2.0). This endpoint supports tokens from web applications, Chrome extensions, iOS apps, and Android apps. If the user doesn't exist, a new account is automatically created.

Bodyapplication/jsonrequired
id_tokenstringrequired

Google ID token obtained from Google Sign-In SDK or OAuth 2.0 flow

Example: "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9..."
device_namestring<= 255 charactersrequired

Name of the device or application requesting the token

Example: "Chrome Extension"
curl -i -X POST \
  https://developers.nextvisit.app/_mock/openapi/v1/auth/google \
  -H 'Content-Type: application/json' \
  -d '{
    "id_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJhY2NvdW50cy5nb29nbGUuY29tIiwiYXpwIjoiMTIzNDU2Nzg5MC5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsImF1ZCI6IjEyMzQ1Njc4OTAuYXBwcy5nb29nbGV1c2VyY29udGVudC5jb20iLCJzdWIiOiIxMjM0NTY3ODkwIiwiZW1haWwiOiJqb2huLmRvZUBleGFtcGxlLmNvbSIsImVtYWlsX3ZlcmlmaWVkIjp0cnVlLCJuYW1lIjoiSm9obiBEb2UiLCJwaWN0dXJlIjoiaHR0cHM6Ly9saDMuZ29vZ2xldXNlcmNvbnRlbnQuY29tL2EvZGVmYXVsdC11c2VyPXM5Ni1jIiwiZ2l2ZW5fbmFtZSI6IkpvaG4iLCJmYW1pbHlfbmFtZSI6IkRvZSIsImxvY2FsZSI6ImVuIiwiaWF0IjoxNjE2MjM5MDIyLCJleHAiOjE2MTYyNDI2MjJ9.signature",
    "device_name": "Chrome Extension"
  }'

Responses

Authentication successful

Bodyapplication/json
statusstringrequired

Status of the authentication request

Example: "success"
tokenstringrequired

Authentication token value

Example: "nv-sk-2|4qrD6iCn5FYhHyrdVX1IE4kk6RWg091WpboNklOC"
token_idintegerrequired

Unique identifier for the token

Example: 123
userobjectrequired
user.​idinteger

User ID

Example: 1
user.​namestring

User's full name

Example: "John Doe"
user.​current_team_idinteger

ID of the user's current team

Example: 5
user.​emailstring

User's email address

Example: "john.doe@example.com"
teamobjectrequired
team.​idinteger

Team ID

Example: 5
team.​namestring

Team name

Example: "Medical Practice"
is_new_userbooleanrequired

Indicates if a new user account was created during this authentication

Example: false
Response
application/json
{
  "status": "success",
  "token": "nv-sk-2|4qrD6iCn5FYhHyrdVX1IE4kk6RWg091WpboNklOC",
  "token_id": 123,
  "user": {
    "id": 1,
    "name": "John Doe",
    "current_team_id": 5,
    "email": "john.doe@example.com"
  },
  "team": {
    "id": 5,
    "name": "Medical Practice"
  },
  "is_new_user": false
}

Users

User account management including profile updates, permission settings, role assignments, and practice affiliations.

Operations

Progress Notes

Clinical progress note management including creating, updating, retrieving, and signing notes with associated transcriptions and analyses.

Operations

Billing

Billing and subscription management including plans, usage tracking, and cost estimates.

Operations

Transcription

Audio transcription services including file upload transcription and temporary API tokens for client-side transcription.

Operations

Patients

Patient management including creating, updating, retrieving, and searching patient records within your team.

Operations