Table of Contents

Retrieve AvePoint Product Overview

Use this API to retrieve the number of purchased user seats for AvePoint products of the customer.

Permission

The following permission is required to call the API.
You must register an app through Elements > API app registration to authenticate and authorize your access to Elements API. For details, refer to App Registration.

API Permission
/partner/external/v3/general/customers/{customerId}/avpt-products/type/{productType}/overview elements.license.read.all

Request

This section outlines the details of the HTTP method and endpoint used to retrieve the purchased user seats for AvePoint products of the customer.

Method Endpoint Description
GET /partner/external/v3/general/customers/{customerId}/avpt-products/type/{productType}/overview Retrieve the purchased user seats for AvePoint products of the customer.

URL Parameters

This section outlines the parameters required to specify which customer and product you want to retrieve.

Parameter Description Type Required
customerId The ID of the customer. string Yes
productType The product type.
  • 1 - DocAve Online
  • 4 - Cloud Governance
  • 32 - Cloud Backup for Salesforce
  • 40 - Baseline management
  • 41 - Risk management
  • 42 - Workspace management
  • 49 - User management
  • 60 - MyHub
  • 65 - WorkSpace management - storage optimization
  • 257 - TyGraph
  • 2048 - Cloud Backup for Microsoft 365
  • 4096 - Cloud Management
  • 8192 - Cloud Archiving
  • 65536 - Opus
  • 131072 - Cloud Backup for Dynamics 365
  • 4194304 - Insights
  • 8388608 - Policies for Microsoft 365
  • 16777216 - Fly
  • 33554432 - Cloud Backup for Google Workspace
  • 67108864 - Cense
  • 134217728 - Enpower
  • 1073741824 - Cloud Backup for IaaS + PaaS
 integer Yes

Response

If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body.

Field Description Type
productType The product type.
  • 1 - DocAve Online
  • 4 - Cloud Governance
  • 32 - Cloud Backup for Salesforce
  • 40 - Baseline management
  • 41 - Risk management
  • 42 - Workspace management
  • 49 - User management
  • 60 - MyHub
  • 65 - WorkSpace management - storage optimization
  • 257 - TyGraph
  • 2048 - Cloud Backup for Microsoft 365
  • 4096 - Cloud Management
  • 8192 - Cloud Archiving
  • 65536 - Opus
  • 131072 - Cloud Backup for Dynamics 365
  • 4194304 - Insights
  • 8388608 - Policies for Microsoft 365
  • 16777216 - Fly
  • 33554432 - Cloud Backup for Google Workspace
  • 67108864 - Cense
  • 134217728 - Enpower
  • 1073741824 - Cloud Backup for IaaS + PaaS
 string
purchasedUserSeat The number of purchased user seats of the product. integer

Request Sample

To use this API, send a GET request to the specified endpoint, including necessary parameters as defined in the references.

https://graph.avepointonlineservices.com/partner/external/v3/general/customers/f162****-b9d4-****-a165-97db****fc15/avpt-products/type/2048/overview

Response Sample

If the request has been successfully processed, a 200 OK response will be returned along with the requested information displayed in the response body. For more details on the HTTP status code, refer to Http Status Code.

 {
        "productType": 2048, // The product type: 2048 represents Cloud Backup for Microsoft 365
        "purchasedUserSeat": 25 // The number of purchased user seats of the customer
}