---
title: "Configurable API Parameter Support"
slug: "configurable-api-parameter-support"
updated: 2026-10-28T18:45:59Z
published: 2026-10-28T18:45:59Z
canonical: "knowledge.technolutions.net/configurable-api-parameter-support"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://knowledge.technolutions.net/llms.txt
> Use this file to discover all available pages before exploring further.

# Configurable API Parameter Support

> [!TIP]
> 🏔️ Summit 2026 Feature
> 
> Define reusable endpoint parameters and make them visible in generated API documentation.

[Configurable API](/v1/docs/slate-configurable-api) **parameters** lets administrators add [custom parameters](/v1/docs/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.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/New endpoint with custom parameter(1).png?sv=2026-02-06&spr=https&st=2026-11-08T04%3A16%3A49Z&se=2026-11-08T05%3A16%3A49Z&sr=c&sp=r&sig=oK5n7PX9rbitLLia09pjhe%2FnLofaCIhk9PyK1jGKg68%3D)

## Adding custom parameters to an API endpoint

1. Go to **Database** → **Configurable API**.
2. Select an existing API, or [create a new one](/v1/docs/slate-configurable-api#add-endpoints).
3. Select an existing endpoint, or [create a new one](/v1/docs/slate-configurable-api#add-endpoints).
4. In the **Parameters** field, enter any number of parameters in the format described by the following example:

```xml
<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](/v1/docs/custom-parameters#choosing-parameter-names-and-types).
  - `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 `&lt; /&gt;` if there should be no default value. For example:

```xml
<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

**Admissions 🪪**

An admissions integration might accept an `entry_term` parameter so an SIS can request applicant data for one term at a time.

**Student Success 🎓**

A student success dashboard endpoint could accept a `cohort` parameter so that an external reporting tool can request one advising population.

**Advancement 🤝**

An advancement endpoint can accept `campaign` and `date` parameters so a partner system can request gift activity for a specific campaign window.