🔒
Requires read_app_proxy access scope.

The Get App Proxy List retrieves the list of all APP_Proxy instances created by the current requesting APP for the store corresponding to the requested domain name. The default display is the first page, with a default of 20 entries per page, and a maximum of 250 entries.

This API is especially useful for:

Listing all proxy configurations set up for an application within a Shoplazza store.
Monitoring and managing real_path and proxy_url mappings.
Auditing the integration points between the application and Shoplazza.

Request Parameters

Public Request Parameters

📘
Public Request Parameters

Query Parameters

Parameter	Type	Required	Default	Description	Example
`page`	int32	No	1	Page number.	1
`limit`	int32	No	20	Number of records per page. Maximum is 250. A value of `-1` retrieves all records.	20

Response Explanation

Public Response Parameters

📘
Public Response Parameters

Successful Response Fields

Field	Type	Description	Example
`app_proxys[]`	array	array of app_proxys
`app_proxys[].id`	int	The unique identifier for the app proxy.	32261
`app_proxys[].real_path`	string	The real path set for accessing Shoplazza. e.g. Input `testappproxy` as real_path; The web path should be `apps/testappproxy`	`testappproxy`
`app_proxys[].proxy_url`	string	The URL for accessing the developer's application.	`https://shoplazza. feishu.com/okr`
`app_proxys[].created_at`	string	The creation timestamp of the app proxy.	`2024-12-28T03:51:58+00:00`
`app_proxys[].updated_at`	string	The last updated timestamp of the app proxy.	`2024-12-28T03:51:58+00:00`

Error Response

Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.

Field	Type	Example	Description
`errors`	Array	`[ "file number error"]`	A list of errors encountered during the request processing.

Field	Type	Example	Description
`error`	String	`"page not found"`	Indicates an error encountered during the process

Error Detail

Status Code	Message	Possible Reason	Example Response
400	Bad Request	Invalid input format or request structure (e.g., missing required fields or incorrect data types).	`Bad Request`
	Unauthorized	The request is missing valid authentication credentials or the credentials provided are invalid.	`Unauthorized`

API Structure Overview

200OK