Table of Contents

API : Customer Get name

Introduction

This request will return the the id and name of the specified customer. This is typically used when a customer is directly referenced and we need to display the name of the customer and also know if we may access this customer.

Request

URL https://api.telecomx.dk/customer/CUSTOMER_ID/name
Method GET
Access level PERSONAL, VIEWER, MANAGER or OWNER if user belongs to the customer (PERSONAL only for their own customer).
RESELLER if customer belongs to the reseller or a sub reseller.
RESELLER_ADMIN.
ADMIN.
Param CUSTOMER_ID Id of the customer (24 hex-char string)

Query example

https://api.telecomx.dk/customer/1234567890ABCDEF12345678/name

Response

Json object
_id Id Unique customer id
name String Name of the customer
parentReseller Id Id of reseller customer belongs to
features Array List of features the customer has access to: CUSTOMER, SIP, MVNO, PBX, DNS, INTERNET, IPTVPRIVATE, IPTVBUSINESS, FLEXCARE, ZEROTIER, EXTERNAL_LICENSES, NETWORK_MANAGEMENT, DIALOG, CHANGELOG, ORGANIZATION.
Integrations
integrations Object Which 3rd party integrations the customer has enabled. Only the enabled flag of each integration is returned - never its settings or credentials (tokens, usernames, passwords, client secrets), as this endpoint is open to every access level. A user who may update the customer gets the full settings from Customer Get.
integrations.billing.economic.enabled Boolean True if the visma e-conomic integration is enabled, default false.
integrations.billing.rackbeat.enabled Boolean True if the Rackbeat integration is enabled, default false.
integrations.billing.uniconta.enabled Boolean True if the Uniconta integration is enabled, default false.
integrations.licenses.also.enabled Boolean True if licenses are synchronized from ALSO, default false.
integrations.ms365.enabled Boolean True if the Microsoft 365 integration is enabled, default false.
integrations.mvnoPrivate.enabled Boolean True if the MVNO integration for private customers is enabled, default false.
integrations.criipto.enabled Boolean True if the Criipto integration is enabled, default false.

Example

{
  "_id": "650000000000000000000101",
  "name": "Example Company",
  "parentReseller": "650000000000000000000201",
  "features": ["CUSTOMER", "SIP", "MVNO"],
  "integrations": {
    "billing": {
      "economic": { "enabled": true },
      "rackbeat": { "enabled": false },
      "uniconta": { "enabled": false }
    },
    "licenses": { "also": { "enabled": true } },
    "ms365": { "enabled": true },
    "mvnoPrivate": { "enabled": true },
    "criipto": { "enabled": false }
  }
}

Errors

Error code Message Description
422 id Customer id is invalid
404 customer Customer not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>