Method: customers.list

  • Lists requested customers based on provided parameters and authorization.

  • Allows for pagination to retrieve large sets of customers with pageSize and pageToken.

  • Response includes a list of customers and a token for retrieving further results.

  • Requires the https://www.googleapis.com/auth/userinfo.email OAuth scope for authorization.

  • Utilizes a GET request to the specified endpoint https://sasportal.googleapis.com/v1alpha1/customers with optional query parameters.

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

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