Method: customers.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://sasportal.googleapis.com/v1alpha1/customers
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
number
The maximum number of customers to return in the response.
|
pageToken |
string
A pagination token returned from a previous call to customers.list method that indicates where this listing should continue from.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
Response for customers.list.
| JSON representation |
{
"customers": [
{
object (Customer)
}
],
"nextPageToken": string
} |
| Fields |
customers[] |
object (Customer)
The list of customers that match the request.
|
nextPageToken |
string
A pagination token returned from a previous call to customers.list method that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers.
|
Authorization Scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/userinfo.email
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 2023-12-05 UTC.
[null,null,["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eLists requested customers based on provided parameters and authorization.\u003c/p\u003e\n"],["\u003cp\u003eAllows for pagination to retrieve large sets of customers with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of customers and a token for retrieving further results.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/userinfo.email\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eUtilizes a GET request to the specified endpoint \u003ccode\u003ehttps://sasportal.googleapis.com/v1alpha1/customers\u003c/code\u003e with optional query parameters.\u003c/p\u003e\n"]]],["The core content describes the process of retrieving a list of customers using a `GET` request to `https://sasportal.googleapis.com/v1alpha1/customers`. This request supports optional `pageSize` and `pageToken` query parameters for pagination. The request body must be empty. The response returns a JSON object containing an array of customer objects and a `nextPageToken` for further pagination if available. An `OAuth` scope is required.\n"],null,["# Method: customers.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListCustomersResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\nReturns a list of requested [customers](/spectrum-access-system/reference/rest/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/customers`\n\nThe URL uses [gRPC Transcoding](https://github.com/googleapis/googleapis/blob/master/google/api/http.proto) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `number` The maximum number of [customers](/spectrum-access-system/reference/rest/customers#Customer) to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [customers.list method](/spectrum-access-system/reference/rest/customers/list#spectrum.sas.portal.v1alpha1.Customers.ListCustomers) that indicates where this listing should continue from. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse for `customers.list`.\n\n| JSON representation ||\n|------------------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"customers\": [ { object (/spectrum-access-system/reference/rest/customers#Customer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Customer](/spectrum-access-system/reference/rest/customers#Customer)`)` The [list of customers](/spectrum-access-system/reference/rest/customers#Customer) that match the request. |\n| `nextPageToken` | `string` A pagination token returned from a previous call to [customers.list method](/spectrum-access-system/reference/rest/customers/list#spectrum.sas.portal.v1alpha1.Customers.ListCustomers) that indicates from where listing should continue. If the field is missing or empty, it means there are no more customers. |\n\n### Authorization Scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/userinfo.email`"]]