Open API
- 28 Aug 2024
- 1 minute read
- Print
- DarkLight
- PDF
Open API
- Updated 28 Aug 2024
- 1 minute read
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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
Accessing Slate Open API
To view the endpoints provided by the Slate Open API:
Select Database from the main navigation.
Under Import and Data Processing, select Integration Center.
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.
.png?sv=2022-11-02&spr=https&st=2024-09-16T04%3A05%3A57Z&se=2024-09-16T04%3A15%3A57Z&sr=c&sp=r&sig=3oNDRmaRdYUX56tTNj4fujMiE7ri%2Bxoj5klFM56hWkE%3D "Slate Open API Overview(1).png")
Original exports all
$refs without resolving themBundled References exports all
$refs resolved, placing them incomponentsections
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> objectsGet <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.
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:
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
Nullvalues should be included in the response.Select Send API Request. A sample response is generated.
.png?sv=2022-11-02&spr=https&st=2024-09-16T04%3A05%3A57Z&se=2024-09-16T04%3A15%3A57Z&sr=c&sp=r&sig=3oNDRmaRdYUX56tTNj4fujMiE7ri%2Bxoj5klFM56hWkE%3D "Test request & view response(1).png")
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.
Was this article helpful?
