Jump to Content
Talkdesk DevelopersGuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussionsDevelopers Blog
HomeGuidesAPI EndpointsDevelopers Blog
GuidesAPI EndpointsKnowledge BaseSupportTalkdesk WebsiteMarketplaceDiscussionsDevelopers BlogLog InTalkdesk Developers
API Endpoints
Log In

Getting Started

  • API Endpoints

Authentication

  • Client Credentials - JWTpost
  • Client Credentials - Basicpost
  • Client Credentials - STSpost
  • Authorization Code - JWTpost
  • Authorization Codeget
  • Authorization Code - Basicpost
  • Refresh Token - JWTpost
  • Refresh Token - Basicpost
  • End User Sessionpost

Apps API

  • App Informationget
  • Installation Informationget
  • Users for an Installationget
  • Installation Statepost
  • Installation Subscriptionget
  • Installation Channelsget
  • Installation Channelspost
  • Credentials Transitionpost
  • Credentials Rotationpost
  • List of Appsget
  • Installation Trial Informationget
  • Event from App IDget

Events API

  • app.installed
  • app.updated
  • app.uninstalled
  • app.trial_started
  • app.trial_extended
  • app.trial_ended
  • user.logout
  • app.credentials_rotated

Callback API

  • New Direct Callbackpost

Recordings API

  • List of Recordings for a Callget
  • Recording Detailsget
  • Redirect to the Recording Fileget

Contacts API

  • Contacts Listget
  • Contact by IDget
  • Contact Removaldelete
  • Contact's Integrationsget
  • GDPR Contactpost

Ring Groups API

  • Get List of Ring Groupsget
  • Users Assigned to Ring Groupget

Flows API

  • Execute Publish Flowpost

Campaign Management API

  • List Do Not Call Listsget
  • Create a Do Not Call Listpost
  • Do Not Call List Detailsget
  • Entry in the Do Not Call Listget
  • Create an Entry in the DNCLpost
  • Delete Entrydelete
  • Update Multiple Entriespatch
  • Update a Single Entrypatch
  • Bulk Delete Entriesdelete
  • Filtered List of Entriespost

Record Lists API

  • All Record Listsget
  • Get a List of Recordsget
  • Create a Record Listpost
  • Record List Detailsget
  • Create a Recordpost
  • Delete a Recorddelete
  • Get a Recordget
  • Delete a Recorddelete
  • Create Multiple Recordspost
  • Signed URLpost
  • Upload Request Objectpatch
  • Update Record Listspatch
  • Update a Recordpatch
  • Update a List of Recordspatch
  • Bulk Delete Recordsdelete
  • Delete Records by Provider/IDdelete

Identity API

  • Identity Insights API
    • Activities Listget
  • Phone Validation API
    • Phone Number Insightsget
  • Voice Biometrics Opt-Out API
    • New Contact Enrollmentput
    • Enrollment Info Removaldelete
  • Voice Biometrics Opt-In API
    • Contact Consent Statusget
    • Set a Contact Consent Statusput

Digital Connect API

  • Start a Conversationpost
  • Send a Messagepost
  • End a Conversationdelete

Attributes API

  • Attributes Listget
  • New Attributepost
  • Attributes Categories Listget
  • New Attribute Categorypost
  • Update an Attribute Categorypatch
  • Delete an Attribute Categorydelete
  • Attribute Detailsget
  • Update an Attributeput
  • Attribute Users Listget
  • Associate Users to an Attributepost
  • Remove Users from Attributedelete
  • User Attributes Listget

Scheduled Time Off API

  • Create a Time Offpost
  • Update a Time Offpatch
  • Delete the Time Offdelete

Campaign Management API

  • Create/Duplicate Campaignpost
  • Campaigns Listget
  • Campaign Detailsget
  • Delete Campaigndelete
  • Patch Campaignpatch
  • Get a DNCLget
  • Associate a DNCLpost
  • Dissociate a DNCLdelete
  • Get Record Listsget
  • Associate Record Listspost
  • Dissociate Record Listsdelete
  • Get Usersget
  • Associate Userspost
  • Dissociate Usersdelete
  • Get Numbersget
  • Associate Numberspost
  • Dissociate Numbersdelete

FSI Integrations API

  • Sync a Talkdesk Contactpost
  • Fetch Contactsget
  • Fetch Contactget
  • Fetch Accountsget
  • Fetch Transactionsget
  • Fetch Paymentsget
  • Fetch Cardsget
  • Fetch Cardget
  • Activate Cardpost
  • Deactivate Cardpost
  • Cancel a Paymentpost
  • Search Check Statuspost
  • Return Payoff Calculationpost
  • Create a Transfer (Internal)post
  • Create a Transfer (External)post
  • Create a Transfer (International)post

