Reference Hub API
Overview
The Reference Hub API allows you to create, manage, and scale table-based reference data known as Reference Tables for use across your Talkdesk contact center workflows. Previously, Reference Tables functionality was only accessible through the platform UI. This API enables you to integrate Reference Tables directly into your own systems, automating table creation, row management, and bulk data operations at scale.
Use CaseConsider the case where your organization maintains reference data (such as routing rules, product SKUs, or agent skill mappings) in an external system of record. Instead of manually recreating and updating this data in the Talkdesk UI, you can use the Reference Hub API to create tables, import rows in bulk, and keep them synchronized programmatically.
Access and Registration
- Authentication
APIs
Usages
- Get usage list for a specific data table
Bulk Operations
-
Bulk operation for data tables (add teams / remove teams)
- Endpoint:
POSThttps://api.talkdeskstg.com/data-tables/bulk
- Endpoint:
-
Bulk operation for table rows
Data Table ID
- Get data table schema
- Endpoint:
GEThttps://api.talkdeskstg.com/data-tables/{data_table_id}
- Endpoint:
Row
-
Fetch paginated list of data table rows
-
Create a data table row
- Endpoint:
POSThttps://api.talkdeskstg.com/data-tables/{data_table_id}/rows
- Endpoint:
-
Edit a data table row
Metadata
- Partially update a data table's metadata (name, description, team_ids) without modifying columns
- Endpoint:
PATCHhttps://api.talkdeskstg.com/data-tables/{data_table_id}/metadata
- Endpoint:
Schema
- Partially update a data table's schema (columns) without modifying metadata (name, description, team_ids)
- Endpoint:
PATCHhttps://api.talkdeskstg.com/data-tables/{data_table_id}/schema
- Endpoint:
Import
-
Import rows into a data table by uploading a CSV or JSON file
-
Create a new data table and immediately import rows from a CSV or JSON file
- Endpoint:
POSThttps://api.talkdeskstg.com/data-tables/import
- Endpoint:
Export
-
Create an asynchronous export job for data table rows
- Endpoint:
POSThttps://api.talkdeskstg.com/data-tables/export/jobs
- Endpoint:
-
Fetch a paginated list of the asynchronous export jobs
- Endpoint:
GEThttps://api.talkdeskstg.com/data-tables/export/jobs
- Endpoint:
-
Get the export file download link
Supported Regions and Base URLs
Troubleshooting
If you have questions or technical issues, please open a ticket using this form.
Updated 3 days ago