Method: customLists.list

Full name: projects.locations.instances.customLists.list

List all CustomLists.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list Custom Lists for. Format: projects/{project}/locations/{location}/instances/{instance}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of CustomLists to return.
pageToken

string

Optional. A page token, received from a previous customLists.list call. Provide this to retrieve the subsequent page.
filter

string

Optional. Filter expression that matches a subset of the CustomLists to show.
orderBy

string

Optional. Configures ordering of CustomLists in the response. If not specified, CustomLists are returned in descending order of their create time.

Request body

The request body must be empty.

Response body

Response message to list custom lists.

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

JSON representation 
{
  "customLists": [
    {
      object (CustomList)
    }
  ],
  "totalSize": integer,
  "nextPageToken": string
}
Fields
customLists[]

object (CustomList)

Output only. The list of CustomLists, ordered by ModificationTimeUnixTimeInMs ascending by default.
totalSize

integer

Output only. The total number of custom lists.
nextPageToken

string

Output only. A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.