---
title: "Open API"
slug: "open-api"
updated: 2026-03-16T18:34:50Z
published: 2026-03-16T18:34:50Z
---

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

# Open API

The Slate **Open API** is a turnkey, fully-documented API that is always up-to-date with Configurable Joins bases and accessible Slate data points.

In the Slate Open API, users can

- get **code samples**
- review **full documentation**
- select types of objects and operations to perform on them, including **fetching an object** and **listing objects**by particular criteria
- export the Slate Open API **definition file**

> [!NOTE]
> 🔑 Requires role [Administrator (All Access)](/v1/docs/user-access)

## Accessing Slate Open API

To view the endpoints provided by the Slate Open API:

1. Select **Database**from the main navigation.
2. Under Import and Data Processing, select **Integration Center.**
3. On the right, select **Open API**. You are redirected to the Open API interface.

You arrive at the **Overview page**.

### Exporting the definition file

Export the Slate Open API definition file by selecting **Export**, then choosing either **Original**or **Bundled References**.

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

- **Original**exports all `$ref`s without resolving them
- **Bundled References**exports all `$ref`s resolved, placing them in `component` sections

The definition document is exported as a `.json` file.

## Exploring endpoints

Select an endpoint from the list. A list appears for that endpoint with two options:

- `List <endpoint> objects`
- `Get <endpoint> object`

Select one of the two, depending on the data you’re looking to retrieve.

The **URL**of the operation appears, along with a brief **description**:

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

### Request

You’ll see **Query Parameters**for `List <endpoint> objects` operations.

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

You’ll see **Query** and **Path Parameters**for `Get <endpoint> object` operations.

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

### Responses

The Responses section previews the types of responses that can be returned from your calls.

Find the fields you can call for, and the data types they’ll return, under **Body**.

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

## Testing endpoints

In the **Parameters** box, enter the fields you want to see returned from a test response.

### Get object operations

To test a *Get object*operation:

1. In the **Parameters** box, configure the following settings:
  - (Required) **id**: Enter the **GUID** of the record you want to retrieve information about.
  - (Optional) **includeFields:**Enter a comma-separated list of any fields you want included in the response. For example, for a person record, you might enter `Preferred,Last,Birthdate,Email`.
    - Find these fields listed under **Responses > Body** on the left of the operation page.
    - **Note:**Capitalization of these fields is important.
  - (Optional) **includeNulls**: Choose whether `Null` values should be included in the response.
2. Select **Send API Request.**A sample response is generated.

![](https://cdn.us.document360.io/cd8ea7a6-07f3-4846-a554-627ac016d3e3/Images/Documentation/Test request & view response(1).png)

As you configure these settings, a **sample request**is generated below:

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

The default request language is **Shell / cURL.**You can select from a list of other languages to display the sample request.

## Related

- [Configurable API](/slate-configurable-api.md)
- [Integration Center](/integration-center.md)