---
title: "Slate Configurable API"
slug: "slate-configurable-api"
updated: 2026-03-10T19:36:05Z
published: 2026-03-10T19:36:05Z
---

> ## 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

You can use the Slate **Configurable API**to export data in a format easily consumed by other web services. The Configurable API provides access to data in a clean, well-documented, tightly-scoped API.

> [!NOTE]
> 🔑 Requires the role [Administrator (All Access)](/v1/docs/users-permissions)

## Configuring the API

The Slate API builder is used to create a new API which will serve as a collection of endpoints.

To configure the API:

1. From the main navigation, select **Database.**
2. Select **Slate Configurable API**.
3. Click **New API**.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/mceclip0(15).png)
4. In the popup, enter an unique key and a name:
  - The **name**is for user reference.
  - The **key**is part of the endpoint where data is requested.
5. Click **Save**.

## Add endpoints

To add endpoints:

1. Select **New Endpoint.**An *Edit API*popup appears.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/mceclip2(12).png)
2. Configure the following settings:

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/mceclip7(5).png)
  - **Key:**Enter a computer-friendly key (lowercase, no spaces). The key becomes a part of the URL that accesses the query. The final URL will have the form of `/manage/service/api/{API KEY}/{ENDPOINT KEY}`
  - **Name:** Enter a person-friendly, internal name for the endpoint.
  - **Base:**Select the base of the query, to be executed when this endpoint is called. **Note:** It cannot be changed later.
3. Click **Save.**
4. Add any required exports. Any formatting you supply to the export will be carried over into the API. For example, you you can:
  - Give countries ISO alpha-2 codes
  - Render birthdates in the `MM/DD/YYYY` format

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/blobid1.jpg)
5. Filter the results as needed.

## Access API documentation

On the API configuration home page, you will find the API link, which points to the documentation of the end points associated with this API:

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/15756375649051.png)