Metriport home pagelight logo
  1. Settings
  2. Get Settings
GET

/settings

x-api-key*
curl --request GET \
     --url https://api.metriport.com/settings \
     --header 'x-api-key: AUTH_VALUE'

​
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 { Metriport } 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>"
}