Welcome to the Mindful developer experience!

Find resources for integrating your apps with the Mindful API.

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 separated into categories:

  • Mindful API - Access your organization's Call Target configuration and reporting.

  • Scheduler API - Request, cancel, and check the status of callbacks.

  • Datastore API - Store key-value pairs (KVPs) in Datastore and retrieve those KVPs later from your call-routing scripts or application.

  • Webhooks - Receive automated notifications from Mindful when specific events occur, such as the registration, cancellation, or reconnection of callbacks.

Authentication details are available within each section.

Key Features

Most API reference articles contain the following features and layout:

Layer 1 1 2 3 5 4 6

  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. Code samples - View concise code sample in a variety of formats to begin your integration.

  6. Example responses - View the expected output of a successful response.

Tip:

  • Always use the latest version of our API to ensure compatibility and access to the newest features.

  • Regularly check the documentation for updates and changes that might affect your integration.

  • Implement error handling in your API calls to manage unexpected responses and maintain smooth operation.

  • Looking for Mindful Feedback API endpoints? Visit apidocs.surveydynamix.com.