Get account transfer details
Knowledge Base
Categories: Google Workspace API
Get Google Workspace Account Transfer Details Using the API
When you want to retrieve transfer requirements for a Google Workspace order using the API. This article explains how to fetch the minimum required seats, associated plan ID, regional API endpoints, and common transfer authorization errors.
Description
Gets the minimum number of accounts required to be purchased when transferring a Google Workspace Order.
Parameters
| Name | Data Type | Required / Optional | Description |
|---|---|---|---|
| auth-userid | Integer | Required | Authentication Parameter |
| api-key | String | Required | Authentication Parameter |
| domain-name | String | Required | The domain name for which the details are to be fetched. |
HTTP Method
GET
Example Test URL Request
Indiahttps://test.httpapi.com/api/gapps/in/transfer-details.json?auth-userid=0&api-key=key&domain-name=domain.com
South East Asia & Egypthttps://test.httpapi.com/api/gapps/se/transfer-details.json?auth-userid=0&api-key=key&domain-name=domain.com
Rest of the Worldhttps://test.httpapi.com/api/gapps/gbl/transfer-details.json?auth-userid=0&api-key=key&domain-name=domain.com
Response
Success: Returns the minimum number of accounts required along with the plan-id to be
purchased when transferring the Google Workspace account from another Google Workspace reseller.
{
"status": "success",
"minimum-required-seats": 1,
"plan-id": 300324,
}
Error:
{"status": "ERROR",
"message": "We're having trouble retrieving your transfer details. This information is sensitive to your IP
address and the RPI (Reseller Public Identifier) used to initiate the transfer. Please verify you are using
the correct details."}
Reason: Incorrect RPI used while generating the Transfer Authorization.
Note: Plan-id: Details can be fetched using the Get Plan Details call
Did you find this article helpful?