Method: customers.list

  • This API call (GET https://sasportal.googleapis.com/v1alpha1/customers) retrieves a list of customers within the Spectrum Access System.

  • Users can control the number of results and pagination via query parameters pageSize and pageToken.

  • The response provides a list of customers and a token for retrieving further results if available.

  • Authorization requires the https://www.googleapis.com/auth/sasportal OAuth scope.

Returns a list of requested customers.

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.

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 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