Method: transfers.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists the transfers for a customer by source user, destination user, or status.
HTTP request
GET https://admin.googleapis.com/admin/datatransfer/v1/transfers
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
customerId |
string
Immutable ID of the Google Workspace account.
|
maxResults |
integer
Maximum number of results to return. Default is 100.
|
newOwnerUserId |
string
Destination user's profile ID.
|
oldOwnerUserId |
string
Source user's profile ID.
|
pageToken |
string
Token to specify the next page in the list.
|
status |
string
Status of the transfer.
|
Request body
The request body must be empty.
Response body
Template for a collection of DataTransfer resources.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"kind": string,
"etag": string,
"dataTransfers": [
{
object (DataTransfer)
}
],
"nextPageToken": string
} |
| Fields |
kind |
string
Identifies the resource as a collection of data transfer requests.
|
etag |
string
ETag of the resource.
|
dataTransfers[] |
object (DataTransfer)
transfers.list of data transfer requests.
|
nextPageToken |
string
Token to specify the next page in the list.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.datatransfer
https://www.googleapis.com/auth/admin.datatransfer.readonly
For more information, see the Authorization guide.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-25 UTC.
[null,null,["Last updated 2025-03-25 UTC."],[],[],null,["# Method: transfers.list\n\nLists the transfers for a customer by source user, destination user, or status.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/datatransfer/v1/transfers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|------------------|----------------------------------------------------------------|\n| `customerId` | `string` Immutable ID of the Google Workspace account. |\n| `maxResults` | `integer` Maximum number of results to return. Default is 100. |\n| `newOwnerUserId` | `string` Destination user's profile ID. |\n| `oldOwnerUserId` | `string` Source user's profile ID. |\n| `pageToken` | `string` Token to specify the next page in the list. |\n| `status` | `string` Status of the transfer. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nTemplate for a collection of DataTransfer resources.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"kind\": string, \"etag\": string, \"dataTransfers\": [ { object (/workspace/admin/data-transfer/reference/rest/v1/transfers#DataTransfer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-------------------|------------------------------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the resource as a collection of data transfer requests. |\n| `etag` | `string` ETag of the resource. |\n| `dataTransfers[]` | `object (`[DataTransfer](/workspace/admin/data-transfer/reference/rest/v1/transfers#DataTransfer)`)` transfers.list of data transfer requests. |\n| `nextPageToken` | `string` Token to specify the next page in the list. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.datatransfer`\n- `\n https://www.googleapis.com/auth/admin.datatransfer.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
