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
|
integer
The maximum number of customers
to return in the response.
|
pageToken
|
string
A pagination token returned from a previous call to customers.list
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
.
| 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
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/sasportal
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2023-12-05 UTC."],[[["\u003cp\u003eThis API call (\u003ccode\u003eGET https://sasportal.googleapis.com/v1alpha1/customers\u003c/code\u003e) retrieves a list of customers within the Spectrum Access System.\u003c/p\u003e\n"],["\u003cp\u003eUsers can control the number of results and pagination via query parameters \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides a list of customers and a token for retrieving further results if available.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/sasportal\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],["This document details the process of listing customers via an HTTP `GET` request to `https://sasportal.googleapis.com/v1alpha1/customers`. The request utilizes query parameters `pageSize` and `pageToken` for pagination. The request body must be empty. The successful response returns a JSON object containing an array of `customers` and a `nextPageToken` for further pagination. The request requires OAuth scope `https://www.googleapis.com/auth/sasportal`.\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/v1alpha1/customers#Customer).\n\n### HTTP request\n\n`GET https://sasportal.googleapis.com/v1alpha1/customers`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` The maximum number of [customers](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer) to return in the response. |\n| `pageToken` | `string` A pagination token returned from a previous call to [customers.list](/spectrum-access-system/reference/rest/v1alpha1/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/v1alpha1/customers#Customer) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customers[]` | `object (`[Customer](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer)`)` The list of [customers](/spectrum-access-system/reference/rest/v1alpha1/customers#Customer) that match the request. |\n| `nextPageToken` | `string` A pagination token returned from a previous call to [customers.list](/spectrum-access-system/reference/rest/v1alpha1/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/sasportal`"]]
