Method: organizations.sites.apidocs.list

Returns the catalog items associated with a portal.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*/sites/*}/apidocs

The URL usesgRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the portal. Use the following structure in your request:organizations/{org}/sites/{site}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of items to return. The service may return fewer than this value. If unspecified, at most 25 books will be returned. The maximum value is 100; values above 100 will be coerced to 100.

pageToken

string

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

Request body

The request body must be empty.

Response body

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

JSON representation
{"status":string,"message":string,"requestId":string,"errorCode":string,"data":[{object (ApiDoc)}],"nextPageToken":string}
Fields
status

string

Status of the operation.

message

string

Description of the operation.

requestId

string

Unique ID of the request.

errorCode

string

Unique error code for the request, if any.

data[]

object (ApiDoc)

The catalog item resources.

nextPageToken

string

A token, which can be sent aspageToken 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

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-12-15 UTC.