Sign in

v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB
Customers

Get customer details

Returns information about a customer using Customer ID.

get/msp/v3/customers/{customerID}

Path parameters

customerIDstring required

Specify the unique ID of the customer you wish to update. Get the ID of the customer using the 'List all customers' API.

Query parameters

includeFeaturesboolean

Specify whether customer features should be included in the response.

Headers

Authorizationstring required

Specify the Bearer access token

Response

Ok

idstring

The unique ID of the customer. Example - 'bde7f8c2-d063-4a4a-9a8f-c2ea5aff42f3-198'

accountNamestring

The Account name of the customer. Example - Druva

addressstring

The postal address of the customer. Example - '213 Derrick Street Boston, MA 02130 USA'.

phonestring

The contact number of the customer. Example - '12345678910'.

customerNamestring

The name of the customer. Example - 'Druva'

featuresobject[]

The features subscribed by the customer.

tenantAdminsinteger[]

The unique IDs of the tenant admins assigned to the customer. Example - [1]

statusinteger

The current status of the customer account creation in the MSP Console. Example - 1

  • 0 - Creation pending
  • 1 - Ready
  • 2 - Tenant processing
createdOnstring date-time

The date and time when the customer was created in the MSP Console. Example - '2022-10-25T00:00:00Z'

activeSincestring date-time

The date and time since the customer is in Active state in MSP Console. Example - '2022-10-25T00:00:00Z'.

cloudinteger

The cloud where customer account is present. Example - 1

  • 0 - Public
  • 1 - FIPS
  • 2 - FedRamp

Example response

{
  "id": "bde7f8c2-d063-4a4a-9a8f-c2ea5aff42f3-198",
  "accountName": "Druva",
  "address": "213 Derrick Street Boston, MA 02130 USA",
  "phone": "12345678910",
  "customerName": "Druva",
  "features": [
    {
      "name": "Security Posture and Observability"
    }
  ],
  "tenantAdmins": [
    1,
    2,
    3
  ],
  "status": 1,
  "createdOn": "2022-10-25T00:00:00Z",
  "activeSince": "2022-10-25T00:00:00Z",
  "attributes": [
    {
      "name": "licenseManagementAllowed",
      "value": "1"
    }
  ],
  "cloud": 1
}