API7 Docs
API7 GatewayAPI7 Enterprise Developer Portal APIsList all applications for the logged in developer.

List all applications for the logged in developer.

GET /api/applications

GET /api/applications

Interactive request editor loads with JavaScript.

Authorization

BearerAuth DeveloperIDHeader
AuthorizationBearer <token>

In: header

X-Portal-Developer-ID<token>

In: header

Query Parameters

api_product_id?string

The API product ID.

Match^[a-zA-Z0-9-_.]+$
Length1 <= length <= 256
search?string

Condition to search resources by.

labels?string

Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.

Length1 <= length
order_by?string

Index to order resources by.

Default"updated_at"

Value in

  • "created_at"
  • "updated_at"
page?integer

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
page_size?integer

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

Formatint32
Range1 <= value
direction?string

Order to list the resources by. The sorting index follows the configuration of order_by.

Default"desc"

Value in

  • "asc"
  • "desc"

Response Body

application/json

application/json

application/json

curl -X GET "$API_BASE_URL/api/applications?search=version%253Dv2"

{
  "list": [
    {
      "subscription_status": "unsubscribed",
      "name": "us-west-rsc",
      "desc": "Object description.",
      "labels": {
        "version": "v2",
        "env": "prod"
      },
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "created_at": "2025-01-01T00:00:00.000Z",
      "updated_at": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 1
}
Complete operation details and schema variants

GET /api/applications

List all applications for the logged in developer.

Parameters

  • api_product_id (query, string, optional): The API product ID.
  • search (query, string, optional): Condition to search resources by.
  • labels (query, string, optional): Label(s) to filter resources by. The format is labels[key]=value and should be URL-encoded.
  • order_by (query, string, optional): Index to order resources by.
  • page (query, integer, optional): Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • page_size (query, integer, optional): Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.
  • direction (query, string, optional): Order to list the resources by. The sorting index follows the configuration of order_by.

Responses

  • 200:

  • list (array, required): An array of developer applications.

  • allOf variant 1

  • list[].subscription_status (string, optional): Indicates the subscription status of the application for a specific api_product. It is only returned when it is necessary to check the subscription status of applications for a specific api_product.

  • allOf variant 2

  • allOf variant 1

  • list[].name (string, required): The object name.

  • list[].desc (string, optional): The object description.

  • list[].labels (object, optional): Key-value pairs of labels.

  • allOf variant 2

  • list[].id (string, required): The object ID.

  • list[].created_at (string, required): The time when the object was created in ISO 8601 format.

  • list[].updated_at (string, required): The time when the object was last updated in ISO 8601 format.

  • total (integer, required): Total number of objects.

  • 400: Bad request.

  • status (integer, required): The HTTP status code of the error response.

  • message (string, required): The error message.

  • 401: Unauthorized. Response fields (application/json): identical to GET /api/applications, response 400 above.

  • 500: Internal server error.

cURL

curl -X GET '$API_BASE_URL/api/applications'

Create an application by the logged in developer.

Previous Page

Get an application for the logged in developer.

Next Page