# Talkdesk Developers Documentation > Through the Talkdesk public API, partners can create and install integrated partner apps within the Talkdesk platform, as well as list their apps on AppConnect. The Talkdesk API provides additional benefits for partners looking to enhance and customize their contact center experience. ## Guides - [Getting Started](https://docs.talkdesk.com/docs/build-started.md): Start integrating with Talkdesk: explore APIs, build integrations, and create partner apps for seamless contact center operations. - [Starting Local Development](https://docs.talkdesk.com/docs/starting-local-app-development.md): Start local development with OAuth clients for Talkdesk APIs. To join the AppConnect™ marketplace, integrate your app with the Events API. - [Talkdesk® APIs](https://docs.talkdesk.com/docs/api-access.md): Explore Talkdesk APIs by use case: from app management to contact center operations. Access Talkdesk APIs as a current customer or partner. - [Authentication](https://docs.talkdesk.com/docs/authentication.md): Authentication in Talkdesk using OAuth 2.0: Choose Client Credentials for account-level access or Authorization Code for user-level access. - [Scopes](https://docs.talkdesk.com/docs/scopes.md): Scopes in Talkdesk APIs grant access to specific endpoints and define read or write permissions for each area. - [Client Credentials](https://docs.talkdesk.com/docs/client-credentials.md): Client Credentials grant type allows the issuance of access tokens for account-restricted Talkdesk APIs, enabling access to customer resources. - [Signed JWT](https://docs.talkdesk.com/docs/signed-jwt.md): To obtain access tokens securely, signed JWT assertions are used in Talkdesk AppConnect™, ensuring client authentication without sending sensitive credentials. - [Authorization Code](https://docs.talkdesk.com/docs/authorization-code.md): Authorization Code grant allows secure access to user resources by obtaining an authorization code, exchanging it for an access token, and ensuring API security. - [Ending a User Session](https://docs.talkdesk.com/docs/eding-a-user-session.md) - [Paging Results](https://docs.talkdesk.com/docs/paging-results.md): API responses are paginated by default, with 50 items per page. You can navigate between pages using provided links and utilize fields like count, total, page, and per_page to manage results. - [App and Data Types](https://docs.talkdesk.com/docs/app-data.md): Learn about partner apps for Talkdesk services, Talkdesk integrations, and data formats like phone numbers, dates, boolean values, timezones, and string enums. - [Compatibility](https://docs.talkdesk.com/docs/compatibility.md) - [Developer FAQs](https://docs.talkdesk.com/docs/developer-faqs.md) - [Chat Widget V1](https://docs.talkdesk.com/docs/chat-widget-v1.md) - [Chat Widget V2](https://docs.talkdesk.com/docs/chat-widget-v2.md) - [Migrating from Chat Widget v1 to v2](https://docs.talkdesk.com/docs/migrating-v1-to-v2.md) - [Overview](https://docs.talkdesk.com/docs/partner-app-overview.md) - [Partner Starting Point](https://docs.talkdesk.com/docs/partner-starting-point.md): Discover how to become a Talkdesk partner and access Partner Project, the platform for registering, managing, and developing partner apps for integration with Talkdesk systems. - [Guides](https://docs.talkdesk.com/docs/guides.md) - [Talkdesk® Partner Developer](https://docs.talkdesk.com/docs/becoming-a-talkdesk-partner-developer.md): To become a Talkdesk Partner Developer, complete the onboarding steps, including filling out partner documents, reading developer documentation, and getting a developer account. - [Partner App Requirements](https://docs.talkdesk.com/docs/app-requirements.md): Partner app requirements include certification guidelines, technical and user experience requirements, integration with Events API, and various testing scenarios. - [Connecting an App to AppConnect™](https://docs.talkdesk.com/docs/connecting-an-app-to-talkdesk-appconnect.md): Connect your partner app to Talkdesk AppConnect™ by fulfilling prerequisites, including integrating with the Events API and obtaining OAuth client credentials for access to Talkdesk APIs. - [Single Sign-On and Sign-Out](https://docs.talkdesk.com/docs/single-sign-on-and-sign-out.md): Enable Single Sign-On and Single Sign-Out for your Talkdesk AppConnect™-integrated web apps by registering your app, setting up technical details, and implementing user logout event handling. - [Partner App Authentication](https://docs.talkdesk.com/docs/authenticating-requests-and-authenticating-via-appconnect.md): Obtain an access token to make requests to Talkdesk APIs and authenticate your app via Talkdesk AppConnect™, leveraging various grant types for different levels of access. - [Talkdesk Partner Project™](https://docs.talkdesk.com/docs/partner-project.md) - [Accessing Partner Project](https://docs.talkdesk.com/docs/accessing-partner-project.md) - [Creating a New OAuth Client](https://docs.talkdesk.com/docs/creating-a-new-oauth-client.md) - [Registering a Partner App](https://docs.talkdesk.com/docs/registering-an-app.md) - [Creating/Managing App Versions](https://docs.talkdesk.com/docs/creating-managing-app-versions.md) - [Managing/Editing an App](https://docs.talkdesk.com/docs/managing-editing-an-app.md) - [Technical & Marketplace Certification](https://docs.talkdesk.com/docs/technical-marketplace-certification.md) - [Installing an App](https://docs.talkdesk.com/docs/installing-an-app.md) - [Listing an App on AppConnect](https://docs.talkdesk.com/docs/listing-an-app-on-appconnect.md) - [FAQs](https://docs.talkdesk.com/docs/builder-appconnect-faqs.md) - [App Launch and Enablement](https://docs.talkdesk.com/docs/app-enablement.md) - [SSO: App Access and Launch](https://docs.talkdesk.com/docs/single-sign-on.md) - [Authenticating Users](https://docs.talkdesk.com/docs/authenticating-users.md) - [Apps API](https://docs.talkdesk.com/docs/appsapi.md) - [Events API](https://docs.talkdesk.com/docs/events-api.md) - [Managing Trials and User Roles](https://docs.talkdesk.com/docs/managing-trials-and-user-roles.md) - [Testing and Submitting an App](https://docs.talkdesk.com/docs/testing-submitting-app.md) - [App Lifecycle Communication](https://docs.talkdesk.com/docs/app-lifecycle.md) - [App and Talkdesk Regions](https://docs.talkdesk.com/docs/how-to-guarantee-your-app-works-in-all-regions.md) - [Talkdesk Header](https://docs.talkdesk.com/docs/talkdesk-header.md) - [Billing](https://docs.talkdesk.com/docs/billing.md) - [Overview](https://docs.talkdesk.com/docs/integrations.md) - [Custom Integration](https://docs.talkdesk.com/docs/talkdesk-custom-integration.md) - [Configuring an Integration](https://docs.talkdesk.com/docs/integration-configuration.md) - [Authorization Validator](https://docs.talkdesk.com/docs/implementing-an-authorization-validator.md) - [Action Executor](https://docs.talkdesk.com/docs/implementing-an-action-executor.md) - [Agent Synchronization](https://docs.talkdesk.com/docs/implementing-an-agent-synchronization.md) - [Contact Synchronization](https://docs.talkdesk.com/docs/implementing-a-contact-synchronization.md) - [Contact Activity](https://docs.talkdesk.com/docs/implementing-contact-activity.md) - [Talkdesk Embedded for Custom Integrations](https://docs.talkdesk.com/docs/talkdesk-embedded-for-custom-integrations-customer-facing.md) - [Connections](https://docs.talkdesk.com/docs/building-a-custom-integration-with-connections.md) - [What Connections Supports](https://docs.talkdesk.com/docs/what-connections-supports.md) - [Custom Connection](https://docs.talkdesk.com/docs/configuring-a-custom-connection.md) - [Custom Action](https://docs.talkdesk.com/docs/configuring-a-custom-action.md) - [Saving or Publishing an Action](https://docs.talkdesk.com/docs/save-or-publish-action-status.md) - [Executing an Action](https://docs.talkdesk.com/docs/executing-an-action.md) - [Testing an Action](https://docs.talkdesk.com/docs/testing-an-action.md) - [Editing a Custom Connection](https://docs.talkdesk.com/docs/editing-a-custom-connection.md) - [Editing an Action](https://docs.talkdesk.com/docs/editing-an-action.md) - [Copying an Action](https://docs.talkdesk.com/docs/copying-an-action.md) - [Connections - Property Types](https://docs.talkdesk.com/docs/connections-property-types.md) - [Encoding Types](https://docs.talkdesk.com/docs/encoding-types.md) - [OAuth2 Authorization Code Flow](https://docs.talkdesk.com/docs/oauth2-authorization-code-flow-authentication.md) - [OAuth2 Client Credentials with Private Key JWT](https://docs.talkdesk.com/docs/oauth2-client-credentials-with-private-key-jwt.md) - [Automations](https://docs.talkdesk.com/docs/automations-on-connections.md) - [Automations Filters](https://docs.talkdesk.com/docs/automations-filters.md) - [FAQs](https://docs.talkdesk.com/docs/talkdesk-connections-faqs.md) - [Blueprints](https://docs.talkdesk.com/docs/blueprints-connections.md) - [Trigger a Salesforce Flow](https://docs.talkdesk.com/docs/trigger-a-salesforce-flow.md) - [Do a Zendesk Data Dip](https://docs.talkdesk.com/docs/zendesk-data-dip.md): Using Talkdesk Connections™ and Talkdesk Studio™ - [Overview](https://docs.talkdesk.com/docs/workspace-designer-overview.md) - [Cards](https://docs.talkdesk.com/docs/cards.md) - [Panels](https://docs.talkdesk.com/docs/panels.md) - [Importing and Exporting Panels](https://docs.talkdesk.com/docs/importing-and-exporting-panels.md) - [Canvas](https://docs.talkdesk.com/docs/canvas.md) - [Conversations App Canvas Tab](https://docs.talkdesk.com/docs/conversations-app-tab-canvas.md) - [Secondary App Canvas](https://docs.talkdesk.com/docs/secondary-app-canvas.md) - [Cards App Canvas](https://docs.talkdesk.com/docs/cards-app-canvas.md) - [Embedded App Canvas](https://docs.talkdesk.com/docs/embedded-app-canvas.md) - [SMS Canvas Tab](https://docs.talkdesk.com/docs/sms-tab-canvas.md) - [Email Canvas Tab](https://docs.talkdesk.com/docs/email-tab-canvas.md) - [WhatsApp Canvas Tab](https://docs.talkdesk.com/docs/whatsapp-tab-canvas.md) - [Chat Canvas Tab](https://docs.talkdesk.com/docs/chat-canvas-tab.md) - [Digital Connect Canvas Tab](https://docs.talkdesk.com/docs/digital-connect-canvas-tab.md) - [Components](https://docs.talkdesk.com/docs/components.md) - [Render Form](https://docs.talkdesk.com/docs/render-form.md) - [Render View](https://docs.talkdesk.com/docs/render-view.md) - [Card Preview](https://docs.talkdesk.com/docs/card-preview.md) - [The Code Editor](https://docs.talkdesk.com/docs/the-code-editor.md) - [Common Use Cases](https://docs.talkdesk.com/docs/common-use-cases.md): The most common patterns in the Render View component - [Simple Render View](https://docs.talkdesk.com/docs/simple-render-view.md) - [Render Iframe](https://docs.talkdesk.com/docs/render-iframe.md) - [Fetch Data](https://docs.talkdesk.com/docs/fetch-data.md) - [Render Panel](https://docs.talkdesk.com/docs/render-panel.md) - [Render State](https://docs.talkdesk.com/docs/render-state.md) - [Split Flow](https://docs.talkdesk.com/docs/split-flow.md) - [Execute Action](https://docs.talkdesk.com/docs/execute-action.md) - [Functions](https://docs.talkdesk.com/docs/functions.md) - [Card Trigger](https://docs.talkdesk.com/docs/card-trigger.md) - [Canvas Trigger](https://docs.talkdesk.com/docs/canvas-trigger.md) - [Variables](https://docs.talkdesk.com/docs/variables.md) - [Blueprints](https://docs.talkdesk.com/docs/blueprints.md) - [Creating a Card with an Iframe](https://docs.talkdesk.com/docs/creating-a-card-with-an-iframe.md) - [Create a Card - Different Outcomes](https://docs.talkdesk.com/docs/create-a-card-with-different-outcomes.md): Depending on defined parameters - [Displaying Different Panels](https://docs.talkdesk.com/docs/displaying-different-panels.md): Based on an Agent Variable - [Product Details](https://docs.talkdesk.com/docs/product-details.md) - [Clinic Locator](https://docs.talkdesk.com/docs/clinic-locator.md) - [FAQs](https://docs.talkdesk.com/docs/talkdesk-workspace-designer-faqs.md) - [Overview](https://docs.talkdesk.com/docs/contact-center-overview.md) - [Attributes API](https://docs.talkdesk.com/docs/attributes-api.md) - [Billing Insights API](https://docs.talkdesk.com/docs/billing-insights-api.md) - [Callback API](https://docs.talkdesk.com/docs/callback-api.md) - [Campaign Management API](https://docs.talkdesk.com/docs/campaign-management-api.md) - [Contacts API](https://docs.talkdesk.com/docs/contacts-api.md) - [Do Not Call Lists API](https://docs.talkdesk.com/docs/do-not-call-lists-api.md) - [Fallback Experience API](https://docs.talkdesk.com/docs/fallback-experience-api.md) - [Financial Services Experience Cloud for Insurance](https://docs.talkdesk.com/docs/financial-services-experience-cloud.md) - [Financial Services Experience Cloud for Banking](https://docs.talkdesk.com/docs/financial-services-experience-cloud-for-banking.md) - [Flows API](https://docs.talkdesk.com/docs/flows-api.md) - [Identity API](https://docs.talkdesk.com/docs/identity-api.md) - [Identity Insights API](https://docs.talkdesk.com/docs/identity-insights-api.md) - [Phone Validation API](https://docs.talkdesk.com/docs/phone-validation-api.md) - [Voice Biometrics Opt-In API](https://docs.talkdesk.com/docs/voice-biometrics-opt-in-api.md) - [Voice Biometrics Opt-Out API](https://docs.talkdesk.com/docs/voice-biometrics-opt-out-api.md) - [Patient Omni-Channel Interactions Report API](https://docs.talkdesk.com/docs/patient-omni-channel-interactions-report-api.md) - [Appointment Scheduler Report API](https://docs.talkdesk.com/docs/copy-of-patient-omni-channel-interactions-report-api.md) - [Prompts API](https://docs.talkdesk.com/docs/prompts-api.md) - [Recordings API](https://docs.talkdesk.com/docs/recordingsapi.md) - [Ring Groups API](https://docs.talkdesk.com/docs/ring-groups-api.md) - [Migrating from Ring Groups to Queues API ](https://docs.talkdesk.com/docs/migrating-from-ring-groups-to-queues-api.md) - [Queues API](https://docs.talkdesk.com/docs/queues-api.md) - [Automated Notifications API](https://docs.talkdesk.com/docs/automated-notifications-api.md) - [Appointment Scheduler External API](https://docs.talkdesk.com/docs/appointments-scheduler-api.md) - [Record Lists API](https://docs.talkdesk.com/docs/record-lists-api.md) - [Digital Connect API](https://docs.talkdesk.com/docs/digital-connect-api.md) - [Messages API](https://docs.talkdesk.com/docs/messages-api.md) - [Outbound Notifications API](https://docs.talkdesk.com/docs/outbound-notifications-api.md) - [Simulated Email API](https://docs.talkdesk.com/docs/simulated-email-api.md) - [Overview](https://docs.talkdesk.com/docs/talkdesk-data.md) - [Live API](https://docs.talkdesk.com/docs/live-api.md) - [Advanced Dialer Calls Report API](https://docs.talkdesk.com/docs/advanced-dialer-calls-report-api.md) - [Explore API](https://docs.talkdesk.com/docs/explore-api.md) - [AI Conversation Markers Report](https://docs.talkdesk.com/docs/ai-conversation-markers-report.md) - [Audit Logs Report](https://docs.talkdesk.com/docs/audit-logs-report.md) - [Available Report Types](https://docs.talkdesk.com/docs/available-report.md) - [Calls Report](https://docs.talkdesk.com/docs/calls-report.md) - [Calls All Data Status Report](https://docs.talkdesk.com/docs/calls-report-all-data-status.md) - [Cases Explore API](https://docs.talkdesk.com/docs/cases-explore-api.md) - [Case SLA Report](https://docs.talkdesk.com/docs/case-sla-report.md) - [Case History Report](https://docs.talkdesk.com/docs/case-sla-report-copy.md) - [Contacts Report](https://docs.talkdesk.com/docs/contacts-report.md) - [Contacts Report All Data Status](https://docs.talkdesk.com/docs/contacts-report-all-data-status.md) - [Customer Omnichannel Report](https://docs.talkdesk.com/docs/calls-report-copy.md) - [DNC Dataset API](https://docs.talkdesk.com/docs/dnc-dataset-api.md) - [Explore Calls Report](https://docs.talkdesk.com/docs/explore-calls-report.md) - [Feedback Flow Report](https://docs.talkdesk.com/docs/feedback-flow-report.md) - [Interaction Custom Fields Report](https://docs.talkdesk.com/docs/interaction-custom-fields-report.md) - [Messaging Contacts Report](https://docs.talkdesk.com/docs/messaging-contacts-report.md) - [Messaging Traffic Report](https://docs.talkdesk.com/docs/messaging-traffic-report.md) - [Outbound Dialer Calls Report](https://docs.talkdesk.com/docs/outbound-dialer-calls-report.md) - [Performance Management Improvement and Attainment Report](https://docs.talkdesk.com/docs/performance-management-improvement-and-attainment-report.md) - [Performance Management Reports Explore API](https://docs.talkdesk.com/docs/performance-management-reports-explore-api.md) - [Performance Management Results Analysis Report](https://docs.talkdesk.com/docs/performance-management-results-analysis-report.md) - [Quality Management Evaluation Analysis Report](https://docs.talkdesk.com/docs/quality-management-evaluation-analysis-report.md) - [Ring Attempts Report](https://docs.talkdesk.com/docs/ring-attempts-report.md) - [Studio Flow Execution Report](https://docs.talkdesk.com/docs/studio-flow-execution-report.md) - [User Status Report](https://docs.talkdesk.com/docs/user-status-explore.md) - [WFM Schedule Adherence Report](https://docs.talkdesk.com/docs/wfm-schedule-adherence-report.md) - [WFM Team Schedule Report API](https://docs.talkdesk.com/docs/wfm-team-schedule-report-api.md) - [WFM Timeseries Report](https://docs.talkdesk.com/docs/wfm-timeseries-report.md) - [Reporting Custom Fields API](https://docs.talkdesk.com/docs/reporting-custom-fields-api.md) - [Guardian API](https://docs.talkdesk.com/docs/guardian-api.md) - [Guardian Sessions API](https://docs.talkdesk.com/docs/guardian-sessions-api.md) - [Guardian Users API](https://docs.talkdesk.com/docs/guardian-users-api.md) - [Guardian Cases API](https://docs.talkdesk.com/docs/guardian-cases-api.md) - [Guardian Call Quality API](https://docs.talkdesk.com/docs/guardian-call-quality-api.md) - [Data Dictionary](https://docs.talkdesk.com/docs/data-dictionary.md) - [Agent API](https://docs.talkdesk.com/docs/agent-api.md) - [Agent Management](https://docs.talkdesk.com/docs/agent-skills-management.md) - [Agent Details Management](https://docs.talkdesk.com/docs/agent-details-management.md) - [Agent Skills Management](https://docs.talkdesk.com/docs/agent-skills-management-1.md) - [Agent Permissions Management](https://docs.talkdesk.com/docs/agent-permissions-management.md) - [Campaign API](https://docs.talkdesk.com/docs/campaign-api.md) - [Customer API](https://docs.talkdesk.com/docs/customer-api.md) - [Standard Response Format](https://docs.talkdesk.com/docs/standard-response-format.md) - [Error Handling](https://docs.talkdesk.com/docs/error-handling.md) - [Data and Report Availability](https://docs.talkdesk.com/docs/data-and-report-availability.md) - [Best Practices](https://docs.talkdesk.com/docs/best-practices.md) - [Troubleshooting](https://docs.talkdesk.com/docs/troubleshooting.md) - [DNC Management API](https://docs.talkdesk.com/docs/dnc-management-api.md) - [Telephony SDK API](https://docs.talkdesk.com/docs/telephony-sdk-api.md) - [Team API](https://docs.talkdesk.com/docs/team-api.md) - [Skill API](https://docs.talkdesk.com/docs/skill-api.md) - [Queue API](https://docs.talkdesk.com/docs/queue-api.md) - [User Management API (Enhanced)](https://docs.talkdesk.com/docs/user-management-api-enhanced.md) - [API Integration Patterns](https://docs.talkdesk.com/docs/api-integration-patterns.md) - [Overview](https://docs.talkdesk.com/docs/admin-overview.md) - [Users API](https://docs.talkdesk.com/docs/usersapi.md) - [SCIM API](https://docs.talkdesk.com/docs/scim-api.md) - [SCIM User Management for OKTA](https://docs.talkdesk.com/docs/scim-user-management-for-okta.md) - [SCIM User Management for OneLogin](https://docs.talkdesk.com/docs/scim-user-management-for-onelogin.md) - [SCIM User Management for Microsoft Entra ID](https://docs.talkdesk.com/docs/scim-user-management-for-microsoft-entra-id.md) - [Accounts API](https://docs.talkdesk.com/docs/accountsapi.md) - [Usage-Manager API](https://docs.talkdesk.com/docs/usage-manager-api.md) - [Case API](https://docs.talkdesk.com/docs/case-api.md) - [Webhook Trigger API](https://docs.talkdesk.com/docs/webhook-trigger-api.md) - [Retail Experience Cloud - Retail E-commerce Integration](https://docs.talkdesk.com/docs/retail-experience-cloud-retail-ecommerce-integration.md) - [Bulk Import API](https://docs.talkdesk.com/docs/bulk-import-api.md) - [CFM API](https://docs.talkdesk.com/docs/cfm-api.md) - [Express API](https://docs.talkdesk.com/docs/express-api.md) - [WFM Schedule Import API](https://docs.talkdesk.com/docs/wfm-schedule-import-api.md) - [WFM Forecast Import API](https://docs.talkdesk.com/docs/wfm-forecast-import-api.md) - [Overview](https://docs.talkdesk.com/docs/overview.md) - [Time-Off Sync with HR Systems](https://docs.talkdesk.com/docs/time-off-sync-with-hr-systems.md) - [A Time-Off is Created in WFM](https://docs.talkdesk.com/docs/a-time-off-is-created-in-wfm.md) - [A Time-Off is Updated in WFM](https://docs.talkdesk.com/docs/a-time-off-is-updated-in-wfm.md) - [A Time-Off is Deleted in WFM](https://docs.talkdesk.com/docs/a-time-off-is-deleted-in-wfm.md) - [Scheduled Time-Off API](https://docs.talkdesk.com/docs/scheduled-time-off-api.md) - [Time-Off Balance](https://docs.talkdesk.com/docs/time-off-balance.md) - [Contacts](https://docs.talkdesk.com/docs/contacts-and-more-talkdesk-documentation.md) - [Additional Documentation](https://docs.talkdesk.com/docs/more-talkdesk-documentation.md) ## API Reference - [API Endpoints](https://docs.talkdesk.com/reference/api-reference.md) - [Get account details](https://docs.talkdesk.com/reference/account-get.md): Get Account Details - [Create digital-connect conversation](https://docs.talkdesk.com/reference/create-digital-connect-conversations.md): Create digital-connect conversations - [Create digital-connect conversation](https://docs.talkdesk.com/reference/create-digital-connect-messages.md): Create digital-connect conversation inbound messages - [delete digital-connect conversation](https://docs.talkdesk.com/reference/delete-digital-connect-conversation.md): Delete Digital-Connect Conversation - [Update Talkdesk contact found by phone number or contact id with the Fsi member information.](https://docs.talkdesk.com/reference/fsi_workspace_contacts__update_talkdesk_contact.md): Update the Talkdesk contact information fields with the information of the FSI member. To get the Talkdesk contact it is required to provided one of the query parameters: contact_id or phone_number. When is provided the contact_id the Talkdesk contact to update will be found by the contact_id. When is provided the phone_number the Talkdesk contact to update will be found if only one match of the **phone number** exists in the contact Api. The update process will only occur only if a Talkdesk contact is retrieved and exists one Fsi member with identifier equals to **member_id**. The Talkdesk contact information that may be updated will be: - Name - Address - Email - Phone numbers - [Returns contact accounts list](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-accounts-get.md): The endpoint allows you to retrieve the accounts associated with a specific contact. By providing the unique contact ID as a path parameter, this endpoint enables you to fetch the financial or membership accounts linked to the contact. - [Return Payoff Calculation](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-accounts-account-id-payoff-post.md): Returns the payoff calculation for an FSI account based on a provided future date - [Returns one or more contacts matching the given criteria.](https://docs.talkdesk.com/reference/fsi-contacts-get.md) - [Return contact information](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-get.md): Retrieve the contact information for a specific contact ID. - [Returns card information](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-get.md): The endpoint allows you to retrieve detailed information about a specific card associated with a contact. By providing the unique contact ID and card ID as path parameters, this endpoint enables you to fetch the specific card's details based on its ID. - [Deactivate a card and give it a new status](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-deactivation-post.md): The endpoint allows you to deactivate a specific card associated with a contact. By providing the unique contact ID and card ID as path parameters, this endpoint enables you to deactivate the card and render it inactive for further use. - [Inform when a card needs to be activate](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-activation-post.md): The endpoint allows you to activate a specific card associated with a contact. By providing the unique contact ID and card ID as path parameters, this endpoint enables you to activate the card and make it ready for use. - [Returns contact cards list](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-get.md): The endpoint allows you to retrieve the list of cards associated with a specific contact. By providing the unique contact ID as a path parameter, this endpoint enables you to fetch the card details linked to the contact, such as credit cards, debit cards, or other card types. - [Returns account upcoming payments](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-payments-get.md): The endpoint allows you to retrieve the list of payments associated with a specific contact. By providing the unique contact ID as a path parameter, this endpoint enables you to fetch both past and upcoming payment records for the contact. - [Transfers between accounts](https://docs.talkdesk.com/reference/fsi-transfers-internal-post.md): Should do a transfer between the indicated members - [Transfers between accounts](https://docs.talkdesk.com/reference/fsi-transfers-external-post.md): Should do a transfer between the indicated members. Note here- Domestic transfers typically require both destination_account_number and destination_bank_routing_number, while international transfers use iban and swift. Although each field is technically optional, at least one valid combination must be provided to complete a transfer. - [Transfers between accounts](https://docs.talkdesk.com/reference/fsi-transfers-international-post.md): Should do a transfer between the indicated members - [Enable users to cancel various types of payments, including personal checks, before they are processed.](https://docs.talkdesk.com/reference/fsi-stop-contact-id-payments-post.md): Cancel a payment before it’s been processed - [Create a new endpoint for Travel Notifications with the necessary parameters for the different banking connectors](https://docs.talkdesk.com/reference/fsi-travel-notifications-post.md): Create a new endpoint for Travel Notifications - [Returns check status](https://docs.talkdesk.com/reference/fsi-checks-contact-id-search-post.md): The endpoint allows you to search status of a check by providing the unique account ID and check number as parameters - [request the issuance of a replacement card](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-replacecard-post.md): request the issuance of a replacement card - [Set up ACH transfers from their external bank accounts to their internal accounts or loans](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-payments-ach-post.md): Set up ACH transfers from their external bank accounts to their internal accounts or loans - [Enable users to generate a temporary pin for unlocking account as first step.](https://docs.talkdesk.com/reference/fsi-unlock-contact-id-pin-generate-post.md): Generate a temporary pin and send it to customer's mobile phone - [Enable users to reset pin for unlocking account as second step.](https://docs.talkdesk.com/reference/fsi-unlock-contact-id-pin-reset-post.md): Verify temporary pin and reset pin - [The decryption based on AES algorithm](https://docs.talkdesk.com/reference/fsi-decrypt-encrypt-key-encrypted-content-get.md) - [Send any type of other information back to core system](https://docs.talkdesk.com/reference/fsi-contacts-events-writeback-post.md): Send any type of other information back to core system - [Used the card ID to query the daily limit of the card](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-spendlimits-get.md): This is the interface for querying daily limits - [Modify daily limit.](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-cards-card-id-spendlimits-put.md): Modify daily limit - [Returns account transactions](https://docs.talkdesk.com/reference/fsi-contacts-contact-id-accounts-account-id-transactions-get.md): The endpoint allows you to retrieve the transactions associated with a specific account belonging to a contact. By providing the unique contact ID and account ID as path parameters, this endpoint enables you to fetch the transaction history of a particular account linked to a contact. - [Get account information regarding continuity settings activation](https://docs.talkdesk.com/reference/fallback-experience-get.md): Retrieve information from Outage Answering Machine about whether fallback experience is enabled or disabled. - [Enables or disables fallback experience](https://docs.talkdesk.com/reference/fallback-experience-put.md): Enables or disables fallback experience. If enabled new inbound calls are forwarded based on the fallback experience settings. - [Retrieves fallback experience settings.](https://docs.talkdesk.com/reference/getfallbackexperiencesettings.md): Retrieves fallback experience settings, forward configuration and message to play. - [Sets fallback experience configuration.](https://docs.talkdesk.com/reference/putfallbackexperiencesettings.md): Sets fallback experience configuration, forward configuration and message to play. - [Triggers attempt disposition event](https://docs.talkdesk.com/reference/v1-record-list-record-list-id-record-record-id-call-attempt-disposition-disposition-post.md): Triggers the automation for on attempt disposition event - [Triggers schedule callback created event](https://docs.talkdesk.com/reference/v1-record-list-record-list-id-record-record-id-schedule-callback-created-post.md): Triggers the automation for on schedule callback created event - [Triggers callback disposition event](https://docs.talkdesk.com/reference/v1-record-list-record-list-id-record-record-id-callback-attempt-disposition-disposition-post.md): Triggers the automation for on callback call attempt disposition event - [Create Prompt](https://docs.talkdesk.com/reference/createprompt.md): Create a new prompt - [List prompts (audio files) from Studio flows](https://docs.talkdesk.com/reference/listprompts.md): List prompts (audio files) from Studio flows - [Get a Prompt Detail by its ID](https://docs.talkdesk.com/reference/getpromptbyid.md): Gets prompt by its id - [Delete a Prompt](https://docs.talkdesk.com/reference/deletepromptbyid.md): Delete a prompt by its ID - [Partially updates the prompt](https://docs.talkdesk.com/reference/partiallyupdatesprompt.md): Partially updates the prompt by its id - [Update a Prompt](https://docs.talkdesk.com/reference/updatepromptbyid.md): Updating a Prompt using the Prompt ID - [Generate Download Link](https://docs.talkdesk.com/reference/prompts-id-download-link-get.md): Generates a new temporary download link for the prompt. - [Get usage of a prompt](https://docs.talkdesk.com/reference/getusagebypromptid.md): Get usage of a prompt - [Request Link to Upload Audio File](https://docs.talkdesk.com/reference/requestuploadlink.md): Request Link to Upload Audio File - [Get prompts quota](https://docs.talkdesk.com/reference/getpromptsquota.md): Get prompts quota - [Prompts Bulk Operation](https://docs.talkdesk.com/reference/promptsbulkoperation.md): Prompts bulk download/delete - [Get the flow list by a prompt id](https://docs.talkdesk.com/reference/getflowsbypromptid.md): Get the flow list by a prompt id - [Create a Webhook Trigger](https://docs.talkdesk.com/reference/posttrigger.md): Register a new webhook trigger for a specified event. Use this endpoint to subscribe to events by providing a callback URL that will receive notifications when the event occurs. Required fields: callbackurl. The trigger_name path parameter specifies the event type (e.g., contactCreated). - [Delete a Webhook Trigger](https://docs.talkdesk.com/reference/deletetrigger.md): Remove an existing webhook trigger by its ID. Use this endpoint to unsubscribe from a previously registered webhook event. Both the trigger name and trigger ID are required to identify the subscription. - [Create an interaction specific configuration which can be used for all the requests of the interaction ID.](https://docs.talkdesk.com/reference/createinteractionconfiguration.md): Create an interaction specific configuration which can be used for all the requests of the interaction ID. - [Returns configurations for the provided service and roles.](https://docs.talkdesk.com/reference/industries-settings-configurations-service-type-type-id-filter-get.md): Returns configurations for the provided service and roles. - [Returns configurations for the provided service and roles.](https://docs.talkdesk.com/reference/industries-settings-configurations-service-type-filter-get.md): Returns configurations for the provided service and roles. - [Get context](https://docs.talkdesk.com/reference/getindustriescontext.md): Returns all key/value pairs stored for the given context. - [Delete context](https://docs.talkdesk.com/reference/deleteindustriescontext.md): Deletes all values stored for the given context. - [Add context value](https://docs.talkdesk.com/reference/addindustriescontextvalue.md): Adds a new key/value pair to the given context. - [Delete context value](https://docs.talkdesk.com/reference/deleteindustriescontextvalue.md): Deletes a key/value pair from the given context. - [Update context value](https://docs.talkdesk.com/reference/updateindustriescontextvalue.md): Creates or updates the given key/value pair in the context. - [Get Customer Details](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-get.md): Read the customer by id. Required fields: - customer_id A successful request returns the customer for the provided ID. - [Get Customer Orders](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-get.md): Read the customer orders provided by the customer id. Required fields: - customer_id A successful request returns the list of orders for the provided customer. - [Get Customer Order](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-get.md): Get the customer order for the provided customer and order ID. Required fields: - customer_id - order_id A successful request returns the customer order for the provided customer and order ID. - [Update order attributes](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-patch.md): Partially update attributes of a customer's order. Currently only the `tags` field is supported. Tags are prepended in front of the existing tags. Duplicates are removed case-insensitively, keeping the first occurrence (new tags win). More fields will be added in future iterations. Required fields: - customer_id - order_id - tags (non-empty list) A successful request returns the order with the updated attributes. This operation is only supported for Shopify integrations. - [Get Order Items](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-items-get.md): Read the customer order items for the provided customer id and order id. Required fields: - customer_id - order_id A successful request returns the list of order items for the provided customer and order. - [Cancel Customer Order Items](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-items-cancel-put.md): Cancel items from the customer order with the provided customer ID and order ID. Required fields: - customer_id - order_id A successful request cancels the specified order items and returns the updated list of cancelled items. - [Change Order Shipping Address](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-change-shipping-address-post.md): Change the shipping address of a customer's order. Required fields: - customer_id - order_id A successful request updates the shipping address and returns the order with the new address. - [Cancel Customer Order](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-cancel-post.md): Cancel a customer's order. Required fields: - customer_id - order_id A successful request cancels the order and returns it with the updated status CANCELLED. - [Get order cancellation preview](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-orders-order-id-cancel-preview-get.md): Retrieves pre-cancellation preview data for a customer's order. Use this endpoint to populate the cancellation UI before submitting the cancel request. The response includes: - `use_new_cancel_flow` — whether to render the rich cancel popup (Shopify) or the legacy single-field flow (BigCommerce, Custom). - `supports_refund_on_cancel` — whether the order has a paid balance eligible for refund on cancellation. - `cancel_reasons` — the list of selectable cancellation reason options. - `refund_payments` — the suggested refund amount and payment gateway for the original payment method. - `refundable_items` — line items that would be included in the refund. For BigCommerce and Custom integrations, `use_new_cancel_flow` is always `false`. In that case, `cancel_reasons` and `refundable_items` are returned as empty lists, and `refund_payments` is empty lists. - [Get Customer Shipments](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-shipments-get.md): Read the customer shipments for the provided customer id. Required fields: - customer_id A successful request returns the list of shipments for the provided customer. - [Schedule Customer Shipments](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-shipments-schedule-post.md): Schedule the customer shipment for the provided order id or delivery id. Required fields: - customer_id - id (slot ID to schedule) A successful request schedules the shipment slot and returns the shipment details. - [Get Most Recent Order](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-most-recent-order-get.md): Read the customer most recent order for the provided customer id. Required fields: - customer_id A successful request returns the customer's most recent order. - [Get Shipment Available Slots](https://docs.talkdesk.com/reference/erc-ecommerce-customers-shipments-available-slots-get.md): Read the customer shipment available slots for the provided customer id, order id or delivery id. A successful request returns the list of available shipment slots. - [Sync cart items](https://docs.talkdesk.com/reference/erc-ecommerce-cart-items-put.md): Synchronize (replace) the line items in a cart. This endpoint creates a new cart or updates an existing one by replacing all current line items with the provided items. Cart resolution logic: - If `cart_id` is provided in the body, the cart with that ID is updated directly. - If `customer_id` is provided (without `cart_id`), the system looks for an existing active cart for that customer. If found, it replaces the lines; otherwise, a new cart is created. - If neither `cart_id` nor `customer_id` is provided, a new cart is created. Required fields: - interaction_id (the current interaction/conversation ID) - cart_lines (at least one item) A successful request returns the cart with the updated line items. - [Set cart delivery address](https://docs.talkdesk.com/reference/erc-ecommerce-cart-cart-id-delivery-address-put.md): Sets or updates the delivery address on a cart and returns available delivery options. - [Select cart delivery option](https://docs.talkdesk.com/reference/erc-ecommerce-cart-cart-id-delivery-option-put.md): Selects a delivery option for the cart. - [Bind customer to cart](https://docs.talkdesk.com/reference/erc-ecommerce-cart-cart-id-bind-post.md): Binds a customer to a cart and returns the updated cart. - [Get Customer Cart](https://docs.talkdesk.com/reference/erc-ecommerce-customers-cart-get.md): Read the cart of the customer by customer_id, cart_id, or interaction_id. Required fields: - At least one of customer_id, cart_id, or interaction_id must be provided. A successful request returns the cart data including delivery address and selected delivery option when available. - [Get order by cart ID](https://docs.talkdesk.com/reference/erc-ecommerce-cart-cart-id-order-get.md): Read the order associated with the given cart, once the cart has been converted into an order by the provider. This is a database-only lookup: it resolves the persisted cart-to-order relation and reads the order, without calling any external provider. It works for a cart regardless of its current status. A successful request returns the order associated with the cart. - [Get Orders](https://docs.talkdesk.com/reference/erc-ecommerce-orders-get.md): Read the orders provided by the account id. A successful request returns the list of orders for the account. - [Get Products](https://docs.talkdesk.com/reference/erc-ecommerce-products-get.md): Get/search the products of the store we are integrated with. A successful request returns the list of found products. - [Get Customer Technician Visit Slots](https://docs.talkdesk.com/reference/erc-ecommerce-customers-technician-visits-available-slots-get.md): Read the customer technician visits available slots for the provided customer id or visit id. A successful request returns the list of available technician visit slots. - [Schedule Customer Technician Visits](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-technician-visits-schedule-post.md): Schedule the customer technician visits for the provided visit id. Required fields: - customer_id - id (slot ID to schedule) A successful request schedules the technician visit for the specified visit ID. - [Get Customer Technician Visits](https://docs.talkdesk.com/reference/erc-ecommerce-customers-customer-id-technician-visits-get.md): Read the customer technician visits for the provided customer id. Required fields: - customer_id A successful request returns the list of technician visits for the provided customer. - [Get External Customers](https://docs.talkdesk.com/reference/erc-ecommerce-external-customers-get.md): Read the external customers. A successful request returns the list of external customers. - [Get Shopify Integration Credentials](https://docs.talkdesk.com/reference/erc-ecommerce-shopify-webhooks-handler-credentials-get.md): Get the Shopify Integration credentials for the currently authenticated Talkdesk account. A successful request returns the Shopify Integration credentials for the authenticated account. - [Update Shopify Integration Credentials](https://docs.talkdesk.com/reference/erc-ecommerce-shopify-webhooks-handler-credentials-put.md): Upsert the Shopify Integration credentials for the currently authenticated Talkdesk account. Required fields: - shopify_store_domain - shopify_api_key - shopify_api_secret A successful request upserts the Shopify Integration credentials and returns the updated credentials. - [Delete Shopify Integration Credentials](https://docs.talkdesk.com/reference/erc-ecommerce-shopify-webhooks-handler-credentials-delete.md): Delete the Shopify Integration credentials configured for the currently authenticated Talkdesk account. Required fields: - shopify_store_domain A successful request deletes the Shopify Integration credentials for the specified store domain. - [Get Available Return Reasons](https://docs.talkdesk.com/reference/erc-ecommerce-return-reasons-get.md): Retrieve the list of available return reasons. A successful request returns the list of available return reasons. - [Calculate Return Refund Amount](https://docs.talkdesk.com/reference/erc-ecommerce-return-calculations-post.md): Calculate the expected refund amount for a return request. Required fields: - order_id - return_line_items A successful request returns the expected refund amounts for the return request. - [Cancel a Return](https://docs.talkdesk.com/reference/erc-ecommerce-order-cancel-return-return-id-post.md): Cancel a return by the provided return ID. Required fields: - return_id A successful request cancels the return for the specified return ID. - [Create a New Return](https://docs.talkdesk.com/reference/erc-ecommerce-order-create-return-post.md): Create a new return for an order. Required fields: - order_id - return_line_items A successful request returns the newly created return details for the specified order. - [Request a New Return (In-Band Error Response)](https://docs.talkdesk.com/reference/erc-ecommerce-order-request-return-post.md): Request a new return for an order. Required fields: - order_id - return_line_items Unlike the standard create-return endpoint, this endpoint always returns HTTP 200. Provider-level errors (validation failures, order not found, bad gateway, etc.) are surfaced via `error_code`/`error_message` fields in the response body instead of HTTP 4xx/5xx status codes. Check `error_code` to determine the outcome. - [Get Suggested Refund](https://docs.talkdesk.com/reference/erc-ecommerce-refund-suggested-post.md): Calculate the suggested refund for an order or return. Supports two workflows: (1) direct refund from an order with specified line items, or (2) refund after a return where line items and totals are pre-calculated from the return. Required fields: - order_id or return_id (one must be provided) A successful request returns the suggested refund details for the specified order or return. - [Create a Refund](https://docs.talkdesk.com/reference/erc-ecommerce-refund-post.md): Create a direct refund for an order. Supports refunding specific line items, shipping costs, and duties with configurable payment transactions and refund methods. Required fields: - order_id A successful request returns the created refund details for the specified order. - [Process return and create refund](https://docs.talkdesk.com/reference/erc-ecommerce-return-process-refund-post.md): Process a return and create a refund for the associated order. This endpoint finalizes the return flow by issuing a refund tied to an existing return. Required fields: - order_id - return_id A successful request returns the created refund details for the specified order. - [Search catalog](https://docs.talkdesk.com/reference/erc-ecommerce-catalog-search-post.md): Search the product catalog of the configured e-commerce store. - [Get reseller contract info for an express account](https://docs.talkdesk.com/reference/getresellercontractinfo.md): Get reseller contract info for express accounts. This includes the number os seats, the account status and the workflow next transition date and status. - [Get contract actions](https://docs.talkdesk.com/reference/getresellercontractaction.md): Get a list of contract actions of an express account. - [Create a contract action for express account](https://docs.talkdesk.com/reference/createresellercontractaction.md): Create a contract action for an express account. This operation facilitates the subscription, amendment or cancellation of an express contract. - [Instantiate a Trial](https://docs.talkdesk.com/reference/createexpressaccount.md): Provision a new Talkdesk account - [Valid if account exists](https://docs.talkdesk.com/reference/validateaccount.md): Return boolean - [Create a map](https://docs.talkdesk.com/reference/createmap.md): Create a new map with a given external entity. To use Industries External Entity Mapper API, you need to add an execute action component to your Studio flows to call this endpoint. - [Create a map](https://docs.talkdesk.com/reference/createmaps.md): Create a new map with a given external entity. - [Search Talkdesk contact by phone](https://docs.talkdesk.com/reference/searchcontactbyphone.md): Search Talkdesk contact by phone. - [Search Talkdesk contact](https://docs.talkdesk.com/reference/searchcontactbychannels.md): Search Talkdesk contact - [Create a contact](https://docs.talkdesk.com/reference/searchandcreatecontact.md): Create a new contact by a given external contact info, this used for digital chat channel. - [Contact bind to an interaction](https://docs.talkdesk.com/reference/bindcontacttointeraction.md): Bind a contact to an interaction. - [Sync a contact by integration and external ID](https://docs.talkdesk.com/reference/searchandupsertcontact.md): Upserts (creates or updates) a Talkdesk contact by matching on the combination of `integration_id` and `external_id`. If a contact with the given integration mapping already exists, it is updated; otherwise a new contact is created. **Brand Sentinel Mechanism** The `custom_fields` array is the mechanism for identifying which store/brand a contact belongs to. The brand sentinel is a custom field entry with `key` = `external_id` and `value` = the brand/store identifier. When the brand sentinel is present in the request body: 1. When multiple contacts match the same `integration_id` + `external_id`, the brand sentinel is used to disambiguate — the service selects the contact whose `custom_fields` contain the matching brand sentinel for update. 2. If a single match exists but its brand sentinel differs from the one in the request body, the contact is treated as a non-match and the system falls through to the no-match logic (see `existing_contact_id` below). 3. An empty brand sentinel value is treated as "no brand" (same as omitting it). **Contact Resolution Logic** The service resolves which contact to create or update based on the following decision tree: - **Multiple matches** (matched > 1): - If brand sentinel present in request body → select the contact matching the brand; update it. - If no brand match found → fall through to no-match logic. - If brand sentinel not present → return matches as-is (no update performed). - **Single match** (matched == 1): - If brand sentinel not present → update the matched contact. - If brand sentinel present and contact has no brand sentinel → adopt the brand and update. - If brand sentinel present and sentinel matches → update. - If brand sentinel present and sentinel differs → treat as no-match (fall through). - **No match** (matched == 0, or delegated from above): - If `existing_contact_id` provided → attempt to reuse that contact (merge), unless it already has a conflicting integration for the same `integration_id` (in which case a new contact is created instead). - If `existing_contact_id` not provided → create a new contact. **Merge Strategy (when updating)** - `custom_fields`: key-based merge — matching keys are overwritten, new keys are appended, absent keys are preserved. - `integrations`: matched by `integration_id` + `external_id` pair; existing entries are updated, new entries are appended. - Scalar fields (`name`, `address`): overwritten if provided, preserved if omitted (null). - Array fields (`tags`, `emails`, `phones`): replaced entirely if provided. **Request Body Validation** - `contact.id` must be empty (omit it or set to null). - `contact.integrations` must contain at least one entry with `integration_id` and `external_id` matching the path parameters — otherwise 400 is returned. - [Collect feedback data](https://docs.talkdesk.com/reference/collectfeedbackdata.md): Use this endpoint to submit feedback survey data for a conversation; it currently supports Digital Connect and is intended for survey-completion flows. - [Get the paginated list of locations](https://docs.talkdesk.com/reference/getlocations.md): Get the paginated list of locations - [Get a location by id](https://docs.talkdesk.com/reference/getlocationbyid.md): Get a location by id - [Get location next week opening hours](https://docs.talkdesk.com/reference/getlocationnextweekopeninghours.md): Get a location next week opening hours - [Get the paginated list of services](https://docs.talkdesk.com/reference/getservices.md): Get the paginated list of services - [Get the paginated list of services](https://docs.talkdesk.com/reference/getservicesagent.md): Get the paginated list of services for agent view - [Get the paginated list of services](https://docs.talkdesk.com/reference/getservicelocations.md): Get the paginated list of services - [Get a service by id](https://docs.talkdesk.com/reference/getservicebyid.md): Get a service by id - [Get service next week opening hours](https://docs.talkdesk.com/reference/getservicenextweekopeninghours.md): Get a service next week opening hours - [Get Google geo addresses](https://docs.talkdesk.com/reference/getgeoaddresses.md): Get Google geo addresses. This API actually makes proxy calls to the Text Search of Google Place API. - [Get Google geocoding](https://docs.talkdesk.com/reference/getgeocoding.md): Get Google geocoding. This API actually makes proxy calls to the Google Geocoding API. - [Get the paginated list of service types](https://docs.talkdesk.com/reference/getservicetypes.md): Get the paginated list of service types - [Search staffs by conditions](https://docs.talkdesk.com/reference/getstaffs.md): Search staffs by conditions - [Get the paginated list of specialties](https://docs.talkdesk.com/reference/getspecialtiesserviceslocations.md): Get the paginated list of specialties - [Add or update locations, services, or staff members from a CSV file](https://docs.talkdesk.com/reference/publicuploadlocationsdirectory.md): Add (or update) a list of locations, services, or staff members from a CSV file. The endpoint accepts a directory_type path parameter that determines the type of directory to import. The CSV must use comma as the column separator. For pipe-separated multi-value fields, use pipe (|) as the list separator and colon (:) as the key-value separator. The CSV columns vary per type — see each section below. **locations — CSV columns** - **LOCATION_ID** - _optional_ - External identifier of the location. If omitted, a random UUID is generated. Used as the upsert key. - **LOCATION_NAME** - _required_ - Name of the location. - **LOCATION_ALTERNATIVE_NAMES** - _optional_ - Alternative names separated by |. Example: Store A|Store B - **LOCATION_TYPE** - _optional_ - Type/category of the location. Free text. - **ADDRESS_STREET** - _required_ - Street address of the location. - **ADDRESS_POSTAL_CODE** - _required_ - Postal/zip code of the location. - **ADDRESS_CITY** - _optional_ - City of the location. - **ADDRESS_REGION** - _optional_ - Region or state (country subdivision). - **COUNTRY_NAME** - _required_ - Country name. - **LOCATION_PICTURE_URL** - _optional_ - Public image URL. Must start with http:// or https:// and end in .jpg, .jpeg, .png, or .webp. Max 1MB, 550x220px. - **PHONE_NUMBER** - _optional_ - Phone numbers. Format per entry: number:label. Multiple entries separated by |. Example: +12029182132:Main|+12029182133:Fax - **TIMEZONE** - _required_ - IANA timezone ID. Example: America/Los_Angeles, Europe/Lisbon. - **BUSINESS_MON / BUSINESS_TUE / BUSINESS_WED / BUSINESS_THU / BUSINESS_FRI / BUSINESS_SAT / BUSINESS_SUN** - _optional_ - Business hours per weekday. Format per slot: hh:mmAM-hh:mmPM. Multiple slots separated by |. Example: 09:00AM-01:00PM|02:00PM-05:00PM - **SPECIAL_DATES** - _optional_ - JSON array of special dates/holidays. Each element has the fields name, date (yyyy-MM-dd), repeat_rule (DOES_NOT_REPEATS, MONTHLY, or YEARLY), business_hours (array of open_at/close_at in HH:mm:ss), and notes. --- **staffs — CSV columns** - **STAFF_ID** - _optional_ - External identifier of the staff member. If omitted, a random UUID is generated. - **NAME** - _required_ - Full name of the staff member. - **DESCRIPTION** - _optional_ - Bio or description of the staff member. - **SPECIALTIES** - _optional_ - Specialties separated by |. Example: cardiology|pediatrics - **PRONOUNS** - _optional_ - Pronouns. Example: she/her, he/his, they/them - **MANAGER** - _optional_ - Name of the direct manager/supervisor. - **JOB_TITLE** - _optional_ - Professional title. Example: Senior Cardiologist - **CONTACT** - _optional_ - Contact entries separated by |. Format per entry: type:value or type:value:description. Example: phone:+12029182132:Work|email:jane@example.com:Work Email - **PHOTO_URL** - _optional_ - Public photo URL. Must start with http:// or https:// and end in .jpg, .jpeg, .png, or .webp. - **GENDER** - _optional_ - Gender of the staff member. Free text. - **LANGUAGES** - _optional_ - Languages spoken, separated by |. Example: English|Spanish - **DATE_OF_BIRTH** - _optional_ - Date of birth. Format: yyyy-MM-dd or yyyy/MM/dd. Example: 1980-05-15 - **EMPLOYMENT_START_DATE** - _optional_ - Date of hire. Format: yyyy-MM-dd or yyyy/MM/dd. Example: 2018-03-01 - **LOCATION_AND_SERVICE_NAMES** - _optional_ - Location/service relationships separated by |. Format per entry: locationExternalId:serviceExternalId. Either part may be empty (e.g. :serviceId or locationId:). Both IDs must exist for the account, and the service must belong to the referenced location. Example: loc-id-1:svc-id-1|loc-id-2: - **VISIT_TYPES** - _optional_ - Visit types separated by |. Format per entry: id:name. Example: in-person:In-Person|virtual:Virtual - **TAGS** - _optional_ - JSON array of tag objects. Each element has the fields tag_name, background_color, and text_color (hex). Example: [{"tag_name":"VIP","background_color":"#EFDBFF","text_color":"#391085"}] --- **services — CSV columns** - **SERVICE_ID** - _optional_ - External identifier of the service. If omitted, a random UUID is generated. - **SERVICE_NAME** - _required_ - Name of the service. - **DESCRIPTION** - _required_ - Description of the service. - **SERVICE_TYPE** - _optional_ - Type/category of the service. Free text. - **DURATION** - _optional_ - Duration of the service. Free text. Example: 30-45 minutes - **VIRTUAL_LOCATION_URL** - _optional_ - URL for virtual/online appointments. - **PRICE** - _optional_ - Price of the service. Free text. Example: 50$, Free - **PHONE_NUMBER** - _optional_ - Phone numbers. Format per entry: number:label. Multiple entries separated by |. Example: +12029182132:Appointments - **TIMEZONE** - _optional — required when any BUSINESS_* column or SPECIAL_DATES is provided_ - IANA timezone ID. Example: Europe/Lisbon. - **BUSINESS_MON / BUSINESS_TUE / BUSINESS_WED / BUSINESS_THU / BUSINESS_FRI / BUSINESS_SAT / BUSINESS_SUN** - _optional_ - Business hours per weekday. Format per slot: hh:mmAM-hh:mmPM. Multiple slots separated by |. Example: 09:00AM-01:00PM|02:00PM-05:00PM - **LOCATIONS** - _optional_ - External IDs of associated locations separated by |. Each ID must exist for the account. Example: loc-ext-id-1|loc-ext-id-2 - **SPECIAL_DATES** - _optional_ - JSON array of special dates/holidays. Each element has the fields name, date (yyyy-MM-dd), repeat_rule (DOES_NOT_REPEATS, MONTHLY, or YEARLY), business_hours (array of open_at/close_at in HH:mm:ss), and notes. - [Get teams associated to an account](https://docs.talkdesk.com/reference/industries-scheduler-teams-get.md): Get teams associated to an account by team id - [Get availabilities by email](https://docs.talkdesk.com/reference/industries-scheduler-availabilities-post.md): Get availabilities of one or more emails - [Get appointments associated to an account](https://docs.talkdesk.com/reference/industries-scheduler-appointment-get.md): Get appointments associated to an account - [Create and notify appointment via SMS](https://docs.talkdesk.com/reference/industries-scheduler-appointment-post.md): Create calendar event and notify using SMS - [Update appointment by eventId](https://docs.talkdesk.com/reference/industries-scheduler-appointment-put.md): Update an appointment in scheduler by eventId and notify using SMS - [Delete appointment by eventId](https://docs.talkdesk.com/reference/industries-scheduler-appointment-cancel-post.md): Delete an appointment in scheduler by eventId - [List workflow schedules](https://docs.talkdesk.com/reference/listindustriesworkflowschedules.md): Returns the paginated list of workflow schedules owned by the authenticated account. - [Create a workflow schedule](https://docs.talkdesk.com/reference/createindustriesworkflowschedule.md): Creates a new schedule that will trigger the configured workflow on the given cron expression. - [Pause or resume a schedule](https://docs.talkdesk.com/reference/updateindustriesworkflowschedule.md): Updates the paused state of an existing schedule. - [Delete a schedule](https://docs.talkdesk.com/reference/deleteindustriesworkflowschedule.md): Permanently removes a schedule. - [List workflows](https://docs.talkdesk.com/reference/listindustriesworkflows.md): Returns the paginated list of workflows for the authenticated account. Supports filtering by workflow name, job name, status, time ranges, and tags. - [Start a workflow](https://docs.talkdesk.com/reference/startindustriesworkflow.md): Starts a new workflow for the authenticated account. - [Get a workflow](https://docs.talkdesk.com/reference/getindustriesworkflow.md): Returns the detailed state of a workflow, including its actions and associated schedule (when applicable). - [Cancel or terminate a workflow](https://docs.talkdesk.com/reference/updateindustriesworkflow.md): Transitions a running workflow to CANCELLED or TERMINATED. - [Get workflow progress](https://docs.talkdesk.com/reference/getindustriesworkflowprogress.md): Returns the overall completion percentage of a workflow along with per-action progress. - [Send Message](https://docs.talkdesk.com/reference/send_message.md): Send Message - [Send Email](https://docs.talkdesk.com/reference/send_email.md): Send Email - [Publish interaction custom fields](https://docs.talkdesk.com/reference/interaction-custom-fields-post.md): Publish interaction custom fields - [List Queues](https://docs.talkdesk.com/reference/getallqueues.md): Returns a paginated list of queues configured for the account. Use this endpoint to browse available queues, search by name, filter by prompt, or sort results. Queues represent logical groupings used to route interactions to the appropriate agents. - [Assign users to queues](https://docs.talkdesk.com/reference/assignuserstoqueues.md): Assigns the provided users to the provided queues. Some relevant information regarding this endpoint: - The operation is idempotent. If the user already has the queue it becomes a no-op. The API returns success as if the operation went through - It fails with the appropriate HTTP error code when the request does not conform to the pre-conditions - Any other failure that is not expected will be reported back in the response of endpoint with a `200 OK`. This means that consumers always have to check the response to determine if the operation was a success or not (or only partial success) - The endpoint is not transactional. If some error occurs it might have updated some resources ## Pre-conditions Currently the pre-conditions that are checked are: - Some invalid user id exists (it does not conform to the ID spec) - Some queue has over a number of defined (default 100) users in the payload. - [Unassings users to queues](https://docs.talkdesk.com/reference/unassignuserstoqueues.md): This endpoint receives objects with a queue identifier and the users to unassign from those queues. Some relevant information regarding this endpoint: - The operation is idempotent. If the user already is not assigned to a queue the operation becomes no-op. The API returns success as if the operation went through - It fails with the appropriate HTTP error code when the request does not conform to the pre-conditions - Any other failure that is not expected will be reported back in the response of endpoint with a `200 OK`. This means that consumers always have to check the response to determine if the operation was a success or not (or only partial success) - The endpoint is not transactional. If some error occurs it might have updated some resources - Its mandatory for a user to have at least one queue assigned ## Pre-conditions Currently the pre-conditions that are checked are: - Some invalid user id exists (it does not conform to the ID spec) - A object has over a number of defined (default 100) users in the payload. - There are up to 100 objects for the bulk request - [List Queue Users](https://docs.talkdesk.com/reference/getqueueusers.md): Returns a paginated list of users assigned to a specific queue. Use this endpoint to inspect queue membership, for example when auditing agent assignments or displaying queue details in a management UI. Results can be filtered by the user's active status. - [SMS Message Delivery](https://docs.talkdesk.com/reference/messages-post.md): Sends an outbound SMS message to a contact phone number using a Talkdesk phone number. The request is processed asynchronously and returns a 202 status on acceptance. Use this endpoint to programmatically deliver SMS notifications or messages to contacts. Phone numbers must be in E.164 format when provided. - [Campaign Messages Endpoint Options](https://docs.talkdesk.com/reference/campaignmessagesoptions.md): Returns the allowed HTTP methods for the campaign messages endpoint. - [Outbound Notifications Endpoint Options](https://docs.talkdesk.com/reference/outboundnotificationsoptions.md): Returns the allowed HTTP methods for the outbound notifications endpoint. - [Attributes List](https://docs.talkdesk.com/reference/getallattributes.md): Returns a paginated list of attributes for the account. Use this endpoint to retrieve attributes for display or filtering purposes, for example when building an agent management UI or verifying configuration. For team-scoped users, only attributes within their team scope are returned. Results can be filtered by name, active status, category, or proficiency type. - [Create a New Attribute](https://docs.talkdesk.com/reference/createattribute.md): Creates a new routing attribute in the account. Use this endpoint to programmatically add attributes as part of a configuration workflow or integration with an external workforce management system. For team-scoped users, only teams within their scope can be associated with the attribute. The attribute name, active status, category, proficiency type, and default proficiency are required fields. - [Attribute Details](https://docs.talkdesk.com/reference/getattribute.md): Returns the details of a specific attribute by its ID. Use this endpoint to retrieve attribute configuration for display or to verify attribute properties before performing updates. For team-scoped users, the attribute must be within their team scope. - [Update an Attribute](https://docs.talkdesk.com/reference/updateattribute.md): Updates the properties of an existing attribute. Use this endpoint to modify attribute configuration, such as changing its name, active status, category, or proficiency settings. For team-scoped users, the attribute must be within their team scope. Team-scoped users cannot remove all teams from an attribute — at least one accessible team must remain. - [Attribute Users List](https://docs.talkdesk.com/reference/getallattributeusers.md): Returns a paginated list of users to whom a specific attribute has been assigned. Use this endpoint to inspect attribute membership, for example when auditing agent skill assignments or building an attribute-users management view. For team-scoped users, the attribute must be within their team scope and only users within their teams are returned. Results can be filtered by attribute name. - [Associate Users to an Attribute](https://docs.talkdesk.com/reference/createattributeusers.md): Associates one or more users with a specific attribute, optionally setting a proficiency level for each user. Use this endpoint to assign skills or capabilities to agents programmatically, for example as part of a workforce management integration. For team-scoped users, both the attribute and the users must be within their team scope. - [Remove Association of Users to an Attribute](https://docs.talkdesk.com/reference/deleteattributeusers.md): Removes the association between one or more users and a specific attribute. Use this endpoint to unassign skills or capabilities from agents, for example when updating team rosters or revising skill configurations. For team-scoped users, both the attribute and the users must be within their team scope. - [Attributes Categories List](https://docs.talkdesk.com/reference/getallattributescategories.md): Returns a paginated list of attribute categories in the account. Use this endpoint to retrieve available categories for filtering or display, for example when rendering a category selector in an attribute management interface. Results can be sorted by name in ascending or descending order. - [Create a New Attribute Category](https://docs.talkdesk.com/reference/createattributecategory.md): Creates a new attribute category in the account. Use this endpoint to programmatically add categories as part of a configuration workflow. Category names must be unique within the account. - [Delete an Attribute Category](https://docs.talkdesk.com/reference/deleteattributecategory.md): Deletes an existing attribute category by its ID. Use this endpoint to remove categories that are no longer needed in your configuration. Note: deleting a category may affect attributes currently assigned to it. - [Update an Attribute Category](https://docs.talkdesk.com/reference/patchattributecategory.md): Updates the name of an existing attribute category. Use this endpoint to rename a category as part of ongoing configuration management. Category names must be unique within the account. - [User Attributes List](https://docs.talkdesk.com/reference/getuserattributes.md): Returns a paginated list of attributes assigned to a specific user. Use this endpoint to retrieve the full set of skills or capabilities for a given agent, for example when displaying a user profile or checking eligibility for specific queues. For team-scoped users, both the user and the attributes must be within their team scope. - [List Ring Groups](https://docs.talkdesk.com/reference/ring-groups-get.md): Returns a paginated list of ring groups for the account. Use this endpoint to retrieve all ring groups and their details, for example to build a directory or to support ring group assignment workflows. Results can be filtered by name and sorted by name in ascending or descending order. - [List Ring Group Users](https://docs.talkdesk.com/reference/ring-groups-id-users-get.md): Returns a paginated list of users assigned to a specific ring group. Use this endpoint to inspect ring group membership, for example when auditing agent assignments or displaying ring group details in a management UI. Results can be filtered by the user's active status. - [Get the list of apps](https://docs.talkdesk.com/reference/apps-get.md): Get the list of apps - [Submit app](https://docs.talkdesk.com/reference/apps-post.md): Submit app - [Get information about an app](https://docs.talkdesk.com/reference/apps-app-id-get.md): Get information about an app - [Partially updates the app info](https://docs.talkdesk.com/reference/apps-app-id-patch.md): Partially updates the app info - [Get information about installation](https://docs.talkdesk.com/reference/apps-app-id-installations-id-get.md): Get information about installation - [Get installation enabled users](https://docs.talkdesk.com/reference/apps-app-id-installations-id-users-get.md): Gets the users enabled for a given installation - [Set the state of the installation](https://docs.talkdesk.com/reference/apps-app-id-installations-id-state-post.md): set the state of the installation - [Get installation subscription](https://docs.talkdesk.com/reference/apps-app-id-installations-id-subscription-get.md): get the current subscription of the installation - [Get the installation trial information](https://docs.talkdesk.com/reference/apps-app-id-installations-id-trial-get.md): Get the installation trial information - [Rotates the installation's credentials](https://docs.talkdesk.com/reference/apps-app-id-installations-id-credentials-actions-rotate-post.md): rotates the installation's credentials - [Acknowledge installation credentials](https://docs.talkdesk.com/reference/apps-app-id-installations-id-credentials-client-id-state-post.md): creates a transition to 'acknowledged' of the installation's credentials resource - [Terminates all of the user's sessions](https://docs.talkdesk.com/reference/oauth-end-user-session-post.md): Terminates all active and inactive sessions for the specified user. - [Get event validation public key](https://docs.talkdesk.com/reference/events-signature-keys-key-id-get.md): Get public key used to validate events-api requests signature - [Request a new direct callback](https://docs.talkdesk.com/reference/calls-callback-post.md): Request a new direct callback, either to Callback API or Legacy Central (dependant on a Split IO Feature Flag) - [Get call recordings list](https://docs.talkdesk.com/reference/calls-call-id-recordings-get.md): Get list of recordings for a call, screen recording is not included - [Delete a recording](https://docs.talkdesk.com/reference/interactions-interaction-id-recordings-recording-id-delete.md): Permanently deletes the recording associated with the given recording ID and interaction ID. Use this endpoint to delete a specific recording from an interaction. The deletion is processed asynchronously — the request is accepted immediately and the recording file is removed in the background. Important behavior: - Requires the `recordings:delete` OAuth scope. - Returns `204 No Content` on success (no response body). - Returns `404` if the recording does not exist or does not belong to the specified interaction. - [Get recording details](https://docs.talkdesk.com/reference/recordings-id-get.md): Get recording details, screen recording is not included - [Redirect to the recording file](https://docs.talkdesk.com/reference/recordings-id-media-get.md): Redirect to the recording file, screen recording is not included - [Get consent recordings for an interaction using a share token](https://docs.talkdesk.com/reference/getconsentrecordingshared.md): Get consent-type recordings of an interaction using a secure share token. Only consent-type recordings are returned. Designed for third-party systems via OAuth Client Credentials flow with the recordings-consent:read scope. - [Get contacts list](https://docs.talkdesk.com/reference/list-contacts.md): The endpoint allows you to retrieve a list of contacts based on specific query parameters. This endpoint provides a flexible and efficient way to retrieve contact information based on different criteria. - [Get a contact by id](https://docs.talkdesk.com/reference/get-contact.md): The endpoint allows you to retrieve a specific contact by providing its unique contact ID as a path parameter. This endpoint provides a convenient way to fetch detailed information about a particular contact based on its ID. - [Delete a contact by id](https://docs.talkdesk.com/reference/contacts-contact-id-delete.md): Deletes a contact from the system. The contact is not permanently removed right away — it is marked as deleted and can be restored if needed. Use this when a user explicitly wants to remove a contact. **Does not erase personal data.** If the goal is compliance with a data erasure request, use the GDPR endpoint instead. - [Get a list of contact's integrations](https://docs.talkdesk.com/reference/contacts-contact-id-integrations-get.md): Returns a list of external tools or systems (e.g. Salesforce, Microsoft Dynamics) that this contact is linked to, along with a URL to view the contact in each of those systems. Use this when you need to know where a contact exists outside of Talkdesk. Only works for **active contacts** — deleted contacts return **404**. - [GDPR contacts by dates, list of phones or emails, tags, or contact ids](https://docs.talkdesk.com/reference/internal-contacts-gdpr-post.md): GDPR contacts by dates, list of phones or emails, tags, or contact ids - [Execute published flow](https://docs.talkdesk.com/reference/flows-flow-id-interactions-post.md): Starts an interaction that executes the published version of the flow - [Get Entry Details](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-id-entry-get.md): Returns the details of a specific entry in a Do Not Call List. Use this endpoint to retrieve a single entry by its ID. - [Update a Single Entry](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-id-entry-patch.md): Updates a specific entry in a Do Not Call List. Use this endpoint to modify the expiration date of an entry. - [Delete an Entry](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-id-entry-delete.md): Deletes a specific entry from a Do Not Call List. Use this endpoint to permanently remove a phone number entry from the list. - [List Entries](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-get.md): Returns a paginated list of entries from a Do Not Call List. Use this endpoint to retrieve all phone number entries with optional filtering and sorting. - [Create an Entry](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-post.md): Creates a new entry in a Do Not Call List. Use this endpoint to add a phone number to the list with an optional expiration date. - [Update Multiple Entries](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-patch.md): Updates multiple entries in a Do Not Call List in a single request. Use this endpoint to bulk update expiration dates or other entry attributes. - [Bulk Delete Entries](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-delete.md): Deletes multiple entries from a Do Not Call List in a single request. Use this endpoint to remove multiple phone number entries at once. - [Create a Do Not Call List](https://docs.talkdesk.com/reference/do-not-call-lists-post.md): Creates a new Do Not Call List and returns a signed URL to upload a CSV file. Use this endpoint to create a list and upload phone numbers that should not be contacted. - [List Do Not Call Lists](https://docs.talkdesk.com/reference/do-not-call-lists-get.md): Returns a paginated list of Do Not Call Lists for the account. Use this endpoint to retrieve all lists with optional filtering by name, status, team, and campaign. - [Get Do Not Call List Details](https://docs.talkdesk.com/reference/do-not-call-lists-id-get.md): Returns the details of a specific Do Not Call List. Use this endpoint to retrieve the full configuration and metadata of a list. - [Create or Duplicate Campaign](https://docs.talkdesk.com/reference/campaigns-post.md): Creates a new campaign or duplicates an existing one. Use this endpoint to set up a new outbound campaign with dialing mode, strategy, and contact lists. To duplicate, provide the source_id query parameter with the ID of the campaign to copy. - [List Campaigns](https://docs.talkdesk.com/reference/campaigns-get.md): Returns a paginated list of campaigns for the account. Use this endpoint to retrieve all campaigns with optional filtering by name, status, dialing mode, and other criteria. Supports sorting and searching with partial matches. - [Get Campaign Details](https://docs.talkdesk.com/reference/campaigns-id-get.md): Returns the details of a specific campaign. Use this endpoint to retrieve full campaign configuration including dialing mode and strategy. Specify the campaign ID in the path. - [Delete Campaign](https://docs.talkdesk.com/reference/campaigns-id-delete.md): Deletes a specific campaign. Use this endpoint to permanently remove a campaign from the account. A campaign that is currently running cannot be deleted and will return a conflict error. - [Update Campaign](https://docs.talkdesk.com/reference/campaigns-id-patch.md): Updates a specific campaign configuration. Use this endpoint to modify campaign settings such as name, dialing mode, strategy, or schedule. Accepts a JSON Patch request body with the fields to update. - [List Campaign Do Not Call Lists](https://docs.talkdesk.com/reference/campaigns-id-do-not-call-lists-get.md): Returns the Do Not Call Lists assigned to a specific campaign. Use this endpoint to view which Do Not Call Lists are currently associated with a campaign. Supports pagination and filtering by ID. - [Assign Do Not Call Lists](https://docs.talkdesk.com/reference/campaigns-id-do-not-call-lists-post.md): Assigns one or more Do Not Call Lists to a specific campaign. Use this endpoint to associate Do Not Call Lists with a campaign to prevent dialing numbers on those lists. - [Dissociate Do Not Call Lists](https://docs.talkdesk.com/reference/campaigns-id-do-not-call-lists-delete.md): Removes the association of one or more Do Not Call Lists from a specific campaign. Use this endpoint to dissociate Do Not Call Lists that are no longer needed for a campaign. - [List Campaign Record Lists](https://docs.talkdesk.com/reference/campaigns-id-record-lists-get.md): Returns the record lists assigned to a specific campaign. Use this endpoint to view which record lists are currently associated with a campaign. Supports pagination and filtering by ID. - [Assign Record Lists](https://docs.talkdesk.com/reference/campaigns-id-record-lists-post.md): Assigns one or more record lists to a specific campaign. Use this endpoint to associate record lists containing contact data with a campaign. - [Dissociate Record Lists](https://docs.talkdesk.com/reference/campaigns-id-record-lists-delete.md): Removes the association of one or more record lists from a specific campaign. Use this endpoint to dissociate record lists that are no longer needed for a campaign. - [List Campaign Users](https://docs.talkdesk.com/reference/campaigns-id-users-get.md): Returns the users (agents) assigned to a specific campaign. Use this endpoint to view which users are currently associated with a campaign. Supports pagination and filtering by user ID. - [Assign Users to Campaign](https://docs.talkdesk.com/reference/campaigns-id-users-post.md): Assigns one or more users to a specific campaign. Use this endpoint to associate agents with a campaign. The maximum number of user IDs per request is 50. - [Dissociate Users](https://docs.talkdesk.com/reference/campaigns-id-users-delete.md): Removes the association of one or more users from a specific campaign. Use this endpoint to dissociate agents that are no longer needed for a campaign. - [List Campaign Numbers](https://docs.talkdesk.com/reference/campaigns-id-numbers-get.md): Returns the phone numbers assigned to a specific campaign. Use this endpoint to view which numbers are currently associated with a campaign. Supports pagination and filtering by number ID. - [Assign Numbers to Campaign](https://docs.talkdesk.com/reference/campaigns-id-numbers-post.md): Assigns one or more phone numbers to a specific campaign. Use this endpoint to associate caller ID numbers with a campaign for outbound dialing. - [Dissociate Numbers](https://docs.talkdesk.com/reference/campaigns-id-numbers-delete.md): Removes the association of one or more phone numbers from a specific campaign. Use this endpoint to dissociate numbers that are no longer needed for a campaign. - [Search Entries](https://docs.talkdesk.com/reference/do-not-call-lists-id-entries-queries-post.md): Searches entries in a Do Not Call List by phone numbers and timezone. Use this endpoint to check whether specific phone numbers exist in the list and their expiration status. - [List Record Lists](https://docs.talkdesk.com/reference/record-lists-get.md): Returns a paginated list of record lists for the account. Use this endpoint to retrieve all record lists with optional filtering by name, status, team, and campaign. - [Create a Record List](https://docs.talkdesk.com/reference/record-lists-post.md): Creates a new record list and returns a signed URL to upload a CSV file. Use this endpoint to create a list and upload contact records for outbound campaigns. - [Get Record List Details](https://docs.talkdesk.com/reference/record-lists-id-get.md): Returns the details of a specific record list. Use this endpoint to retrieve the full configuration and metadata of a list. - [Update Record List Status](https://docs.talkdesk.com/reference/record-lists-id-patch.md): Updates the status of a record list and starts file validation. Use this endpoint after uploading a CSV file to trigger processing. - [Get Record Details](https://docs.talkdesk.com/reference/record-lists-id-records-id-record-get.md): Returns the details of a specific record within a record list. Use this endpoint to retrieve a single record by its ID. - [Delete a Record](https://docs.talkdesk.com/reference/record-lists-id-records-id-record-delete.md): Deletes a specific record from a record list. Use this endpoint to permanently remove a single contact record. - [Update a Record](https://docs.talkdesk.com/reference/record-lists-id-records-id-record-patch.md): Updates a specific record within a record list. Use this endpoint to modify record properties such as phone number, name, or priority. - [Get a List of Records](https://docs.talkdesk.com/reference/record-lists-id-records-get.md): Returns a paginated list of records from a record list. Use this endpoint to retrieve all contact records with optional filtering, searching, and sorting. - [Create a Record](https://docs.talkdesk.com/reference/record-lists-id-records-post.md): Creates a new record in a record list. Use this endpoint to add a single contact record with phone number and optional metadata. - [Delete Records by Phone Number](https://docs.talkdesk.com/reference/record-lists-id-records-delete.md): Deletes all records matching a phone number from a record list. Use this endpoint to remove all contact records associated with a specific phone number. - [List Record Timezones](https://docs.talkdesk.com/reference/record-lists-id-records-timezones-get.md): Returns a paginated list of timezones present in a record list. Use this endpoint to view the timezone distribution of records in a list. - [Delete External Records](https://docs.talkdesk.com/reference/record-lists-id-external-records-delete.md): Deletes records from a record list by external provider and external ID. Use this endpoint to remove records that were imported from an external source. - [Create Multiple Records](https://docs.talkdesk.com/reference/record-lists-id-records-bulks-post.md): Creates multiple records in a record list in a single request. Use this endpoint to bulk insert contact records. - [Update Multiple Records](https://docs.talkdesk.com/reference/record-lists-id-records-bulks-patch.md): Updates multiple records in a record list in a single request. Use this endpoint to bulk update contact record properties. - [Bulk Delete Records](https://docs.talkdesk.com/reference/record-lists-id-records-bulks-delete.md): Deletes multiple records from a record list in a single request. Use this endpoint to bulk remove records by record IDs, phone numbers, or external provider references. - [Create Upload Request](https://docs.talkdesk.com/reference/record-lists-id-upload-requests-post.md): Creates a signed URL to upload a CSV file into an existing record list. Use this endpoint to add more records to an existing list via file upload. - [Update Upload Request](https://docs.talkdesk.com/reference/record-lists-id-upload-requests-id-upload-request-patch.md): Updates an upload request status and starts file validation. Use this endpoint after uploading a CSV file to trigger record processing. Optionally notifies via WebHook or Workspace notification when finished. - [Get activities](https://docs.talkdesk.com/reference/getactivities.md): Returns the paginated history of contact voice authentication activities for the account, such as authentication attempts and other identity-related events captured during calls. Use this endpoint to power dashboards, audit views or reporting flows that need a chronological feed of identity activity for contacts in the account.
The list is paginated and the maximum page size is 250 items, so larger exports must use the CSV-producing variant of this endpoint instead. When the contact query parameter is true (the default), activity entries are enriched with the matching contact's name and id resolved from the phone number; setting it to false skips that lookup and returns the raw activity records. - [Get an email address validation](https://docs.talkdesk.com/reference/getemailvalidation.md): Returns reputation and risk information for an email address, such as deliverability and fraud signals. Use this endpoint to inspect an email address before deciding how to handle the corresponding contact, for example to flag disposable or high-risk addresses before triggering downstream workflows.
The email address is passed in the URL path and must be URL-encoded if it contains characters that require escaping. Each validation is billable for accounts with an active Identity license. - [Get an email address validation stats](https://docs.talkdesk.com/reference/getemailvalidationstats.md): Returns aggregated statistics about how often a given email address has been validated within the current account. Use this endpoint to drive reuse and throttling decisions on the caller side, for example to avoid issuing redundant validation calls for emails already checked many times.
The lookup is local to the account and does not call the external validation provider, so it is not billable and is safe to call frequently. The optional interaction_id query parameter is used purely for correlation in logs and does not affect the returned counts. Counts only cover validations performed via the validation endpoint; emails never validated return zero. - [Get an IP address validation](https://docs.talkdesk.com/reference/getipvalidation.md): Returns reputation and risk information for an IP address, such as geolocation and fraud signals. Use this endpoint to inspect an IP address before deciding how to handle the corresponding contact, for example to flag high-risk addresses before triggering downstream workflows.
The IP address is passed in the URL path. Each validation is billable for accounts with an active Identity license. - [Get a phone number validation data](https://docs.talkdesk.com/reference/getphonevalidation.md): Returns reputation and quality information for a phone number, such as fraud and risk signals. Use this endpoint to inspect a phone number before deciding how to handle the corresponding contact, for example to flag suspicious callers or to route low-risk numbers through a faster path.
The phone number must be provided in E.164-style format. Each validation is billable for accounts with an active Identity license. For aggregate usage information, use the stats variant of this endpoint instead. - [Get a phone number validation data](https://docs.talkdesk.com/reference/getphonevalidationstats.md): Returns aggregated statistics about how often a given phone number has been validated within the current account. Use this endpoint to drive reuse and throttling decisions on the caller side, for example to avoid issuing redundant validation calls for numbers already checked many times.
The lookup is local to the account and does not call the external validation provider, so it is not billable and is safe to call frequently. The optional interaction_id query parameter is used purely for correlation in logs and does not affect the returned counts. Counts only cover validations performed via the validation endpoint; numbers never validated return zero. - [Deletes the contact's enrollment information](https://docs.talkdesk.com/reference/deleteenrollment.md): Deletes the voice biometrics enrollment information for a contact so the contact is no longer recognized by voice authentication, and resets the contact's consent status accordingly. Use this endpoint to opt-out an enrolled user, for example when the contact requests removal of their voice profile as part of a right-to-be-forgotten request or before re-enrolling from scratch.
The contact must already exist in voice biometrics, otherwise the request returns 404; if the contact is already in a non-enrolled state, the call is treated as a no-op except for resetting consent. Downstream bookkeeping and provider-side voice profile deletion depend on whether the account has an Identity license, and subsequent authentication attempts for this contact will fail until a new enrollment is created. - [Creates a new contact enrollment](https://docs.talkdesk.com/reference/createenrollment.md): Creates or replaces the active voice biometrics enrollment for a contact, associating it with a chosen enrollment phrase. Use this endpoint to register a contact for active (phrase-based) voice biometrics authentication, after the contact has selected a phrase from the available catalog.
Only the enrollment intent is registered here — the actual voice sample is captured separately during a call via the call-level enrollment flow. If the contact does not yet exist, it is created automatically and its consent is marked as granted. The phrase_id must reference an existing phrase, otherwise the request returns 404. Re-issuing this request replaces the phrase association but preserves the existing consent state. - [Provides a contact's consent for voice biometrics authentication](https://docs.talkdesk.com/reference/getconsent.md): Returns the current consent state recorded for a contact in voice biometrics authentication. Use this endpoint to check whether the contact has agreed to be enrolled and authenticated by voice, for example before offering voice authentication in a self-service flow.
A response is only returned if the contact is known to voice biometrics; if no consent record exists yet for the contact, the request returns 404. - [Changes a contact's consent for voice biometrics authentication](https://docs.talkdesk.com/reference/editconsent.md): Sets the consent state for a contact in voice biometrics authentication, either creating a new consent record or updating an existing one. Use this endpoint to capture the contact's decision after they have been informed about voice biometrics, for example to mark consent as granted before enrolling them or as revoked when the contact opts out.
Returns 200 when an existing consent record is updated and 201 when a new one is created. Revoking consent does not by itself delete an existing enrollment; use the enrollment delete endpoint to remove the contact's voiceprint. - [Bulk import agent schedule events from CSV](https://docs.talkdesk.com/reference/postscheduleeventimport.md): Bulk imports agent schedule events (shifts, time off, breaks, meetings) from a CSV file. Use this endpoint to synchronize agent schedules from external HRIS, scheduling systems, or workforce applications. Submits a CSV file for asynchronous processing and returns a 202 Accepted response. The response includes a Location header with the URI to poll for import status. When processing completes, check the status endpoint to retrieve any error details in downloadable CSV format. This endpoint enables adherence tracking integration from external systems without requiring manual re-entry of schedules in the WFM UI. - [Get schedule import status and error report URL](https://docs.talkdesk.com/reference/getscheduleeventimport.md): Retrieves the current status of a schedule event import. Use this endpoint to poll for import completion after submitting a bulk import request. When status is IMPORTED_WITH_ERRORS, a presigned S3 URL (valid for 10 minutes) is included in the response to download the error report CSV. The error report lists invalid rows and corresponding validation error messages for corrective re-import. Poll this endpoint every 10-30 seconds after import submission until status is no longer IMPORTING. - [A time off is deleted by an external service](https://docs.talkdesk.com/reference/deletetimeoffaionexternal.md): Time off deleted by an external service - [A time off is updated by an external service](https://docs.talkdesk.com/reference/updatetimeoffaionexternal.md): Time off updated by an external service. - [A time off is created by an external service](https://docs.talkdesk.com/reference/createtimeoffaionexternal.md): Creates a TimeOff and returns the newly created TimeOff item - [Retrieve agent schedule as iCalendar](https://docs.talkdesk.com/reference/getagentcalendarschedule.md): Returns the agent's schedule in iCalendar format (RFC 5545). This endpoint is publicly accessible via a unique token and does not require JWT authentication or OAuth scopes. - [Subscribe to a New Stream](https://docs.talkdesk.com/reference/live-subscriptions-post-2.md): Get real-time data via HTTP SSE notifications for Talkdesk Live. Subscribe for a new stream to receive live data updates. - [Get subscription](https://docs.talkdesk.com/reference/live-subscriptions-subscription-id-get-2.md): Get Subscription - [Connect to the subscription stream](https://docs.talkdesk.com/reference/live-subscriptions-subscription-id-stream-get.md): Connect to the subscription stream - [Update query from subscription](https://docs.talkdesk.com/reference/live-subscriptions-subscription-id-entries-id-put-2.md): Update query from subscription - [List available queries](https://docs.talkdesk.com/reference/live-queries-get-2.md): List available queries - [Get report jobs by type](https://docs.talkdesk.com/reference/data-reports-type-jobs-get.md): Gets all jobs from a report type - [Creates a new report job](https://docs.talkdesk.com/reference/data-reports-type-jobs-post.md): Creates a new report job - [Get job report execution details](https://docs.talkdesk.com/reference/data-reports-type-jobs-id-get.md): Get job report execution details - [Cancel a report job](https://docs.talkdesk.com/reference/data-reports-type-jobs-id-cancel-post.md): Cancels a report job while it's still `created` or `processing`, canceling the underlying execution and immediately freeing the account's quota slot. Jobs already in a terminal status (`done`, `failed`, `canceled`, `deleted`) cannot be canceled. - [Get job report execution result](https://docs.talkdesk.com/reference/data-reports-type-files-id-get.md): Get job report execution result - [Delete a report](https://docs.talkdesk.com/reference/data-reports-type-files-id-delete.md): Delete a report - [Get all session logs odata](https://docs.talkdesk.com/reference/logsresource_getsessionsodata.md): Returns a list of session logs. - [Get all cases](https://docs.talkdesk.com/reference/casesresource_getcasesodata.md): Returns a list of cases. - [Get all users](https://docs.talkdesk.com/reference/usersresource_getallusersodata.md): Returns a paged list of users. - [Get user by id.](https://docs.talkdesk.com/reference/usersresource_getusers.md): Returns an agent. - [Get user role changes](https://docs.talkdesk.com/reference/usersresource_getuserroles.md): Returns a paged list of agent role changes. - [Get call quality metrics](https://docs.talkdesk.com/reference/callsresource_getcallqualityodata.md): Returns a paginated list of historical call quality metrics, including jitter, round-trip time (RTT), MOS scores, and packet loss percentages per call. - [Get list of users](https://docs.talkdesk.com/reference/users-get.md): Get list of Users - [Get user details](https://docs.talkdesk.com/reference/get-user.md): Get User Details - [Set external_id of user from integration](https://docs.talkdesk.com/reference/users-user-id-integrations-integration-name-post.md): Post request to set external_id of user from integration - [Get user info (OpenID Connect)](https://docs.talkdesk.com/reference/users-me.md): User info endpoint as per the OpenId Connect spec - [Pause a recording given a contact](https://docs.talkdesk.com/reference/users-email-recordings-pause-post.md): Pause a recording given a contact person's email from an ongoing interaction. - [Start a recording given a contact](https://docs.talkdesk.com/reference/users-email-recordings-start-post.md): Start a recording given a contact person's email from an ongoing interaction. - [Get Users](https://docs.talkdesk.com/reference/getusers.md): Queries multiple user identities in authenticate account. Filtering is available. - [Create User](https://docs.talkdesk.com/reference/createusers.md): Creates new user in authenticated account - [Delete User](https://docs.talkdesk.com/reference/deleteuser.md): Deletes user from account - [User Details](https://docs.talkdesk.com/reference/getuser.md): Get user details - [Update partial User's attributes](https://docs.talkdesk.com/reference/patchuser.md): Change selected fields of the User entity (cannot change ID). - [Update User's attributes](https://docs.talkdesk.com/reference/updateuser.md): Change all fields of the User entity (cannot change ID). - [Get Service Provider Configurations](https://docs.talkdesk.com/reference/getserviceproviderconfigs.md): Check the service provider configurations available in this instance - [Get Service Provider's Resource Types](https://docs.talkdesk.com/reference/getresourcetypes.md): Check the service provider available resource types - [Get Service Provider's User Resource Type](https://docs.talkdesk.com/reference/getuserresourcetypes.md): Check User Resource Type - [Get Schemas](https://docs.talkdesk.com/reference/getschemas.md): Retrieve all schema definitions supported by the service provider - [Get Schema by ID](https://docs.talkdesk.com/reference/getschema.md): Retrieve a specific schema definition by its unique URI identifier - [Get account wallet list](https://docs.talkdesk.com/reference/account-wallets-get.md): Get account wallet list - [Get single account wallet](https://docs.talkdesk.com/reference/account-wallets-name-get.md): Get single account wallet - [Get all bucket configurations of an account.](https://docs.talkdesk.com/reference/account-bucket-configurations-get.md): Get all bucket configurations. - [Creating a case](https://docs.talkdesk.com/reference/creatingacase.md): Creating a case. - [Deleting cases softly](https://docs.talkdesk.com/reference/deletingcasessoftly.md): Deleting cases softly. - [Getting a list of cases](https://docs.talkdesk.com/reference/gettingalistofcases.md): Getting a list of cases. - [Getting case details](https://docs.talkdesk.com/reference/gettingcasedetails.md): Getting case details. - [Updating a case](https://docs.talkdesk.com/reference/updatingacase.md): Updating a case. - [Getting newest case details by contact](https://docs.talkdesk.com/reference/gettingnewestcasedetailsbycontact.md): Getting newest case details by contact. - [Deleting cases permanently](https://docs.talkdesk.com/reference/deletingcasespermanently.md): Deleting cases permanently. - [Update a case note](https://docs.talkdesk.com/reference/updateacasenote.md): Update a case note. - [Getting a list of case fields](https://docs.talkdesk.com/reference/gettingalistofcasefields.md): Getting a list of case fields. - [Get list of imports](https://docs.talkdesk.com/reference/bulk-imports-users-get.md): Get list of imports - [Create a new import](https://docs.talkdesk.com/reference/bulk-imports-users-post.md): Create a new import - [Get an import](https://docs.talkdesk.com/reference/bulk-imports-users-import-id-get.md): Get an import - [Updates one import](https://docs.talkdesk.com/reference/bulk-imports-users-import-id-patch.md): Updates one import - [Get a CSV file containing errors](https://docs.talkdesk.com/reference/bulk-imports-users-import-id-errors-get.md): Get a CSV file containing errors from an import - [Get the outputs of an export](https://docs.talkdesk.com/reference/bulk-imports-users-import-id-outputs-get.md): Get the outputs of an export job - [Start recording for ongoing interaction](https://docs.talkdesk.com/reference/interactions-interaction-id-actions-start-recording-post.md): Starts a recording for an ongoing interaction where an agent is in conversation with a contact person - [Pause recording for ongoing interaction](https://docs.talkdesk.com/reference/interactions-interaction-id-actions-pause-recording-post.md): Pauses a recording for an ongoing interaction where an agent is in conversation with a contact person - [create or update the Time off balance.](https://docs.talkdesk.com/reference/puttimeoffbalanceexternal.md): Import time off balance. - [A time off balance is deleted by an external service](https://docs.talkdesk.com/reference/deletetimeoffbalanceexternal.md): Deletes a time off balance - [Create and publish an event to the automated-notifications system.](https://docs.talkdesk.com/reference/create-fsi-insurance-connections-automated-notification.md): Create and publish an event to the automated-notifications system. - [Get accounts from a search criteria](https://docs.talkdesk.com/reference/searchingfsiinsuranceaccount.md): Get accounts from a search criteria - [Get account with account number](https://docs.talkdesk.com/reference/gettingfsiinsuranceaccount.md): Get account with account number - [Get policies from an account holder](https://docs.talkdesk.com/reference/gettingfsiinsurancepolicies.md): Get policies from an account holder - [Get policy period from a policy](https://docs.talkdesk.com/reference/gettingfsiinsurancepoliciesperiod.md): Get policy period from a policy - [Search policies](https://docs.talkdesk.com/reference/fsi-insurance-integrations-policies-get.md): Search policies - [Get policy metadata from a policy](https://docs.talkdesk.com/reference/fsi-insurance-integrations-policies-id-metadata-get.md): Get policy metadata from a policy - [Create a new claim through FNOL](https://docs.talkdesk.com/reference/fsi-insurance-integrations-claims-post.md): Create a new claim through FNOL - [Get billing by account holder member](https://docs.talkdesk.com/reference/fsi-insurance-integrations-account-holders-id-billing-get.md): Get billing by account holder member id - [Get billing details by account holder](https://docs.talkdesk.com/reference/fsi-insurance-integrations-account-holders-id-billing-details-get.md): Get billing details by account holder member id - [Search claims related to account holders](https://docs.talkdesk.com/reference/fsi-insurance-integrations-accounts-account-number-claims-get.md): Search claims related to account holders (contacts) - [Get claim by id](https://docs.talkdesk.com/reference/fsi-insurance-integrations-claims-id-get.md): Get claim by id - [Update contact details for an account](https://docs.talkdesk.com/reference/fsi-insurance-integrations-contacts-id-patch.md): Update contact details for an account holder such as phone number, address or email - [Send document delivery by SMS and email](https://docs.talkdesk.com/reference/fsi-insurance-integrations-document-deliveries-post.md): send document delivery by sms and email - [Get claim by id](https://docs.talkdesk.com/reference/fsi-insurance-connections-claims-id-get.md): Get claim by id - [Search claims related to a policy](https://docs.talkdesk.com/reference/fsi-insurance-connections-policies-policy-number-claims-get.md): Search claims related to a policy - [Search claims related to an account](https://docs.talkdesk.com/reference/fsi-insurance-connections-accounts-account-number-claims-get.md): Search claims related to an account - [Returns the collection of the accounts that are under the caller's organization.](https://docs.talkdesk.com/reference/expressgetaccounts.md): All the accounts that are under the organization calling the rest API will be returned. The IDs of the accounts can later be used to retrieve information on those accounts. The results are paged. - [Returns a collection of products.](https://docs.talkdesk.com/reference/getproducts.md): All the available products. The results are paged. - [Returns info on the account subscription.](https://docs.talkdesk.com/reference/getaccountsubscriptions.md): Returns info on the accounts subscriptions. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged. - [Returns a collection of invoice lines for the given accounts.](https://docs.talkdesk.com/reference/getaccountinvoices.md): All the invoice lines will be returned for the accounts under the organization. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged. - [Returns a collection of usage data aggregated by month.](https://docs.talkdesk.com/reference/getaccountusagemonth.md): All the usage data will be returned for the accounts under the organization. The data is aggegated by month for each product. A 403 error is returned if the specified accounts are not under the organization performing the call. The results are paged. - [List Scheduled Callbacks](https://docs.talkdesk.com/reference/listscheduledcallbacks.md): Returns a paginated list of scheduled callbacks with total count. Use this endpoint to retrieve callbacks with optional filtering by status, phone number, agent, campaign, and time range. - [Create a Callback](https://docs.talkdesk.com/reference/createscheduledcallback.md): Creates a new scheduled callback and returns the created resource. Use this endpoint to schedule a callback for a specific phone number with optional agent assignment and time scheduling. - [Cancel a Callback](https://docs.talkdesk.com/reference/schedule-callbacks-id-delete.md): Cancels a specific scheduled callback. Use this endpoint to cancel a callback that is no longer needed. - [Update a Callback](https://docs.talkdesk.com/reference/schedule-callbacks-id-patch.md): Updates a specific scheduled callback. Use this endpoint to modify callback properties such as scheduled time, phone number, or agent assignment. - [Get Callback Details](https://docs.talkdesk.com/reference/schedule-callbacks-id-get.md): Returns the full details of a specific scheduled callback including status, timestamps, and metadata. Use this endpoint to retrieve a single callback by its ID. - [Get a patient's billing summary](https://docs.talkdesk.com/reference/getpatientbillingsummary.md): Retrieve billing summary for a given patient, including guarantor accounts, billing sections, transaction summaries, and charges. - [Search a patient's coverage](https://docs.talkdesk.com/reference/searchpatientcoverages.md): Search a certain coverage of a given patient. - [Get a patient's coverage details](https://docs.talkdesk.com/reference/getpatientcoveragedetails.md): Retrieves detailed information about a specific insurance coverage for a patient. - [Schedule appointments](https://docs.talkdesk.com/reference/scheduleappointment.md): Schedule the appointment passed on body on the interaction using interactionId. - [Get future appointments](https://docs.talkdesk.com/reference/getfutureappointments.md): Get a list of future appointments connected via an interactionId. - [Cancel appointments](https://docs.talkdesk.com/reference/cancelappointment.md): Cancel the appointment via appointmentId and patientId of interactionId. - [Send HL7 Events.](https://docs.talkdesk.com/reference/sendhl7events.md): Endpoint for the healthcare providers to send raw HL7 events. - [Search provider availability slots for VA returning a ProviderAvailabilityVA object](https://docs.talkdesk.com/reference/provideravailableappointmentsva.md): Search provider available appointment slots using interactionId returning one ProviderAvailabilityVA object only. If the search finds multiple slots a ProviderAvailabilityVA object is returned with its remaining property pointing to the number of results found (not considering the one returned) and the closest slot. If no slots are found then the remaining property returns -1. - [Search provider availability slots returning a list of ProviderSlot objects. Deprecated, please use `/healthcare/available-provider-slots` instead.](https://docs.talkdesk.com/reference/provideravailableslots.md): [Deprecated, please use `/healthcare/available-provider-slots` instead.] Search provider available appointment slots returning a HalPaginatedResource. If the search finds multiple slots a ProviderSlot list is returned within the _embedded property of HalPaginatedResource; each ProviderSlot represents one available slot for the executed search. If no slots are found then the _embedded property of HalPaginatedResource returns an empty list. - [Search provider availability slots returning a list of ProviderSlot objects.](https://docs.talkdesk.com/reference/getprovideravailableslots.md): Search provider available appointment slots returning a HalPaginatedResource. If the search finds multiple slots a ProviderSlot list is returned within the _embedded property of HalPaginatedResource; each ProviderSlot represents one available slot for the executed search. If no slots are found then the _embedded property of HalPaginatedResource returns an empty list. - [Get the balance of a patient](https://docs.talkdesk.com/reference/getbalances.md): Get the balance of a patient connected via an interactionId. - [Search suggest provider returning a list of Provider's names](https://docs.talkdesk.com/reference/suggestproviders.md): Search suggest provider returning a HalPaginatedResource. If the search finds multiple providers a ProviderVoiceVA list is returned within the _embedded property of HalPaginatedResource; each ProviderVoiceVA represents a name of a provider for the executed search. If no providers are found then the _embedded property of HalPaginatedResource returns an empty list. - [Search by patients returning a PatientStudio object](https://docs.talkdesk.com/reference/searchpatientsstudio.md): Search by patients returning one PatientStudio object only. If the search result returns a number of patients different from one, a PatientStudio object is returned with its count property pointing to the number of results found. - [Search patients returning brief information of the patient](https://docs.talkdesk.com/reference/searchpatientsstudiobrief.md): Search patients returning brief information of the patient, this API is a brief implementation of the patient_studio API, it will respond faster and only return patient basic information. - [Get the patient information of a patient.](https://docs.talkdesk.com/reference/patientinformation.md): Get the patient information of a patient. - [Write to the HLS Providers Call Answered API](https://docs.talkdesk.com/reference/healthcarecallanswered.md) - [Update Talkdesk contact by phone number with the patient information for the given interaction id](https://docs.talkdesk.com/reference/updatetalkdeskcontact.md) - [Reset Talkdesk contact by phone number](https://docs.talkdesk.com/reference/resettalkdeskcontact.md): Reset Talkdesk contact by phone number (e.g. remove all traits of this contact except the phone number, and rename the contact name to said phone number) - [Act (Pause or resume) call recording of specified EHR agent](https://docs.talkdesk.com/reference/phoneaction.md): Act (Pause or resume) call recording of specified EHR agent - [Initiate call for authorized EHR agent](https://docs.talkdesk.com/reference/clicktocall.md): Initiate call for authorized EHR agent - [Outgoing SMS - EPIC](https://docs.talkdesk.com/reference/outgoingsms.md): EPIC request to send outgoing SMS - [Agent status sync for Epic](https://docs.talkdesk.com/reference/agentstatussync.md): EPIC request to sync agent status changes - [Send inbasket message](https://docs.talkdesk.com/reference/sendinbasketmessage.md): Send inbasket message to Epic - [Reset patient password](https://docs.talkdesk.com/reference/resetpatientpassword.md): Send a password reset request to the patient's healthcare portal (e.g., MyChart). This is a provider-agnostic endpoint that works across different EHR systems. **Prerequisites:** - A patient lookup must be performed first within the same interaction - The patient must have a healthcare portal account (e.g., MyChart) configured - [Get the jwks to be used within the header of the jwt epic oauth2 flow](https://docs.talkdesk.com/reference/healthcareepicoauthjwks.md): Get the jwks to be used within the header of the jwt epic oauth2 flow - [Search by patients on VA returning a PatientStudio object](https://docs.talkdesk.com/reference/searchpatientsva.md): Search by patients returning one PatientStudio object only. If the search result returns a number of patients different from one, a PatientStudio object is returned with its count property pointing to the number of results found. - [Get the prescriptions of a patient, adapted for the VA](https://docs.talkdesk.com/reference/prescriptionsva.md): Get all prescriptions associated with a patient, returning a HalPaginatedResource. - [Request a prescription refill, adapted for the VA](https://docs.talkdesk.com/reference/prescriptionrefillva.md): Request a prescriptions associated with a patient, returning a HalPaginatedResource. - [Cancel appointments on VA](https://docs.talkdesk.com/reference/cancelappointmentva.md): Cancel the appointment that is selected on the interaction using interactionId. - [Schedule appointments on VA](https://docs.talkdesk.com/reference/scheduleappointmentva.md): Schedule the appointment that is selected on the interaction using interactionId. - [Search future appointments on VA returning a FutureAppointmentsVA object](https://docs.talkdesk.com/reference/futureappointmentsva.md): Search patients future appointments using interactionId returning one FutureAppointmentsVA object only. If the search finds multiple appointments a FutureAppointmentsVA object is returned with its total property pointing to the number of results found and the closest appointment. - [Resets VA Arrays and returns patient studio information for specific interaction](https://docs.talkdesk.com/reference/resethealthcareprovidersva.md): This endpoint resets the all VA arrays for when VA needs to switch context, and grabs patient studio information from REDIS to prevent extra unnecessary patient lookup - [Get encounters](https://docs.talkdesk.com/reference/getencounters.md): Get a list of encounters connected via an interactionId. - [Get the medication orders of a patient](https://docs.talkdesk.com/reference/getpatientmedicationorders.md): Get the medication orders of a patient - [Appointment Confirmation](https://docs.talkdesk.com/reference/confirmappointment.md): Triggers a confirmation process, signaling to the EHR that the patient will attend - [Reschedule an appointment](https://docs.talkdesk.com/reference/rescheduleappointment.md): Reschedule an existing appointment using its unique appointment ID. - [Appointment Confirmation](https://docs.talkdesk.com/reference/confirmappointmentva.md): Triggers a confirmation process, signaling to the EHR that the patient will attend - [Get service requests](https://docs.talkdesk.com/reference/getservicerequests.md): Get a list of service requests connected via an interactionId. - [Get the procedures of a patient, as public endpoint for VA usage](https://docs.talkdesk.com/reference/patientproceduresva.md): Get all procedures associated with a patient, returning a HalPaginatedResource. - [Diagnosis API, returns diagnosis results, whether to continue asking the next question, and the content of the question](https://docs.talkdesk.com/reference/diagnosispublic.md): Diagnosis API, returns diagnosis results, whether to continue asking the next question, and the content of the question - [Triage API, returns triage level](https://docs.talkdesk.com/reference/triagepublic.md): Triage API, returns triage level. - [Store interaction-specific configuration overrides.](https://docs.talkdesk.com/reference/storeinteractionoverrides.md): Store configuration overrides scoped to a specific interaction. The overrides are applied to all requests within the given interaction context, allowing per-interaction customisation of provider settings (e.g. temporarily switching the active EHR provider for a single interaction). - [Create a case documents of a patient.](https://docs.talkdesk.com/reference/patientcases.md): Create a case documents of a patient. - [Get the outstanding orders of a patient.](https://docs.talkdesk.com/reference/getoutstandingorderspublic.md): Get the outstanding orders of a patient. - [Save intent of a patient.](https://docs.talkdesk.com/reference/saveintentpublic.md): Save intent of a patient. - [Get Medication Statement.](https://docs.talkdesk.com/reference/getmedicationstatements.md): Get a list of medication statement via an patient id. - [Create Medication Statement.](https://docs.talkdesk.com/reference/createmedicationstatement.md): Create medication statement. - [Create medication order(request).](https://docs.talkdesk.com/reference/createmedicationorder.md): Create medication order(request). - [Verify patient data](https://docs.talkdesk.com/reference/verifypatient.md): Verifies caller-provided patient data (e.g. street address, city, state, and postal code) against the patient record in the configured EHR, returning a similarity score and a match boolean. - [Get patient's last known location](https://docs.talkdesk.com/reference/getpatientlastlocation.md): Get a list of patient's last known locations. - [Get the appointment practices of a patient](https://docs.talkdesk.com/reference/getpatientpractices.md): Get the appointment practices of a patient - [Get guarantor identifiers](https://docs.talkdesk.com/reference/getguarantoridentifiers.md): Returns identifiers that uniquely reference a guarantor in the upstream EHR. - [Get guarantor billing summary](https://docs.talkdesk.com/reference/getguarantorbillingsummary.md): Returns the billing summary for a guarantor, including balance details, aging summaries, payment plan information, and associated patient records. At least one of `patient_id` or `self_service_id` must be provided. - [Reset guarantor password](https://docs.talkdesk.com/reference/resetguarantorpassword.md): Send a password reset request to the guarantor's healthcare portal (e.g., MyChart). This is a provider-agnostic endpoint that works across different EHR systems. **Prerequisites:** - A guarantor lookup must be performed first within the same interaction - The guarantor must have a healthcare portal account (e.g., MyChart) configured - [List Public Certificates](https://docs.talkdesk.com/reference/external-credentials-get-certificates.md): Retrieve JSON Web Key Set (JWKS) used for token verification. Use this endpoint to obtain the public keys needed to validate signed tokens issued by Talkdesk. Results can be filtered by one or more tags using the tag query parameter. - [Certificates Endpoint Options](https://docs.talkdesk.com/reference/external-credentials-options-certificates.md): Returns the allowed HTTP methods for the certificates endpoint. - [Get Account configuration](https://docs.talkdesk.com/reference/getaccountconfiguration.md): Retrieves an Account configuration. - [Delete Account configuration](https://docs.talkdesk.com/reference/deleteaccountconfiguration.md): Deletes an Account configuration. - [Get Event Types](https://docs.talkdesk.com/reference/geteventtypes.md): Retrieve list of event types - [Create new event type](https://docs.talkdesk.com/reference/createeventtype.md): Create a new event type. - [Get Event Type by id](https://docs.talkdesk.com/reference/geteventtype.md): Retrieve the event type - [Update an event type](https://docs.talkdesk.com/reference/updateeventtype.md): Updates an existing automated notification event type by its ID. Use this endpoint to modify the event type configuration, such as its name or associated properties. The full event type object must be provided; partial updates are not supported. - [Delete a event type](https://docs.talkdesk.com/reference/deleteeventtype.md): Deletes an automated notification event type by its ID. Use this endpoint to remove event types that are no longer needed. This operation cannot be reversed, and any rules referencing the deleted event type may be affected. - [Create or update Rule](https://docs.talkdesk.com/reference/upsertrule.md): Creates or updates a Rule. - [Get rule by id](https://docs.talkdesk.com/reference/getrule.md): Retrieves the details of a specific automated notification rule by its unique identifier. Use this endpoint to inspect a rule's configuration, conditions, and associated actions before making updates. Only rules belonging to the authenticated account are accessible. - [Delete Rule by id](https://docs.talkdesk.com/reference/deleterule.md): Deletes a Rule by id. - [Get Events](https://docs.talkdesk.com/reference/getevents.md): Retrieves a list of Events. It can retrieve all the account's Events or by external id and/or by publisher name. - [Create Event](https://docs.talkdesk.com/reference/addevent.md): Creates an Event and publishes an addedEvent. - [Get Event by id](https://docs.talkdesk.com/reference/getevent.md): Retrieves an Event by id. - [Delete Event by id](https://docs.talkdesk.com/reference/deleteevent.md): Deletes an event by id and publishes a deletedEvent. - [Delete Events by external id](https://docs.talkdesk.com/reference/deleteevents.md): Deletes the account's Events by external id and publishes deletedEvents. - [Get Topics](https://docs.talkdesk.com/reference/gettopics.md): Retrieves a list of the account's Topics. - [Create Topic](https://docs.talkdesk.com/reference/addtopic.md): Creates a Topic. - [Get Topic by id](https://docs.talkdesk.com/reference/gettopic.md): Retrieves a Topic by id. - [Delete Topic by id](https://docs.talkdesk.com/reference/deletetopic.md): Deletes a Topic by id. - [Get Subscriptions](https://docs.talkdesk.com/reference/getautomatednotificationssubscriptions.md): Retrieve list of subscriptions associated with a topic/channel - [Upsert Subscription](https://docs.talkdesk.com/reference/upsertsubscription.md): Subscribe or unsubscribe a topic or create a new subscription(subscribe) - [Get a subscription by id](https://docs.talkdesk.com/reference/automatednotificationsgetsubscription.md): Retrieve a subscription by id - [Check opt-in status with topic ids and channel.](https://docs.talkdesk.com/reference/checkoptinstatus.md): Check opt in status. - [Search Interactions](https://docs.talkdesk.com/reference/searchautomatednotificationsinteractions.md): Retrieves a list of the Automated Notifications Interactions searched by query parameters. - [Automated Notifications Bridge for webhooks](https://docs.talkdesk.com/reference/automated_notifications_webhook_for_dce.md): Automated Notifications webhook for Digital Connect (DCE) - [Retrieve flat appointment scheduling](https://docs.talkdesk.com/reference/getflatappointmentscheduling.md): Retrieve flat appointment scheduling by provider, service type or location. - [Search physicians based on the patient's past encounters](https://docs.talkdesk.com/reference/getphysiciansbypastencounters.md): Search physicians based on the patient's past encounters, if no encounters exist, return physicians based on the searching conditions. - [Upload Forecast Import from CSV file](https://docs.talkdesk.com/reference/uploadforecastimport.md): Upload a forecast CSV file for the account. Returns the import ID and status in the response body and the URL for tracking import status in the Content-Location header. - [Get Forecast Import Status](https://docs.talkdesk.com/reference/getforecastimportstatus.md): Retrieve the current status of a Forecast Import by its ID. - [Update contact](https://docs.talkdesk.com/reference/upsertcontact.md): Updates contact by member id and by phone number. - [Find Member by id](https://docs.talkdesk.com/reference/healthcareconnectionsgetmemberbyid.md): Find Member by id - [Member lookup connections](https://docs.talkdesk.com/reference/memberlookup.md): Retrieves the best matching member searched by query parameters. - [Get a claim status by its id](https://docs.talkdesk.com/reference/get_claim_status_by_id_public.md): Retrieves the status of a claim, given its id - [Get a prior authorization status by its id](https://docs.talkdesk.com/reference/get_prior_authorization_status_by_id_public.md): Retrieves the status of a prior authorization, given its id - [Provider lookup connections](https://docs.talkdesk.com/reference/providerlookupconnections.md): Retrieves the best matching provider searched by query parameters. - [Get claims](https://docs.talkdesk.com/reference/get_claims_public.md): Retrieves claims - [Get prior authorizations](https://docs.talkdesk.com/reference/get_prior_authorizations.md): Retrieves an offset based list of prior authorizations - [HLS Providers Sycurio Integration](https://docs.talkdesk.com/reference/sycuriologin.md): Log in to the Sycurio client, with the configurations in industries-setting. - [Get the campaign record information](https://docs.talkdesk.com/reference/getcampaignrecord.md): Get the campaign record information - [Obtain a new access token](https://docs.talkdesk.com/reference/oauth-token-post.md): Obtain a new access token - [Obtain a new authorization code](https://docs.talkdesk.com/reference/oauth-authorize-get.md): Obtain a new authorization code - [Obtain a service token status](https://docs.talkdesk.com/reference/oauth-introspect-post.md): Obtain a service token status - [Obtains the public server JWK set](https://docs.talkdesk.com/reference/oauth-2023-10-certs-get.md): Obtains the public server JWK set URL. ## Pages - [OpenAPI Specification Download](https://docs.talkdesk.com/page/openapi-download.md) - [Test HTML](https://docs.talkdesk.com/page/test-html.md) ## Changelog - [Unlocking Seamless Integration with IPaaS](https://docs.talkdesk.com/changelog/unlocking-seamless-integration-with-ipaas.md) - [Introducing the Fetch Data Component](https://docs.talkdesk.com/changelog/introducing-fetch-data-component.md) - [New Talkdesk APIs: March 2023](https://docs.talkdesk.com/changelog/new-talkdesk-apis-march-2023.md) - [Introducing the Simple Render View Component](https://docs.talkdesk.com/changelog/introducing-the-simple-render-view-component.md) - [Introducing Blueprints](https://docs.talkdesk.com/changelog/introducing-blueprints.md) - [New Talkdesk APIs: January 2023](https://docs.talkdesk.com/changelog/new-talkdesk-apis-january-2023.md) - [You Ask, We Answer](https://docs.talkdesk.com/changelog/you-ask-we-answer.md) - [CX Innovation with Workspace Designer](https://docs.talkdesk.com/changelog/cx-innovation-with-workspace-designer.md) - [Welcome to the Talkdesk Developers Blog](https://docs.talkdesk.com/changelog/welcome.md)