Configurable API Parameter Support

🏔️ Summit 2026 Feature

Define reusable endpoint parameters and make them visible in generated API documentation.

Configurable API parameters lets administrators add custom parameters to Configurable API endpoints. Parameters can use a default value, a data type, a description, and a required setting so API consumers understand what each request can or must include.

Adding custom parameters to an API endpoint

1. Go to Database → Configurable API.

2. Select an existing API, or create a new one.

3. Select an existing endpoint, or create a new one.

4. In the Parameters field, enter any number of parameters in the format described by the following example:

   <param id="first" type="varchar(64)" description="First name" required="true">Alexander</param>

   Where:

   • id is the parameter ID.

   • type is the parameter’s data type.

   • description is a string that appears in the API documentation beneath the parameter in the list of all parameters.

   • required is a Boolean that determines whether the parameter is required.

   • The text inside the tags is the default value, if applicable. Use a self closing tag < /> if there should be no default value. For example:

     <param id="reference_id" type="varchar(64)" description="Reference ID" required="false" />

5. Select Save.

Select Documentation and select the endpoint that includes your custom parameters; your custom parameters appear alongside the others. Test your endpoints to ensure you receive appropriate responses. Leave the Token field blank to use existing administrative user authentication to access the endpoint.

Examples