Settings
Get Settings
Settings
Get Settings
Gets the settings for your account.
GET
/settings
x-api-key*
curl --request GET \
--url https://api.metriport.com/settings \
--header 'x-api-key: <x-api-key>'
Response
idrequired
string
The settings ID.
webhookUrlrequired
string
Your application’s webhook URL.
webhookKeyrequired
string
The key used to authenticate webhook calls to your app.
import { MetriportDevicesApi } from "@metriport/api";
const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");
const response = await metriportClient.getSettings();
Example response:
{
"id": "<settings-id>",
"webhookUrl": "https://server.domain.com/webhook/endpoint",
"webhookKey": "<webhook-key>"
}
curl --request GET \
--url https://api.metriport.com/settings \
--header 'x-api-key: <x-api-key>'
import { MetriportDevicesApi } from "@metriport/api";
const metriportClient = new MetriportDevicesApi("YOUR_API_KEY");
const response = await metriportClient.getSettings();