Skip to main content
GET
/
settings
Get Settings
curl --request GET \
  --url https://api.sandbox.metriport.com/settings \
  --header 'x-api-key: <api-key>'
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");

const response = await metriportClient.getSettings();

Documentation Index

Fetch the complete documentation index at: https://docs.metriport.com/llms.txt

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

​
Response

​
id
string
required
The settings ID.
​
webhookUrl
string
required
Your application’s webhook URL.
​
webhookKey
string
required
The key used to authenticate webhook calls to your app.
import { MetriportMedicalApi } from "@metriport/api-sdk";

const metriportClient = new MetriportMedicalApi("YOUR_API_KEY");

const response = await metriportClient.getSettings();
Example response: 
{
  "id": "<settings-id>",
  "webhookUrl": "https://server.domain.com/webhook/endpoint",
  "webhookKey": "<webhook-key>"
}