Method: admin.directory.v1.customers.chrome.printers.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://admin.googleapis.com/admin/directory/v1/{parent=customers/*}/chrome/printers
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id}
|
Query parameters
| Parameters |
pageSize |
integer
The maximum number of objects to return. The service may return fewer than this value.
|
pageToken |
string
A page token, received from a previous call.
|
orgUnitId |
string
Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id.
|
filter |
string
Search query. Search syntax is shared between this api and Admin Console printers pages.
|
orderBy |
string
The order to sort results by. Must be one of displayName, description, makeAndModel, or createTime. Default order is ascending, but descending order can be returned by appending "desc" to the orderBy field. For instance, "description desc" will return the printers sorted by description in descending order.
|
Request body
The request body must be empty.
Response body
Response for listing printers.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"printers": [
{
object (Printer)
}
],
"nextPageToken": string
} |
| Fields |
printers[] |
object (Printer)
List of printers. If orgUnitId was given in the request, then only printers visible for this OU will be returned. If orgUnitId was not given in the request, then all printers will be returned.
|
nextPageToken |
string
A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
|
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/admin.chrome.printers
https://www.googleapis.com/auth/admin.chrome.printers.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: admin.directory.v1.customers.chrome.printers.list\n\nList printers configs.\n\n### HTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/{parent=customers/*}/chrome/printers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|-------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the customer who owns this collection of printers. Format: customers/{customer_id} |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of objects to return. The service may return fewer than this value. |\n| `pageToken` | `string` A page token, received from a previous call. |\n| `orgUnitId` | `string` Organization Unit that we want to list the printers for. When org_unit is not present in the request then all printers of the customer are returned (or filtered). When org_unit is present in the request then only printers available to this OU will be returned (owned or inherited). You may see if printer is owned or inherited for this OU by looking at Printer.org_unit_id. |\n| `filter` | `string` Search query. Search syntax is shared between this api and Admin Console printers pages. |\n| `orderBy` | `string` The order to sort results by. Must be one of displayName, description, makeAndModel, or createTime. Default order is ascending, but descending order can be returned by appending \"desc\" to the orderBy field. For instance, \"description desc\" will return the printers sorted by description in descending order. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse for listing printers.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"printers\": [ { object (/workspace/admin/chrome-printer/reference/rest/v1/admin.directory.v1.customers.chrome.printers#Printer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `printers[]` | `object (`[Printer](/workspace/admin/chrome-printer/reference/rest/v1/admin.directory.v1.customers.chrome.printers#Printer)`)` List of printers. If `orgUnitId` was given in the request, then only printers visible for this OU will be returned. If `orgUnitId` was not given in the request, then all printers will be returned. |\n| `nextPageToken` | `string` A token, which can be sent as `pageToken` to retrieve the next page. If this field is omitted, there are no subsequent pages. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.chrome.printers`\n- `\n https://www.googleapis.com/auth/admin.chrome.printers.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent)."]]
