Sign in
Subscription

List subscriptions.

Changed on
get/api/subscriptions

Request

  • The document declares no server URL.
  • Auth: HTTP bearer and API key in header X-Portal-Developer-ID

Query parameters

api_product_idstring

The object ID.

Example:bd58fce2-b6cc-4d2d-a53c-6ce11b19c101

The API product ID.

application_idstring

The object ID.

Example:bd58fce2-b6cc-4d2d-a53c-6ce11b19c101
statusSubscriptionStatus[]
searchstring

Condition to search resources by.

order_by'developer_name' | 'subscribed_at'
pageinteger

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_sizeinteger

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'asc' | 'desc'

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

Response

totalinteger required

Total number of objects.

Example response

{
  "list": [
    {
      "subscribed_at": "2025-01-01T00:00:00.000Z",
      "application_id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "application_name": "us-west-rsc",
      "api_product_id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "api_product_name": "us-west-rsc"
    }
  ],
  "total": 1
}

Changes