Table of Contents

API : HelpCenterSettings : List

Introduction

Returns the HelpCenterSettings of the caller's own organisation. The result is an array with zero or one element.

Request

URL https://api.telecomx.dk/helpcenter/helpcentersettings
Method GET
Access level RESELLER_ADMIN with HELPCENTER feature, or ADMIN.

Query example

https://api.telecomx.dk/helpcenter/helpcentersettings

Response

Array of HelpCenterSettings.

JSON object
_id ObjectId Id of the customer this Helpcenter belongs to.
name String Name of the customer this Helpcenter belongs to.
helpCenters Array Settings for each of the customer's help centers, see definition below.
helpCenters[].id ObjectId Id of the helpcenter.
helpCenters[].name String Name of Helpcenter.
helpCenters[].applicationId String ApplicationId (GUID) used to authenticate with Microsoft.
helpCenters[].tenantId String TenantId (GUID) used to authenticate with Microsoft.
helpCenters[].appClientValue String ClientSecret used to authenticate with Microsoft.
helpCenters[].emailAddress String Emailaddress of the support email that the Helpcenter will belong to.
helpCenters[].signature String Signature stored for auto use when sending emails.
helpCenters[].startDate String Date of when Help Center should retrieve mails FROM.
helpCenters[].initialized Boolean True when the help center has completed its initial mail import.
helpCenters[].authSettings Object Settings for accessToken.
helpCenters[].authSettings.accessToken String Access token received from Microsoft, used as bearer token. Valid for 1 hour.
helpCenters[].authSettings.expires Date Date of expiration for accessToken.
helpCenters[].subscription Object Settings for subscription to Graph.
helpCenters[].subscription.id String Id for subscription. Used to receive change notifications.
helpCenters[].subscription.clientState String Randomly generated clientState used to validate the request. Set up when creating a subscription.
helpCenters[].subscription.resource String Uri to the specific email inbox to listen to.
helpCenters[].subscription.created Date Date of creation of subscription.
helpCenters[].subscription.expires Date Date of expiration of subscription.
helpCenters[].subscription.changeTypes Array Change types received from Microsoft: 'created', 'updated', 'deleted'.

Example

[
  {
    "_id": "650000000000000000000003",
    "name": "Example ApS",
    "helpCenters": [
      {
        "id": "650000000000000000000001",
        "name": "Example Support",
        "applicationId": "00000000-0000-0000-0000-000000000000",
        "tenantId": "00000000-0000-0000-0000-000000000000",
        "appClientValue": "<CLIENT_SECRET>",
        "emailAddress": "support@example.dk",
        "signature": "Best regards, Example Support",
        "startDate": "01-03-2026",
        "initialized": true,
        "authSettings": {
          "accessToken": "<ACCESS_TOKEN>",
          "expires": "2026-03-01T12:34:56.123Z"
        },
        "subscription": {
          "id": "<SUBSCRIPTION_ID>",
          "clientState": "<CLIENT_STATE>",
          "resource": "users/support@example.dk/mailFolders('Inbox')/messages",
          "created": "2026-01-01T12:34:56.123Z",
          "expires": "2026-01-04T12:34:56.123Z",
          "changeTypes": [ "created", "updated" ]
        }
      }
    ]
  }
]

Errors

Error code Message Description
404 helpCenterSettings No HelpCenterSettings found
403 access_denied Insufficient access level
500 internal_error <Unspecified>