Jump to Content
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
Developers Blog
Home
Guides
API Endpoints
Developers Blog
Guides
API Endpoints
Knowledge Base
Support
Talkdesk Website
Marketplace
Discussions
Developers Blog
Log In
API Endpoints
Log In
API Endpoints
User Resource Type
All
Pages
Start typing to search…
JUMP TO
Getting Started
API Endpoints
Authentication
Client Credentials - JWT
post
Client Credentials - Basic
post
Client Credentials - STS
post
Authorization Code - JWT
post
Authorization Code
get
Authorization Code - Basic
post
Refresh Token - JWT
post
Refresh Token - Basic
post
End User Session
Apps API
App Information
Installation Information
Users for an Installation
Installation State
Installation Subscription
Installation Channels
Installation Channels
Credentials Transition
Credentials Rotation
List of Apps
Installation Trial Information
Event from App ID
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 Callback
Recordings API
List of Recordings for a Call
Recording Details
Redirect to the Recording File
Contacts API
Contacts List
Contact by ID
Contact Removal
Contact's Integrations
GDPR Contact
Ring Groups API
Get List of Ring Groups
Users Assigned to Ring Group
Flows API
Execute Publish Flow
Campaign Management API
List Do Not Call Lists
Create a Do Not Call List
Do Not Call List Details
Entry in the Do Not Call List
Create an Entry in the DNCL
post
Delete Entry
Update Multiple Entries
Update a Single Entry
Bulk Delete Entries
Filtered List of Entries
Create/Duplicate Campaign
post
Campaigns List
get
Campaign Details
get
Delete Campaign
del
Patch Campaign
patch
Get a DNCL
get
Associate a DNCL
post
Dissociate a DNCL
del
Get Record Lists
get
Associate Record Lists
post
Dissociate Record Lists
del
Get Users
get
Associate Users
post
Dissociate Users
del
Get Numbers
get
Associate Numbers
post
Dissociate Numbers
del
Record Lists API
All Record Lists
Get a List of Records
Create a Record List
Record List Details
Create a Record
post
Delete a Record
Get a Record
Delete a Record
Create Multiple Records
Signed URL
Upload Request Object
Update Record Lists
Update a Record
patch
Update a List of Records
patch
Bulk Delete Records
del
Delete Records by Provider/ID
Identity API
Identity Insights API
Activities List
Phone Validation API
Phone Number Insights
Voice Biometrics Opt-Out API
New Contact Enrollment
put
Enrollment Info Removal
Voice Biometrics Opt-In API
Contact Consent Status
Set a Contact Consent Status
Digital Connect API
Start a Conversation
Send a Message
End a Conversation
Attributes API
Attributes List
New Attribute
Attributes Categories List
New Attribute Category
Update an Attribute Category
Delete an Attribute Category
Attribute Details
Update an Attribute
Attribute Users List
Associate Users to an Attribute
Remove Users from Attribute
User Attributes List
Scheduled Time Off API
Create a Time Off
Update a Time Off
Delete the Time Off
FSI Integrations API
Sync a Talkdesk Contact
Fetch Contacts
Fetch Contact
Fetch Accounts
Fetch Transactions
Fetch Payments
Fetch Cards
Fetch Card
Activate Card
Deactivate Card
Stop Payment
Search Check Status
Return Payoff Calculation
Create a Transfer (Internal)
Create a Transfer (External)
Create a Transfer (International)
Prompts API
Update a Prompt
Create a Prompt
Request Link to Upload Audio File
Delete a Prompt
Partially Update a Prompt
List a Prompt
Get a Prompt Detail by its ID
Download Audio File
Get a Prompt Usage
Get Prompt Flows
Live API
List Available Queries
Subscribe to a New Stream
Get a Subscription
get
Update Subscription
Subscription Stream
get
Explore API
Check a Report Status
Download a Report
List all Reports of a Type
get
Delete a Report
del
Execute a Report
post
Reporting Custom Fields API
Interaction Custom Fields
Guardian API
Guardian Users API
List of Users
User by ID
User Role Changes
Guardian Sessions API
All Sessions Logs' Data
Guardian Cases API
All Cases
Guardian Call Quality API
Call's Quality
Users API
List of Users
User Details
User Info
SCIM API
Service Provider's Resource Types
User Resource Type
Service Provider Configurations
Users
Create User
User Details
Update User's Attributes
Update Partial User's Attributes
Delete User
Accounts API
Account Details
Usage-Manager API
Account Wallet List
Single Account Wallet
Bucket Configurations
Case API
Create a New Case
Update a Case
Get a List of Cases
Get Case Details
Get Case Details by Contact
Softly Delete Cases
Delete Cases Permanently
Get a List of Case Fields
Update a Case Note
EXPRESS API
Create Contract Actions
Get Contract Actions
Get Reseller Contract Information
Instantiate a Trial
Webhook Trigger API
Create a Webhook Trigger
Delete a Webhook Trigger
Redirect a Talkdesk Trigger
Get Schema
Retail Experience Cloud - ERC Ecommerce Integrations
Integrations Customer by ID
get
Get the ERC e-commerce Cart provided by the Customer ID or Cart ID
get
Cancel items from the ERC e-commerce customer order with the provided customer and order ID.
put
Customer Orders Provided by the Customer ID
get
Customer Order Items for the Provided Customer ID and Order ID
get
Customer Order for the Provided Customer and Order ID
get
Change the Shipping Address
post
Most Recent Order for the Provided Customer ID
get
Cancel a Customer's Order
post
Orders Provided by the Account ID
get
Search the Products of the Store
get
Get the ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account
PUT ERC e-commerce Shopify Integration credentials for the currently authenticated Talkdesk account
Delete the ERC e-commerce Shopify Integration credentials configured for the currently authenticated Talkdesk account.
Bulk Import API
Get List of Imports
Create a New Import
Get an Import
Update an Import
Get Errors from an Import
CFM API
Collect Feedback Data
Simulated Email API
Send a Simulated Email
Financial Services Experience Cloud for Insurance
Get Accounts
get
Get Accounts by Account Number
get
Get all Type List Names
get
Get the Type List Name of the Type List Name
get
Get Policy Details by Account Number
get
Get Policy Details by Policy Number
get
Create a Product Model Data
post
Create a New Quick Quote
post
Get Claims for an Account Number
get
Get Claims Details by Policy Numbers
get
Get Claim Detail for Claim Number
get
Creates a New Claim
post
Search Policies Based on Search Criteria
get
Get Policy Metadata Information
get
Get all Type List Names
get
Get Type List of Type List Name
get
Get Account Details
get
Get Billing Card Details
get
Get Policy Billing Side Panel Details
get
Get Account Invoices
get
Billing Insights API
Get Accounts
get
Get Products
get
Get Subscriptions
get
Get Invoices
get
Get Monthly Usage
get
INDUSTRIES SCHEDULER API
Get Teams
Get Appointment
Collecting User Availability
Create a Calendar Event
Omnichannel API
Bulk Deleting Interactions
del
WFM Request Management API
Importing Time-Off Balance
put
Deleting Time-Off Balance
del
Financial Services Experience Cloud for Banking
Get Member Data
get
Get Payment Data
get
Get Transaction Data
get
Get Cards/Card Details
get
Schedule Callbacks
Get a Callback Entry
Query Callback and Count Callback
Update a Callback
Cancel a Callback
Powered by
User Resource Type
Ask AI
get
https://example.com
Check the user resource type
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!