Open API

The Slate Open API provides endpoints based on 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

🔑 Requires role Administrator (All Access)

Accessing Slate Open API

To view the endpoints provided by the Slate Open API:

1. Select Database → Integration Center.

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

• Original exports all $refs without resolving them

• Bundled References exports all $refs 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:

Request

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

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

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.

Authentication

The Open API requires a valid Slate session for a user with Administrator (All Access) permissions. Requests sent through the Open API interface use your current Slate session.

The Open API does not support Bearer tokens or Basic authentication. Tokens created through Configurable API → Edit Permissions cannot authenticate Open API requests. For external integrations that require token authentication, use Configurable API, where you can create custom endpoints and configure a grantee.

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:

   • id (Required): Enter the GUID of the record you want to retrieve information about.

   • includeFields (Optional): 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.

   • includeNulls (Optional): Choose whether Null values should be included in the response.

2. Select Send API Request. A sample response is generated.

   

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

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

List objects operations

Use a List objects operation to retrieve objects associated with a record. For example, List ActivityInteraction objects retrieves interactions associated with a person.

1. Select an endpoint, then select List <endpoint> objects.

2. Under Parameters, configure the following settings:

   • record (required): Enter the GUID of the record whose related objects you want to retrieve. For List ActivityInteraction objects, enter the person's GUID.

   • includeFields (optional): Enter a comma-separated list of fields to include in each object. Find the available fields under Responses → Body and match their capitalization. For interactions, enter Code,Date to retrieve the interaction code and date. Leave this parameter blank to include all available fields.

   • includeNulls (optional): Select True to include fields with null values. Select False, or leave this parameter unset, to omit those fields.

3. Select Send API Request.

4. Review the response. A successful request returns a JSON array of matching objects. Each object contains the requested fields. An empty array, [], means that no objects matched the supplied record.

Pagination

Leave pageNumber and pageSize blank: while these fields appear in the interface, Open API List objects operations do not apply them. A response contains up to 500 objects.