Welcome to the Mindful developer experience!

Explore Mindful API documentation to optimize your integration process and development workflow. This article provides an overview of the API documentation available today, including the interactive features available for each endpoint. Our goal is to provide a Mindful developer experience that makes your interaction with our APIs as successful as possible!

Resources

In the left-side navigation menu, you will find interactive API reference documentation for various endpoints, including:

• Retrieve historical call data: Access past data efficiently for analysis and reporting.
• Retrieve real-time Call Target statistics: Retrieve up-to-the-minute statistics to monitor and manage your call targets effectively. An endpoint is available for aggregated statistics, as well.
• (Coming soon!) View and update configuration for Call Targets: Manage and adjust your Call Target configuration.
• Check Widget status: View Call Target statistics to determine whether a Call Target is ready to register callbacks.
• Register a callback: Submit a digital callback request.
• Cancel a callback: Cancel a pending callback before it is dialed.
• Request callback status: Check on the status of a pending callback.
• Request status of all Widgets: View simplified details for all Call Targets in your organization.

Explore the sidebar to learn about all available endpoints.

Key Features

Each reference article contains the same features and layout:

1. Endpoint path: Quickly reference the path for each available endpoint.
2. Authentication details: View information about the OAuth 2.0 authentication endpoint.
3. Path and query parameters: View the parameters used to fine-tune each request.
4. Return-value definitions and error responses: See concise definitions for all data returned by any endpoint.
5. Interactive widget: Submit live requests to see how our APIs work in real-time.
6. Code samples: View concise code sample in a variety of formats to jumpstart your integration.

Authentication

Authentication differs between the Mindful and Scheduler APIs, with the differences being noted in the respective endpoint documentation.

Mindful API

We use standard OAuth 2.0 authentication for the Mindful API.

• Auth endpoint: https://auth.getmindful.com/oauth2/token.
• Client Credentials: You can obtain Client Credentials via Application Clients configured in the Mindful UI.
• After submitting the Base64 combination of Client ID and Secret to the Auth endpoint, you will receive a temporary Bearer token that is valid for one hour. This Bearer token must be submitted in an Authorization header with each request.

Scheduler API

Authentication is optional for the Scheduler API. By default, no authentication is required. However, you can apply one of two methods (or both) to secure individual Widgets:

1. A persistent API Access Token that must be submitted with each API request.
2. An allow list of IP addresses. When the allow list is enabled, the designated IP addresses will be allowed to send unlimited requests, while requests from all other sources will be denied.

To learn more about either option, see Access Control Policies.