GET
/
settings
Authorization
curl --request GET \
  --url https://api.sandbox.metriport.com/settings \
  --header 'x-api-key: <x-api-key>'
import { MetriportDevicesApi } from "@metriport/api-sdk";

const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");

const response = await metriportClient.getSettings();

​
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.

Example response:

{
  "id": "<settings-id>",
  "webhookUrl": "https://server.domain.com/webhook/endpoint",
  "webhookKey": "<webhook-key>"
}
Error ResponsesUpdate Settings