firestore.projects.databases.collection Groups.indexes.list

GET {{baseUrl}}/v1/:parent/indexes?filter=<string>&pageSize=<integer>&pageToken=<string>&$.xgafv=<string>&access_token=<string>&alt=<string>&callback=<string>&fields=<string>&key=<string>&oauth_token=<string>&prettyPrint=<boolean>&quotaUser=<string>&upload_protocol=<string>&uploadType=<string>

Lists composite indexes.

Request Params

KeyDatatypeRequiredDescription
filterstringThe filter to apply to list results.
pageSizestringThe number of results to return.
pageTokenstringA page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
$.xgafvstringV1 error format.
access_tokenstringOAuth access token.
altstringData format for response.
callbackstringJSONP
fieldsstringSelector specifying which fields to include in a partial response.
keystringAPI key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
oauth_tokenstringOAuth 2.0 token for the current user.
prettyPrintstringReturns response with indentations and line breaks.
quotaUserstringAvailable to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
upload_protocolstringUpload protocol for media (e.g. "raw", "multipart").
uploadTypestringLegacy upload protocol for media (e.g. "media", "multipart").

RESPONSES

status: OK

{&quot;indexes&quot;:[{&quot;fields&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}],&quot;name&quot;:&quot;consectetur nisi&quot;,&quot;queryScope&quot;:&quot;QUERY_SCOPE_UNSPECIFIED&quot;,&quot;state&quot;:&quot;STATE_UNSPECIFIED&quot;},{&quot;fields&quot;:[{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;},{&quot;value&quot;:&quot;\u003cError: Too many levels of nesting to fake this schema\u003e&quot;}],&quot;name&quot;:&quot;elit consequat quis&quot;,&quot;queryScope&quot;:&quot;COLLECTION&quot;,&quot;state&quot;:&quot;READY&quot;}],&quot;nextPageToken&quot;:&quot;minim&quot;}