Home Guides REST Reference

Method: keyboxcohorts.list

Lists KeyboxCohorts.

HTTP request

GET https://androidpartner.googleapis.com/v1/keyboxcohorts

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
orderBy

string

The list is ordered by creation time in descending order. If orderBy = "asc", the list will be returned in ascending order.

pageSize

number

Size of each page.

pageToken

string

The nextPageToken value returned from a previous List request, if any.

filter

string

The filter. User can specify the filter to retrieve a sublist of KeyboxCohorts. Currently we can filter by companyId. There are two options: "filter=company=all" will list all KeyboxCohorts; "filter=company=12345" will list only KeyboxCohorts owned the company whose id is 12345.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

keyboxcohorts.list response.

JSON representation 
{
  "keyboxCohorts": [
    {
      object (KeyboxCohort)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Fields
keyboxCohorts[]

object (KeyboxCohort)

A list of existing KeyboxCohorts.

nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.

totalSize

string (int64 format)

Total KeyboxCohort list size.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/androidPartner

For more information, see the OAuth 2.0 Overview.