---
title: "API Docs Dashboard Tool"
slug: "api-docs-dashboard-tool"
updated: 2026-04-27T17:11:22Z
published: 2026-04-27T17:11:22Z
canonical: "docs.unqork.io/api-docs-dashboard-tool"
---

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

# API Docs Dashboard Tool

The **API Docs Dashboard tool** displays all [modules](/v1/docs/what-is-a-module) connected to every API and remote execute. The tool builds API documentation for each module, including API call descriptions and their request and response parameters. Select a module on the dashboard to view the data type and description of each field.

[Remote executes](/v1/docs/remoteserver-side-execute) interface with a module through an API call instead of loading it in the browser. When you build a remote execute module, you create an API endpoint for other modules in your Application. The term API module can refer to a remote execute module or a module with a basic API call.

The dashboard displays all API modules in your environment and provides filters to help you find a specific module. Available filters include:

- Namespace
- Title
- ID
- Path

After you locate an API module, view its details:

- Function description.
- Method (//POST/).
- Request and response parameters.
- Request and response data types.

Learn more about using the API Docs Dashboard tool in the tabs below:

Access & Navigate API Docs DashboardFilter API Docs DashboardNavigate API Documentation

## Accessing and Navigating the API Docs Dashboard

### API Docs Dashboard Tool Access

This tool requires Creators to have specific role access in [Environment Role RBAC](/v1/docs/creator-role-administration) (role-based access control) or [WSRBAC](/v1/docs/workspaces-role-based-access-control-wsrbac) (Workspaces Role-Based Access Control).

If using [Environment Roles](/v1/docs/creator-role-administration?Highlight=environment%20role) (not using WSRBAC):

- Creator roles can view all data in this tool.

If using [WSRBAC](/v1/docs/workspaces-role-based-access-control-wsrbac):

- Creators can view data related to [modules](/v1/docs/introduction-to-the-module-builder) and [workflows](/v1/docs/introduction-to-workflow) inside Workspaces where they have access.
- If a Creator cannot access specific data, they likely do not have access to the [Workspace](/v1/docs/introduction-to-workspaces) containing the module.

On the right side of each table entry, click the View button to see the API call's request and response parameters, data types, and notes.

By default, the API Docs Dashboard displays 10 entries. Click the numbered buttons below the table to display more entries.

Below is an example of how the dashboard looks:

[![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API_Docs_Dashboard_02_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API%20Docs%20Dashboard%2002.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)

## Filtering the API Docs Dashboard

All API modules created in the environment display in the API Docs Dashboard. The dashboard has four filters to help you locate your API modules. Use any or all these filters, depending on how specific you want to be. As you enter text into the fields, the results display automatically. To clear all fields, click the funnel icon to the far right.

Below are descriptions of the supported filters:

| Filter | Description |
| --- | --- |
| Namespace | The Namespace identifies API modules in the API Docs Dashboard. Enter a Namespace in the Module Tags when you create your module. For the dashboard to find your module, enter `api` in the Module Tags. To further organize your API modules, enter `api-namespace: someNamespace`. For example, if you have a few modules specific to `dogs`, enter the following Namespaces: `api`,`api-namespace:dogs`. After you add this Namespace, `dogs` displays in the Namespace column of the API Docs Dashboard. > [!TIP] > The Namespace field uses autocomplete to suggest Namespaces used elsewhere in the environment. |
| Title | The title of the module. |
| ID | The unique identifier of the module. |
| Path | The module path. |

## Navigating Your API Documentation

After you locate your API module, click the View button on the far right to see the following API module details:

- The API module’s title.
- A brief description of the API module.
- The API call’s method.
- Links to Server-Side Module Execution.
- The API request table.
- The API response table.

The following example shows the API details:

[![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API_Docs_Dashboard_03_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API%20Docs%20Dashboard%2003.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)

### Viewing the Request and Response of Your API Module

The **Request** and **Response** tables contain most of the API module's information.

The Request table contains the following information:

| Filter | Description |
| --- | --- |
| Parameter | This is the Property ID of your API module. |
| Type | The API module's request type. When creating an API module, add the following data types to the Module Tags to specify the expected data types: - `type:string:` If the data is alphanumeric. - `type:number`: If the data is an integer or a floating-point Number. - `type:boolean`: If the data is Boolean (true or false). - `type:array`: If the data type is an array. - `type:object`: If the data type is an object. - `type:objectId`: If the data type is a MongoDB unique identifier. |
| Required | Determines if the module's API parameters are required. |
| Comments | A brief description of the API request. |

Below is an example of the Request table:

[![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API_Docs_Dashboard_04_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API%20Docs%20Dashboard%2004.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)

The Response table contains the following information:

| Filter | Description |
| --- | --- |
| Parameter | The Property ID of your API module. |
| Type | The API module's response type. When creating an API module, add the following data types to the Module Tags to specify the expected data types: - `type:string`: If the data is alphanumeric. - `type:number`: If the data is an integer or a float point number. - `type:boolean`: If the data is Boolean (`true` or `false`). - `type:array`: If the data structure is an array. - `type:object`: If the data structure is an object. - `type:objectId`: If the data is a unique identifier. |
| Comments | A brief description of the API response. |

Here's an example of a Response table:

[![](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API_Docs_Dashboard_05_thumb_0_0.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/API%20Docs%20Dashboard%2005.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D)

## Best Practices

Creators using older versions of Unqork may not have the API Module template available. Keep the following best practices in mind:

- Add the api tag to your module to make it easier to find on the API Docs Dashboard.
- Use the API Specification snippet to build API modules. These guidelines ensure your APIs work correctly, and their documentation displays in the dashboard.

For more information on the API Specification Snippet, view our [API Specification Snippet](/v1/docs/api-specification-snippet) article.

- Set the **Server Side Execution Only** toggle to ![A toggle switch icon indicating an on state for user interface settings.](https://cdn.us.document360.io/15548f06-2fba-434c-b0c1-5df88317dbd7/Images/Documentation/toggledOn.jpg?sv=2026-02-06&spr=https&st=2026-11-06T22%3A54%3A31Z&se=2026-11-06T23%3A54%3A31Z&sr=c&sp=r&sig=OsTu4tulrd8neSOeaqORBoNVnV1weFTwohL%2BWgEOyXo%3D) (**ON**).

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.

Data types are a classification of data that determines how it is stored and interpreted.

An API endpoint is the location where an API receives requests for a specific resource on its server. It's the point of contact between an API client and an API server, and is usually a uniform resource locator (URL) that provides the location of the resource.

In Unqork an application is a program used to perform specific tasks. An application can be one of two types: workflow or module.

The HTTP POST method is used to send data to a server to create or update a resource, typically including the data in the body of the request.

Data types are a classification of data that determines how it is stored and interpreted.

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network.

RBAC (Role-Based Access Control) is a method to control system access for authorized users. The role in RBAC refers to the levels of access employees have to a network.

WSRBAC (Workspaces Role-Based Access Control) is a method to control user access to a workspace. Users must be assigned to a workspace using WSRBAC before they can view or edit applications and modules inside the space.

Also known as Unqork Users, or Designer Users; is anyone who is inside the Unqork platform.

A Property ID is the unique field ID used by Unqork to track and link components in your module.

The Number data type accepts integer or floating point values. The number data type does not use quotes around numerical values.

The Boolean data type accepts one of two values: true, or, false.

An array is a type of object that stores one or more data types. Data types supported in arrays include numbers, strings, and objects.

An object is a type of data structure that represents a single, self-contained entity that acts as a container for the characteristics of that entity.

A data structure is the design used for organizing, using, and storing data.

APIs (application programming interfaces) are a set of protocols and definitions developers use to build and integrate application software. APIs act as the connective tissue between products and services.