API List

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/devportal-api-api-list-schema.json",
  "title": "API List",
  "description": "APIList schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "count": {
      "type": "integer",
      "description": "Number of APIs returned.\n",
      "example": 1
    },
    "list": {
      "type": "array",
      "items": {
        "$ref": "#/components/schemas/APIInfo"
      }
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  },
  "example": {
    "count": 2,
    "list": [
      {
        "id": "01234567-0123-0123-0123-012345678901",
        "name": "CalculatorAPI",
        "description": "A calculator API that supports basic operations",
        "context": "/CalculatorAPI",
        "version": "1.0.0",
        "type": "HTTP",
        "provider": "admin",
        "lifeCycleStatus": "PUBLISHED",
        "thumbnailUri": "/apis/01234567-0123-0123-0123-012345678901/thumbnail",
        "avgRating": 4.3,
        "throttlingPolicies": [
          "Unlimited"
        ],
        "advertiseInfo": {
          "advertised": "false,",
          "apiExternalProductionEndpoint": "null,",
          "apiExternalSandboxEndpoint": "null,",
          "originalDevPortalUrl": "null,",
          "apiOwner": null
        },
        "businessInformation": {
          "businessOwner": "Jane Roe",
          "businessOwnerEmail": "businessowner@wso2.com",
          "technicalOwner": "John Doe",
          "technicalOwnerEmail": "technicalowner@wso2.com"
        },
        "isSubscriptionAvailable": true,
        "monetizationLabel": null
      },
      {
        "id": "01123567-1233-5453-0212-12353678901",
        "name": "PizzaShackAPI",
        "description": "A Pizza ordering API",
        "context": "/PizzaShackAPI",
        "version": "1.0.0",
        "type": "HTTP",
        "provider": "admin",
        "lifeCycleStatus": "PUBLISHED",
        "thumbnailUri": "/apis/01123567-1233-5453-0212-12353678901/thumbnail",
        "avgRating": 4.3,
        "throttlingPolicies": [
          "Unlimited"
        ],
        "advertiseInfo": {
          "advertised": "false,",
          "apiExternalProductionEndpoint": "null,",
          "apiExternalSandboxEndpoint": "null,",
          "originalDevPortalUrl": "null,",
          "apiOwner": null
        },
        "businessInformation": {
          "businessOwner": "Jane Roe",
          "businessOwnerEmail": "businessowner@wso2.com",
          "technicalOwner": "John Doe",
          "technicalOwnerEmail": "technicalowner@wso2.com"
        },
        "isSubscriptionAvailable": true,
        "monetizationLabel": null
      }
    ],
    "pagination": {
      "offset": 2,
      "limit": 2,
      "total": 10,
      "next": "/apis?limit=2&offset=4",
      "previous": "/apis?limit=2&offset=0"
    }
  }
}