Overview

Introduction

Flow overview

Requirements

Versioning

Authentication

Server authentication

Incoming APIs

Overview

Provision user

Create encounter

Open existing encounter

Open settings

Manage user status

Outgoing APIs

Overview

Callback authentication

Response protocol

Callback types

Reference

Changelog

This endpoint should be called by your backend when the provider needs to open their Nabla settings, with no encounter involved.

Method: POST

Path: <baseUrl>/settings/url

Available from version 2026-09-15.

Nabla will match the user corresponding to your provider and return a one-time URL your frontend should navigate to.

Navigating to this URL will log in the provider into Nabla automatically and open the settings screen.

⚠️ The URL can only be used once and expires in 10 minutes. The URL must not be stored.

👤 The provider must already exist in Nabla. Use Provision user first if needed.

Request payload

{
  "external_provider_id": string
}

Response

{ "settings_url": string }