v2

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-07-21130282381.6 KB

API Subscriptions

Get the API's subscriptions

List subscriptions for a given API, always filtered by a status and the possibility to filter by security.

get/environments/{envId}/apis/{apiId}/subscriptions

Query parameters

applicationIdsstring[]

List of application ids to filter on.

planIdsstring[]

List of plan ids to filter on.

statusesSubscriptionStatus[]

List of status filters.

[
  "ACCEPTED"
]

apiKeystring

API Key associated to the subscription to filter on.

expandsstring[]

Expansion of data to return in subscriptions.

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

Response

Page of API subscriptions

Example response

{
  "data": [
    {
      "id": "34f8c9e7-68fd-4922-b8c9-e778fc790777",
      "api": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "name": "My Api",
        "description": "I can use many characters to describe this API."
      },
      "apiProduct": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "name": "My API Product",
        "description": "A bundle of public APIs."
      },
      "plan": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "name": "My Api plan",
        "description": "I can use a hundred characters to describe this plan.",
        "apiId": "6c530064-0b2c-4004-9300-640b2ce0047b",
        "apiProductId": "6c530064-0b2c-4004-9300-640b2ce0047b",
        "security": {
          "type": "KEY_LESS"
        },
        "mode": "STANDARD"
      },
      "application": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "name": "My App",
        "description": "I can use a hundred characters to describe this App.",
        "domain": "https://my-app.com",
        "type": "iOS",
        "primaryOwner": {
          "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
          "displayName": "John Doe"
        },
        "apiKeyMode": "UNSPECIFIED"
      },
      "consumerConfiguration": {
        "entrypointId": "webhook",
        "channel": "/channel1"
      },
      "status": "ACCEPTED",
      "consumerStatus": "STOPPED",
      "processedBy": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "displayName": "John Doe"
      },
      "subscribedBy": {
        "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
        "displayName": "John Doe"
      },
      "processedAt": "2023-05-18 12:40:46.184000+00:00",
      "startingAt": "2023-05-20 12:30:42.101000+00:00",
      "endingAt": "2023-05-25 12:40:46.184000+00:00",
      "createdAt": "2023-05-18 12:40:46.184000+00:00",
      "updatedAt": "2023-05-25 12:40:46.184000+00:00",
      "closedAt": "2023-05-31 13:40:46.184000+00:00",
      "pausedAt": "2023-05-25 12:40:46.184000+00:00",
      "consumerPausedAt": "2023-05-25 12:40:46.184000+00:00",
      "origin": "KUBERNETES"
    }
  ]
}