🔌

REST API AI Integration

Custom & API

With the REST API connector, your assistants can query the internal systems and custom services you configure, using the endpoints, authentication, headers, and parameters you set. Ask for the latest inventory levels from your warehouse API or today's orders from your e-commerce API.

Access Mode
Read & Write
Setup Time
~10 minutes
Auth Method
API Key
Available soon Read-only by default

Connect REST API to JoySuite

Your assistants call the REST endpoints you configure when someone asks.

Available soon. Setup takes about 10 minutes once it's ready.
Join Waitlist

What you can do

Getting data out of an internal system usually means asking a developer or learning the API yourself.

Query an internal system

"Pull the latest inventory levels from our warehouse API"

Ask a question and get the answer from an endpoint you configured, such as your warehouse API.

Pull records from a service

"Get all orders from our e-commerce API placed today"

Ask for today's orders and get them from your e-commerce API.

Search a custom database

"Find all accounts created this month"

Ask for records by date or status from the database behind your API.

Check a service's status

"Check the status of our payment gateway"

Ask whether a system such as your payment gateway is responding.

Use several endpoints at once

"Query our product catalog and pricing APIs"

Ask a question that draws on more than one API, such as catalog and pricing.

Match internal data to CRM accounts

"What internal data relates to accounts in my CRM?"

See which records in your systems relate to accounts in your CRM.

What Your Assistants Can Access

JoySuite securely connects to REST API, making these resources available to your assistants.

🌐

API Endpoints

Configure and access multiple REST API endpoints with different base URLs and paths.

Base URL Path Method Response Format Rate Limits
🔐

Authentication

Support for multiple authentication methods to secure your connections.

API Keys Bearer Tokens OAuth 2.0 Basic Auth
📋

Headers

Configure custom headers for authorization, content type, and more.

Authorization Content-Type Accept Custom Headers
🔍

Query Parameters

Filter and search API data using query strings and parameters.

Filters Sorting Pagination Search Terms Date Ranges
📦

Request Body

Send structured data in POST and PUT requests with JSON or form data.

JSON Payload Form Data File Uploads Nested Objects
🔄

Webhooks

Configure incoming webhooks to receive real-time data updates.

Payload Event Type Timestamp Signature

Connector Commands

Use these specialized commands to interact with your REST API data directly in conversations.

/api get

Fetch Data

Retrieve data from any configured GET endpoint.

/api post

Send Data

Submit data to a POST endpoint and return the response.

/api search

Search Records

Query API endpoints with filters and search parameters.

/api list

List Endpoints

View all configured API endpoints and their descriptions.

/api schema

View Schema

Display the expected request and response structure.

/api test

Test Connection

Verify API connectivity and authentication status.

Commands respect your permissions and access settings.

Connect REST API to Your Other Tools

See how REST API works with your other connected tools.

🔧
+
☁️

REST API + Salesforce Integration

Put data from your own systems next to Salesforce accounts when you ask about a customer.

🔧
+
💬

REST API + Slack Integration

Find data from your own systems that relates to topics your team discusses in Slack.

🔧
+
📊

REST API + Tableau Integration

Combine proprietary data with Tableau dashboards in one answer.

🔧
+
⚡

REST API + Zapier Integration

Pair your REST endpoints with the Zaps you already have in Zapier.

Permissions & Access Control

You control exactly what JoySuite can access within REST API.

Default

Read Access

Read-only is the default for every connector. Your assistants can search and retrieve data, and they change nothing in REST API unless your IT team turns on write access.

  • Search and query records
  • View record details and history
  • Access related records and associations
  • View reports and dashboards
Requires IT approval

Write Access

Write access is off by default. It's available only where your IT team explicitly approves and enables it.

  • Create new records
  • Update existing records
  • Add notes and activities
  • Manage associations
For your IT team Security & safety How JoySuite works with your LMS

Frequently asked questions

Does JoySuite store data from my API?

No. JoySuite connects to your REST API and queries data in real-time. Your data stays in your systems. JoySuite reads it from REST API when you ask a question and doesn't keep a copy.

What authentication methods are supported?

JoySuite supports API keys, Bearer tokens, OAuth 2.0, and Basic authentication. You can configure the authentication method that matches your API.

Can JoySuite write data to my API?

Yes. JoySuite can execute POST, PUT, and PATCH requests if your API supports them. Write permissions are optional and configurable.

How long does setup take?

About 10 minutes. Configure your endpoint URLs, authentication, and start asking questions about your data.

Can I connect multiple APIs?

Yes. You can configure multiple API endpoints with different base URLs, authentication methods, and access patterns.

Related Connectors

Other connectors people use with REST API.

Zapier

Zapier

Custom & API
Salesforce

Salesforce

CRM & Sales
Slack

Slack

Communication
Google Workspace

Google Workspace

Communication

Connect REST API when it launches

Join the waitlist and we'll tell you when the REST API connector is available.

Join Waitlist