Prompts API

  • Update a Promptput
  • Create a Promptpost
  • Request Link to Upload Audio Filepost
  • Delete a Promptdelete
  • Partially Update a Promptpatch
  • List a Promptget
  • Get a Prompt Detail by its IDget
  • Download Audio Fileget
  • Get a Prompt Usageget
  • Get Prompt Flowsget

Live API

  • List Available Queriesget
  • Subscribe to a New Streampost
  • Get a Subscriptionget
  • Update Subscriptionput
  • Subscription Streamget

Explore API

  • Check a Report Statusget
  • Download a Reportget
  • List all Reports of a Typeget
  • Delete a Reportdelete
  • Execute a Reportpost

Reporting Custom Fields API

  • Interaction Custom Fieldspost

Guardian API

  • Guardian Users API
    • List of Usersget
    • User by IDget
    • User Role Changesget
  • Guardian Sessions API
    • All Sessions Logs' Dataget
  • Guardian Cases API
    • All Casesget
  • Guardian Call Quality API
    • Call's Qualityget

Users API

  • List of Usersget
  • User Detailsget
  • User Infoget

SCIM API

  • Service Provider's Resource Typesget
  • User Resource Typeget
  • Service Provider Configurationsget
  • Usersget
  • Create Userpost
  • User Detailsget
  • Update User's Attributesput
  • Update Partial User's Attributespatch
  • Delete Userdelete

Accounts API

  • Account Detailsget

Usage-Manager API

  • Account Wallet Listget
  • Single Account Walletget
  • Bucket Configurationsget

Case API

  • Create a New Casepost
  • Update a Casepatch
  • Get a List of Casesget
  • Get Case Detailsget
  • Get Case Details by Contactget
  • Softly Delete Casesdelete
  • Delete Cases Permanentlydelete
  • Get a List of Case Fieldsget
  • Update a Case Notepatch

EXPRESS API

  • Create Contract Actionspost
  • Get Contract Actionsget
  • Get Reseller Contract Informationget
  • Instantiate a Trialpost

Webhook Trigger API

  • Create a Webhook Triggerpost
  • Delete a Webhook Triggerdelete
  • Redirect a Talkdesk Triggerpost
  • Get Schemaget

Retail Experience Cloud - ERC Ecommerce Integrations

  • Integrations Customer by IDget
  • Get the ERC e-commerce Cart provided by the Customer ID or Cart IDget
  • Cancel items from the ERC e-commerce customer order with the provided customer and order ID.put
  • Customer Orders Provided by the Customer IDget
  • Customer Order Items for the Provided Customer ID and Order IDget
  • Customer Order for the Provided Customer and Order IDget
  • Change the Shipping Addresspost
  • Most Recent Order for the Provided Customer IDget
  • Cancel a Customer's Orderpost
  • Orders Provided by the Account IDget
  • Search the Products of the Storeget

Bulk Import API

  • Get List of Importsget
  • Create a New Importpost
  • Get an Importget
  • Update an Importpatch
  • Get Errors from an Importget

CFM API

  • Collect Feedback Datapost

Simulated Email API

  • Send a Simulated Emailpost

Financial Services Experience Cloud for Insurance

  • Get Accountsget
  • Get Accounts by Account Numberget
  • Get all Type List Namesget
  • Get the Type List Name of the Type List Nameget
  • Get Policy Details by Account Numberget
  • Get Policy Details by Policy Numberget
  • Create a Product Model Datapost
  • Create a New Quick Quotepost
  • Get Claims for an Account Numberget
  • Get Claims Details by Policy Numbersget
  • Get Claim Detail for Claim Numberget
  • Creates a New Claimpost
  • Search Policies Based on Search Criteriaget
  • Get Policy Metadata Informationget
  • Get all Type List Namesget
  • Get Type List of Type List Nameget
  • Get Account Detailsget
  • Get Billing Card Detailsget
  • Get Policy Billing Side Panel Detailsget
  • Get Account Invoicesget

Billing Insights API

  • Get Accountsget
  • Get Productsget
  • Get Subscriptionsget
  • Get Invoicesget
  • Get Monthly Usageget

INDUSTRIES SCHEDULER API

  • Get Teamsget
  • Get Appointmentsget
  • Collecting User Availabilitypost
  • Create a Calendar Eventpost

Omnichannel API

  • Bulk Deleting Interactionsdelete