# Mindtickle Developer Docs

> API guides and reference for integrating Mindtickle into your workflows.

## Getting started

- [Getting started](https://developer.mindtickle.com/docs/getting-started.md): Introduces the Mindtickle API families and the standards for its standard REST APIs, including base URLs, authentication, rate limits, and status codes.
- [API overview](https://developer.mindtickle.com/docs/getting-started/api-overview.md): Mindtickle offers a suite of APIs that let organizations extend and integrate their sales enablement ecosystem.
- [Authentication and setup](https://developer.mindtickle.com/docs/getting-started/authentication-and-setup.md): Covers the regional base URLs, authentication, data format, rate limits, and status codes for Mindtickle standard REST APIs.

## Users and groups

- [Users and groups](https://developer.mindtickle.com/docs/users-and-groups.md): Manage the user lifecycle and the group structure on Mindtickle: create, update, search, and deactivate users, manage group membership, and assign groups to series and modules.
- [Users](https://developer.mindtickle.com/docs/users-and-groups/users.md): Endpoints that create, update, search, deactivate, and group users on the Mindtickle platform.
- [Create a user](https://developer.mindtickle.com/docs/users-and-groups/users/create-a-user.md): Creates a user on the Mindtickle platform, optionally with profile fields, a time zone, groups, series and module assignments, and managers.
- [Update a user](https://developer.mindtickle.com/docs/users-and-groups/users/update-a-user.md): Updates an existing user on Mindtickle by Mindtickle user ID, including profile fields, time zone, groups, series and module assignments, and managers.
- [Add or update multiple users](https://developer.mindtickle.com/docs/users-and-groups/users/add-or-update-multiple-users.md): Adds or updates multiple users on Mindtickle in a single request, with profile fields, time zones, groups, series and module assignments, and managers.
- [Search users](https://developer.mindtickle.com/docs/users-and-groups/users/search-users.md): Searches for users on Mindtickle by username or email, series, group, or module, and returns up to 50 records per page.
- [Get a user](https://developer.mindtickle.com/docs/users-and-groups/users/get-a-user.md): Returns the details of a user on Mindtickle by Mindtickle user ID.
- [Deactivate a user](https://developer.mindtickle.com/docs/users-and-groups/users/deactivate-a-user.md): Deactivates a user on Mindtickle by Mindtickle user ID.
- [Deactivate multiple users](https://developer.mindtickle.com/docs/users-and-groups/users/deactivate-multiple-users.md): Deactivates one or more users on Mindtickle by Mindtickle user ID or by username.
- [Add a user to groups](https://developer.mindtickle.com/docs/users-and-groups/users/add-a-user-to-groups.md): Adds a user to one or more Mindtickle groups.
- [Add multiple users to groups](https://developer.mindtickle.com/docs/users-and-groups/users/add-multiple-users-to-groups.md): Adds multiple users to one or more Mindtickle groups in a single request.
- [Remove users from a group](https://developer.mindtickle.com/docs/users-and-groups/users/remove-users-from-a-group.md): Removes one or more users from a Mindtickle group, by Mindtickle user ID or by username.
- [Check process status](https://developer.mindtickle.com/docs/users-and-groups/users/check-process-status.md): Returns the status of one or more processes started by the Mindtickle user APIs, by process ID.
- [Time zone values](https://developer.mindtickle.com/docs/users-and-groups/users/time-zone-values.md): The time zones supported on the Mindtickle platform and the ID values to send in the timezone parameter of the user APIs.
- [Groups](https://developer.mindtickle.com/docs/users-and-groups/groups.md): Endpoints that create, update, search, and delete groups, and invite groups to series and modules.
- [Create a group](https://developer.mindtickle.com/docs/users-and-groups/groups/create-a-group.md): Creates a group on the Mindtickle platform with a name, and returns the group ID.
- [Update a group](https://developer.mindtickle.com/docs/users-and-groups/groups/update-a-group.md): Updates an existing group on Mindtickle by group ID.
- [Search groups](https://developer.mindtickle.com/docs/users-and-groups/groups/search-groups.md): Searches for groups on Mindtickle by group name or by group ID.
- [Get a group](https://developer.mindtickle.com/docs/users-and-groups/groups/get-a-group.md): Returns the details of a group on Mindtickle by group ID.
- [Delete a group](https://developer.mindtickle.com/docs/users-and-groups/groups/delete-a-group.md): Deletes a group on Mindtickle by group ID.
- [Invite groups to a series](https://developer.mindtickle.com/docs/users-and-groups/groups/invite-groups-to-a-series.md): Invites one or more Mindtickle groups to a Mindtickle series.
- [Invite groups to a module](https://developer.mindtickle.com/docs/users-and-groups/groups/invite-groups-to-a-module.md): Invites one or more Mindtickle groups to a module of a Mindtickle series.
- [Remove groups from a series](https://developer.mindtickle.com/docs/users-and-groups/groups/remove-groups-from-a-series.md): Removes one or more Mindtickle groups from a Mindtickle series.
- [Remove groups from a module](https://developer.mindtickle.com/docs/users-and-groups/groups/remove-groups-from-a-module.md): Removes one or more Mindtickle groups from a module of a Mindtickle series.
- [Check process status](https://developer.mindtickle.com/docs/users-and-groups/groups/check-process-status.md): Returns the status of one or more processes started by the Mindtickle group APIs, by process ID.

## Training

- [Training](https://developer.mindtickle.com/docs/training.md): Retrieve series and module content, manage invitations and reviewers, complete modules, and migrate mission learner data.
- [Series](https://developer.mindtickle.com/docs/training/series.md): List the series on your learning site and manage the users invited to them.
- [List all series](https://developer.mindtickle.com/docs/training/series/list-all-series.md): Returns all Mindtickle series created on your learning site.
- [Invite a user to series and modules](https://developer.mindtickle.com/docs/training/series/invite-a-user-to-series-and-modules.md): Invites a user to one or more Mindtickle series or to specific modules within a series.
- [Invite users to a series](https://developer.mindtickle.com/docs/training/series/invite-users-to-a-series.md): Invites one or more users to a Mindtickle series, with an optional backdated invite timestamp.
- [Remove users from a series or module](https://developer.mindtickle.com/docs/training/series/remove-users-from-a-series-or-module.md): Removes one or more users from a Mindtickle series or from a module within it.
- [Modules](https://developer.mindtickle.com/docs/training/modules.md): Read module content and manage module invitations, reviewers, completions, and mission data migration.
- [List all modules in a series](https://developer.mindtickle.com/docs/training/modules/list-all-modules-in-a-series.md): Returns all modules within a Mindtickle series.
- [Get module details](https://developer.mindtickle.com/docs/training/modules/get-module-details.md): Returns the details of a module in a Mindtickle series.
- [Get module learning object details](https://developer.mindtickle.com/docs/training/modules/get-module-learning-object-details.md): Returns the structured learning object details for a Mindtickle module, including content files, assessments, and quizzes.
- [Learning object content types](https://developer.mindtickle.com/docs/training/modules/learning-object-content-types.md): The content types returned by the module learning object response, with the fields and an example for each.
- [Invite users to a module](https://developer.mindtickle.com/docs/training/modules/invite-users-to-a-module.md): Invites one or more users to a Mindtickle module of a series, with optional module relevance and a backdated invite timestamp.
- [Assign reviewers to users](https://developer.mindtickle.com/docs/training/modules/assign-reviewers-to-users.md): Assigns and replaces reviewers in bulk for users in mission and coaching session modules.
- [Check process status](https://developer.mindtickle.com/docs/training/modules/check-process-status.md): Returns the status of a reviewer assignment process by process ID.
- [Complete modules for multiple users](https://developer.mindtickle.com/docs/training/modules/complete-modules-for-multiple-users.md): Marks progress as complete for multiple users within a module of a series, with an optional backdated completion timestamp.
- [Complete a module for a user](https://developer.mindtickle.com/docs/training/modules/complete-a-module-for-a-user.md): Marks progress as complete for a single user in a module, with an optional backdated completion timestamp.
- [Complete a mission or AI Roleplay](https://developer.mindtickle.com/docs/training/modules/complete-a-mission-or-ai-roleplay.md): Marks a mission or AI Roleplay module as complete for a specific learner.
- [Migrate mission learner data](https://developer.mindtickle.com/docs/training/modules/migrate-mission-learner-data.md): Transfers mission progress from one user ID to another for email and task evaluation missions.

## Asset Hub

- [Asset Hub](https://developer.mindtickle.com/docs/asset-hub.md): Discover hubs and assets, manage hub access, create and organize assets, and maintain the attribute taxonomy in Asset Hub.
- [Hubs](https://developer.mindtickle.com/docs/asset-hub/hubs.md): Hubs are the containers that hold Asset Hub assets, with their own access type and collaborators.
- [List active hubs](https://developer.mindtickle.com/docs/asset-hub/hubs/list-active-hubs.md): Returns a paginated list of all active hubs, optionally filtered by hub ID and sorted by a chosen column.
- [Create a hub](https://developer.mindtickle.com/docs/asset-hub/hubs/create-a-hub.md): Creates an Asset Hub hub with a name, an access type, and an optional description.
- [Manage hub collaborators](https://developer.mindtickle.com/docs/asset-hub/hubs/manage-hub-collaborators.md): Adds or removes hub-level permissions for multiple collaborators on a hub in a single request.
- [Manage user access for restricted hubs](https://developer.mindtickle.com/docs/asset-hub/hubs/manage-user-access-for-restricted-hubs.md): Shares or revokes access to a restricted hub for individual users in a single request.
- [Assets](https://developer.mindtickle.com/docs/asset-hub/assets.md): Assets are content items with metadata and attributes, managed through hubs.
- [List published assets in a hub](https://developer.mindtickle.com/docs/asset-hub/assets/list-published-assets-in-a-hub.md): Returns a paginated list of the published assets in a specified hub.
- [Get asset details](https://developer.mindtickle.com/docs/asset-hub/assets/get-asset-details.md): Returns the complete metadata and attributes of a specific asset.
- [Get asset media and transcript](https://developer.mindtickle.com/docs/asset-hub/assets/get-asset-media-and-transcript.md): Returns the media type and available signed URLs for an asset, including its content, thumbnail, and transcript.
- [Create assets](https://developer.mindtickle.com/docs/asset-hub/assets/create-assets.md): Creates assets from Content Center files asynchronously and returns an execution ID to track progress.
- [Archive assets](https://developer.mindtickle.com/docs/asset-hub/assets/archive-assets.md): Archives multiple Asset Hub assets in a single request, with per asset success and failure results.
- [Move or mirror assets](https://developer.mindtickle.com/docs/asset-hub/assets/move-or-mirror-assets.md): Moves or mirrors assets across hubs asynchronously and returns an execution ID to track progress.
- [Delete assets](https://developer.mindtickle.com/docs/asset-hub/assets/delete-assets.md): Permanently deletes multiple Asset Hub assets by ID in a single request.
- [Asset taxonomy](https://developer.mindtickle.com/docs/asset-hub/asset-taxonomy.md): Attribute categories and attributes classify Asset Hub assets, for example a Region category with an Americas attribute.
- [Create attribute categories](https://developer.mindtickle.com/docs/asset-hub/asset-taxonomy/create-attribute-categories.md): Creates attribute categories that organize assets, such as Region or Product line.
- [Create attributes](https://developer.mindtickle.com/docs/asset-hub/asset-taxonomy/create-attributes.md): Creates attributes under an existing attribute category, such as Americas under Region.
- [Delete attributes](https://developer.mindtickle.com/docs/asset-hub/asset-taxonomy/delete-attributes.md): Deletes one or more asset attributes by ID, with an optional force delete for attributes linked to assets.

## Content Center

- [Content Center](https://developer.mindtickle.com/docs/content-center.md): Build push-based integrations that upload files to Mindtickle Content Center, run content management jobs, and manage synced root folders.
- [Integration](https://developer.mindtickle.com/docs/content-center/integration.md): Connect an external CMS or DAM to a root folder in Mindtickle Content Center, review its sync history, and delete it when it is no longer needed.
- [Create an integration](https://developer.mindtickle.com/docs/content-center/integration/create-an-integration.md): Creates a persistent connection between an external CMS or DAM and a root folder in Mindtickle Content Center.
- [Get executions for an integration](https://developer.mindtickle.com/docs/content-center/integration/get-executions-for-an-integration.md): Returns a paginated list of all content management job executions associated with an integration ID.
- [Delete a synced root folder](https://developer.mindtickle.com/docs/content-center/integration/delete-a-synced-root-folder.md): Permanently removes a synced root folder and all its associated content from Mindtickle Content Center.
- [Files](https://developer.mindtickle.com/docs/content-center/files.md): Generate secure, temporary URLs that transfer files to Mindtickle Content Center before a content management job processes them.
- [Get an upload URL](https://developer.mindtickle.com/docs/content-center/files/get-an-upload-url.md): Returns a secure, temporary URL and an upload key for transferring a file to Mindtickle Content Center.
- [Jobs](https://developer.mindtickle.com/docs/content-center/jobs.md): Start content management jobs that create, update, or delete entities in Mindtickle Content Center, and track them with their execution ID.
- [Initiate a content management job](https://developer.mindtickle.com/docs/content-center/jobs/initiate-a-content-management-job.md): Starts a content management job that creates, updates, or deletes entities in Mindtickle Content Center.
- [Check content management job status](https://developer.mindtickle.com/docs/content-center/jobs/check-content-management-job-status.md): Returns the progress and final outcome of a content management job, with the status of each entity in the job.

## Call AI

- [Call AI](https://developer.mindtickle.com/docs/call-ai.md): Call AI APIs give programmatic access to conversation intelligence data, including recordings, transcripts, themes, and insights, through a GraphQL endpoint.
- [Authentication](https://developer.mindtickle.com/docs/call-ai/authentication.md): The Call AI API uses OAuth 2.0 to authorize access to your conversation intelligence data with a time-limited access token.
- [Get an authorization code](https://developer.mindtickle.com/docs/call-ai/authentication/get-an-authorization-code.md): Returns a temporary authorization code that you exchange for a Call AI access token.
- [Generate an access token](https://developer.mindtickle.com/docs/call-ai/authentication/generate-an-access-token.md): Exchanges a Call AI authorization code for a bearer access token and a refresh token.
- [Refresh an access token](https://developer.mindtickle.com/docs/call-ai/authentication/refresh-an-access-token.md): Regenerates a Call AI access token from a refresh token, without creating a new authorization code.
- [Validate a token](https://developer.mindtickle.com/docs/call-ai/authentication/validate-a-token.md): Returns the user, tenant, and client details associated with an active Call AI access token.
- [GraphQL API](https://developer.mindtickle.com/docs/call-ai/graphql-api.md): The Call AI GraphQL endpoint, the query mechanics it supports, and how it reports errors.
- [Query call data](https://developer.mindtickle.com/docs/call-ai/graphql-api/query-call-data.md): Returns Call AI recordings and their metadata, participants, transcripts, themes, stats, and scores with the recordingsV2 query.
- [Download call recordings](https://developer.mindtickle.com/docs/call-ai/graphql-api/download-call-recordings.md): Returns pre-signed URLs for Call AI audio and video recordings, along with transcript data.

## Copilot

- [Copilot](https://developer.mindtickle.com/docs/copilot.md): Mindtickle Copilot APIs embed the AI-powered assistant in your own applications, chatbots, and workflows, with streaming responses and citations.
- [Seller Copilot](https://developer.mindtickle.com/docs/copilot/seller-copilot.md): A single chat endpoint for AI-powered conversations with Mindtickle Copilot, with context retention, citations, and streaming responses.
- [Send a chat message](https://developer.mindtickle.com/docs/copilot/seller-copilot/send-a-chat-message.md): Sends a prompt to Mindtickle Copilot and returns the assistant reply as server-sent event chunks, with context retention and citations.

## Search

- [Search](https://developer.mindtickle.com/docs/search.md): Search Mindtickle learning site content programmatically with natural language and receive results ranked by semantic relevance.
- [Global search](https://developer.mindtickle.com/docs/search/global-search.md): Search across modules, files, series, assets, hubs, tags, and peers on the Mindtickle learning site, with entity filters, sorting, and pagination.
- [Run a global search](https://developer.mindtickle.com/docs/search/global-search/run-a-global-search.md): Searches Mindtickle learning site content across entities and returns results ranked by semantic relevance.

## Reporting

- [Reporting](https://developer.mindtickle.com/docs/reporting.md): Access granular performance and engagement data for your users and content with the OData-based Reporting API.
- [Use OData](https://developer.mindtickle.com/docs/reporting/use-odata.md): Explains how the Reporting API uses OData, including the service root URLs, resource paths, query options, logical operators, and the rate limit.
- [Tables: performance and completion](https://developer.mindtickle.com/docs/reporting/tables-performance-and-completion.md): Lists the Reporting API tables that hold performance and completion data for learners across content in Mindtickle, with their update frequency and download links.
- [Tables: object metadata](https://developer.mindtickle.com/docs/reporting/tables-object-metadata.md): Lists the Reporting API tables that hold metadata for objects in Mindtickle such as users, series, series ratings, modules, and content items, with their update frequency and download links.
- [Tables: asset interaction](https://developer.mindtickle.com/docs/reporting/tables-asset-interaction.md): Lists the Reporting API tables that hold the interactions sales reps, external recipients, and admins have with assets in Asset Hub, with their update frequency and download links.
- [Tables: Readiness Index](https://developer.mindtickle.com/docs/reporting/tables-readiness-index.md): Lists the Reporting API tables that hold user, competency, and cadence metadata for Readiness Index, with their update frequency and download links.
- [Tables: Digital Sales Rooms](https://developer.mindtickle.com/docs/reporting/tables-digital-sales-rooms.md): Lists the Reporting API tables that hold Digital Sales Rooms data, their linked CRM deals, and visitor engagement, with their update frequency and download links.
- [Best practices](https://developer.mindtickle.com/docs/reporting/best-practices.md): Guidelines on data limits and on the OData query URL used to query data from the Reporting API tables, with optimized and unoptimized sample queries for selected tables.
- [Pagination](https://developer.mindtickle.com/docs/reporting/pagination.md): Explains client-side pagination for all Reporting API tables and pagination for the LMPI table, with sample scripts for each.
- [Entity relationship diagram](https://developer.mindtickle.com/docs/reporting/entity-relationship-diagram.md): Provides the entity relationship diagram (ERD) for the Reporting API tables as a downloadable PDF.
- [FAQ](https://developer.mindtickle.com/docs/reporting/faq.md): Answers to common questions about Reporting API access, custom dashboards, and the main reporting tables.

## xAPI

- [xAPI](https://developer.mindtickle.com/docs/xapi.md): Mindtickle's read-only Experience API (xAPI) statements endpoint for retrieving learner progress and activity records.
- [Statements](https://developer.mindtickle.com/docs/xapi/statements.md): The xAPI statements resource, which returns learner progress and activity records for Mindtickle modules.
- [Get learner progress statements](https://developer.mindtickle.com/docs/xapi/statements/get-learner-progress-statements.md): Returns xAPI statements for a learner, showing their progress state for each Mindtickle module they are tracked against.

## Mindtickle MCP

- [Mindtickle MCP](https://developer.mindtickle.com/docs/mcp.md): Connect AI clients to Mindtickle with the Model Context Protocol, choose a connection path, and understand access requirements.
- [Set up the connector](https://developer.mindtickle.com/docs/mcp/publish-the-connector.md): Configure the Mindtickle MCP connector for your organization, choose a scope-control mode, and understand user authorization.
- [Connect your account](https://developer.mindtickle.com/docs/mcp/connect-your-account.md): Connect your Mindtickle account to an AI client, use the connector, and troubleshoot access issues.
- [AI clients](https://developer.mindtickle.com/docs/mcp/popular-ai-clients.md): Find vendor setup documentation for connecting supported AI clients to the Mindtickle MCP server.
- [Build a custom client](https://developer.mindtickle.com/docs/mcp/build-a-custom-client.md): Authenticate a custom MCP client, discover Mindtickle tools, manage conversation history, and handle errors.
- [Supported tools](https://developer.mindtickle.com/docs/mcp/tools.md): Review Mindtickle MCP tool parameters, response fields, scopes, limits, and side effects.
- [Use cases](https://developer.mindtickle.com/docs/mcp/use-cases.md): Explore prompts and workflows for finding content and creating, updating, and sharing Digital Sales Rooms with Mindtickle MCP.
- [Best practices](https://developer.mindtickle.com/docs/mcp/best-practices.md): Apply security, token management, and integration practices when connecting AI clients to Mindtickle MCP.

## Documentation sets

- [Complete documentation](https://developer.mindtickle.com/docs/llms-full.txt): every page in one file
- [Retrieval index](https://developer.mindtickle.com/docs/ai-index.json): title, description, content type, and headings for every page
- [Documentation graph](https://developer.mindtickle.com/docs/docs-graph.json): prerequisite, related, section, and link relationships between pages