Sign in

v58

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-036490116.2 KB
Subscription Forms

Get subscription form for environment

Get the subscription form for the environment. Returns the form definition used by API consumers when subscribing to APIs in the Developer Portal.

User must have the ENVIRONMENT_SETTINGS[READ] permission.

get/subscription-forms

Response

Subscription form retrieved successfully

idstring uuid required

Unique identifier of the subscription form

gmdContentstring required

Gravitee Markdown (GMD) content defining the form. Supports form components like gmd-input, gmd-textarea, gmd-select, gmd-checkbox, gmd-radio.

enabledboolean required

Whether the form is enabled and visible to API consumers in the Developer Portal

resolvedOptionsobject

Resolved option lists for fields that use EL expressions. Keys are field keys; values are the effective option lists (fallback values when no API context is available). Present only when at least one field has dynamic options.

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "gmdContent": "# Subscription Information\n\n<gmd-input name=\"consumer_company_name\" label=\"Company Name\" required=\"true\"/>\n<gmd-textarea name=\"consumer_use_case\" label=\"Use Case\" required=\"true\"/>\n"
}