Get user settings

This page describes how to get the user settings for your account using the Management API.

For more information about user settings, see User Settings.

User Settings - Management API

This section provides a basic example of how to get the user settings for your account using the Management API.

Authentication

These requests require an access token, as described in Authenticate.

Get user settings

To get user settings from the Management API, use the GET <https://api.symbl.ai/v1/manage/settings> operation.

import fetch from 'node-fetch';

const accessToken = '<ACCESS_TOKEN>';


const fetchResponse = await fetch(`https://api.symbl.ai/v1/manage/settings`, {
  method: get,
  headers: {
    'Authorization': `Bearer ${accessToken}`,
    'Content-Type': 'application/json'
  }
});

const responseBody = await fetchResponse.json();

console.log(responseBody);

Where:

<ACCESS_TOKEN> is a valid API access token.

Response

This response returns only settings that have been configured using Update user settings. For example, if no user settings are configured, the response body for this request is empty.

The following table describes the response body that is returned by this request. The fields are all contained in a settings object in the response.

Field	Description
`intelligence`	Contains settings objects for Symbl.ai’s conversation intelligence features.
`intelligence.bookmarks`	Contains settings for the Bookmarks feature.
`intelligence.bookmarks.duration`	In seconds, the default duration for a bookmark.
`redaction`	Contains settings for the Redaction feature.
`redaction.default`	Whether redaction is enabled by default.
`redaction.type`	The type of redaction that is used by default. If the value is `default`, redacted entities are replaced with the name of the managed entity. For example, the sentence `My name is Tony Stark` becomes `My name is [PERSON_NAME]`. If the value is `obfuscation`, redacted entities are replaced with asterisks. For example, the sentence `My name is Tony Stark` becomes `My name is [****]`. If the value is `custom`, redacted entities are replaced with custom values specified in the `custom` object. For example, the sentence `My name is Tony Stark` can become `My name is [John_Doe]`.
`redaction.custom`	Contains the definitions for custom redaction of detected entities. These values are only used if `redaction.type` is `custom`.
`redaction.custom.default`	The type of redaction that is used if no custom definition for a detected entity is found.
`redaction.custom.<ENTITY_SUBTYPE>`	The replacement value for the corresponding entity if detected and redaction is enabled. There may be zero or more definitions in the `custom` object.
`redaction.exclude`	An array of entity subtypes. These entities are excluded from redaction, if redaction is enabled.

Example Response

{
  "settings": {
    "id": "5624147351175168",
    "intelligence": {
      "bookmarks": {
        "duration": 30
      }
    },
    "redaction": {
      "default": true,
      "type": "custom",
      "custom": {
        "default": "obfuscation",
        "SSN": "Social Security Number",
        "DRIVERS_LICENSE": "Personal ID"
      },
      "exclude": [
        "PERSON_NAME",
        "EMAIL_ADDRESS"
      ]
    }
  }
}