---
updatedAt: 2026-06-25T23:37:17.000Z
agentTools:
projectIndex: https://docs.talkdesk.com/llms.txt
---
# List Record Lists
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.
## Scope
`record-lists:manage`
# OpenAPI definition
```json
{
"openapi": "3.0.2",
"info": {
"title": "Public API",
"version": "5.12.71",
"description": "Documents public API endpoints. Scopes are given to external software, that we don't control",
"contact": {
"name": "Talkdesk",
"url": "https://talkdesk.com"
}
},
"servers": [
{
"url": "https://api.talkdeskapp.com",
"description": "United States (td-us-1)"
},
{
"url": "https://api.talkdeskapp.eu",
"description": "Europe (td-eu-1)"
},
{
"url": "https://api.talkdeskappca.com",
"description": "Canada (td-ca-1)"
},
{
"url": "https://api.talkdeskapp.co.uk",
"description": "United Kingdom (td-uk-1)"
}
],
"tags": [
{
"name": "Record Lists API",
"description": "Record Lists API"
}
],
"paths": {
"/record-lists": {
"get": {
"operationId": "record-lists-get",
"summary": "List Record Lists",
"x-namespace": "/record-lists",
"tags": [
"Record Lists API"
],
"description": "Returns a paginated list of record lists for the account.\nUse this endpoint to retrieve all record lists with optional filtering by name, status, team, and campaign.\n",
"x-internal": false,
"security": [
{
"GA": [
"record-lists:manage"
]
}
],
"parameters": [
{
"name": "name",
"in": "query",
"description": "Filter by record lists names,fuzzy query",
"schema": {
"type": "string",
"minLength": 1,
"maxLength": 35
}
},
{
"name": "status",
"in": "query",
"description": "Filter Record Lists by status",
"schema": {
"type": "string",
"minLength": 1
}
},
{
"name": "team_id",
"in": "query",
"description": "Filter Record Lists by team id. team_id and team_ids are mutually exclusive.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "team_ids",
"in": "query",
"description": "Filter Record Lists by team ids. team_id and team_ids are mutually exclusive.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "campaign_ids",
"in": "query",
"description": "Filter Record Lists by campaign ids.",
"required": false,
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
},
{
"name": "fields",
"in": "query",
"description": "Allows to request the sub entities of the record list.
- teams -> Return the record list's teams information.
",
"required": false,
"schema": {
"type": "string",
"enum": [
"TEAMS"
]
}
},
{
"name": "include_none_team",
"in": "query",
"description": "If include_none_team equals true, this parameter will also return records lists with no team.",
"required": false,
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "Number of the page listed",
"required": false,
"schema": {
"type": "integer",
"default": 1,
"minimum": 1,
"maximum": 2147483647
}
},
{
"name": "per_page",
"in": "query",
"description": "Number of max items per page",
"required": false,
"schema": {
"type": "integer",
"default": 50,
"minimum": 1,
"maximum": 500
}
},
{
"name": "created_at_from",
"in": "query",
"description": "Filter by Record Lists created_at, must filter with field created_at_to",
"schema": {
"type": "string"
}
},
{
"name": "created_at_to",
"in": "query",
"description": "Filter by Record Lists created_at, must filter with field created_at_from",
"schema": {
"type": "string"
}
},
{
"name": "updated_at_from",
"in": "query",
"description": "Filter by Record Lists updated_at, must filter with field updated_at_to",
"schema": {
"type": "string"
}
},
{
"name": "updated_at_to",
"in": "query",
"description": "Filter by Record Lists updated_at, must filter with field updated_at_from",
"schema": {
"type": "string"
}
},
{
"name": "order_by",
"in": "query",
"description": "Order by Record Lists for names, number of records, created_at, updated_at",
"schema": {
"example": "name,records_count:desc,created_at:desc,updated_at:asc",
"default": "created_at:desc",
"x-sorting_default_order": "asc",
"x-sorting_fields": [
"name",
"records_count",
"created_at",
"updated_at"
],
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Get the list of record lists",
"content": {
"application/hal+json": {
"schema": {
"example": {
"total": 3,
"page": 1,
"total_pages": 3,
"per_page": 1,
"count": 3,
"_links": {
"self": {
"href": "https://api.talkdeskapp.com/record-lists/?page=2&per_page=1"
},
"next": {
"href": "https://api.talkdeskapp.com/record-lists/?page=3&per_page=1"
},
"prev": {
"href": "https://api.talkdeskapp.com/record-lists/?page=1&per_page=1"
},
"first": {
"href": "https://api.talkdeskapp.com/record-lists/?page=1&per_page=1"
},
"last": {
"href": "https://api.talkdeskapp.com/record-lists/?page=3&per_page=1"
}
},
"_embedded": {
"record_lists": [
{
"id": "8858c834-481d-4a02-8176-cffc02c50350",
"name": "list 1",
"unique_identifier_type": "PHONE_NUMBER",
"created_at": "2020-03-24T11:48:40.503Z",
"updated_at": "2020-03-24T11:48:40.503Z",
"records_count": 10,
"status": "accepted",
"account_id": "5cec1886cd9489002de37c18",
"teams": [
{
"id": "367ac248e7c6415980bad277d2de91a5",
"name": "Team A",
"_links": {
"self": {
"href": "https://api-docs.talkdesk.org/teams/367ac248e7c6415980bad277d2de91a5"
}
}
}
],
"campaign_page": [
{
"total": 3,
"total_pages": 3,
"page": 1,
"per_page": 1,
"count": 3,
"_embedded": {
"campaigns": [
{
"id": "367ac248e7c6415980bad277d2de9112",
"campaign_name": "Campaign A",
"_links": {
"self": {
"href": "https://api-docs.talkdesk.org/campaigns/367ac248e7c6415980bad277d2de9112"
}
}
}
]
},
"_links": {
"self": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=2&per_page=1"
},
"next": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"
},
"prev": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"
},
"first": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=1&per_page=1"
},
"last": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350/campaigns?page=3&per_page=1"
}
}
}
],
"_links": {
"self": {
"href": "https://api.talkdeskapp.com/record-lists/8858c834-481d-4a02-8176-cffc02c50350"
}
}
}
]
}
},
"description": "List with the paginated samples.",
"properties": {
"total": {
"description": "The number of items.",
"type": "integer"
},
"per_page": {
"description": "The number of items per page.",
"type": "integer"
},
"count": {
"description": "The total number of items in this page.",
"type": "integer"
},
"page": {
"description": "The number of the current page.",
"type": "integer"
},
"total_pages": {
"description": "The total number of pages.",
"type": "integer"
},
"_links": {
"description": "HAL API related links.",
"type": "object",
"properties": {
"next": {
"description": "Link of the next page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"description": "Link of the last page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"prev": {
"description": "Link of the previous page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"self": {
"description": "Link of the current page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"description": "Link of the first page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"next",
"prev",
"first",
"last"
]
},
"_embedded": {
"properties": {
"record_lists": {
"description": "List of record lists paginated.",
"items": {
"description": "Record list HAL object.",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "ID of the record list created."
},
"name": {
"type": "string",
"description": "Record list name."
},
"unique_identifier_type": {
"type": "string",
"description": "Duplicate checking logic configured for the record list:\n * `PHONE_NUMBER` - Duplicate checking based on the record's phone_number\n * `EXTERNAL` - Duplicate checking based on the record's external_id and external_provider\n * `NOTHING` - No duplicate checking\n"
},
"created_at": {
"type": "string",
"description": "Record list creation date."
},
"updated_at": {
"type": "string",
"description": "Record list updated date."
},
"status": {
"type": "string",
"description": "Status of validation process done on the record list csv file.",
"enum": [
"REJECTED",
"VALIDATION_STARTED",
"UPLOADED",
"ACCEPTED",
"INCOMPLETE",
"CORRUPTED"
]
},
"records_count": {
"type": "integer",
"description": "How many records are present in the record list."
},
"teams": {
"type": "array",
"description": "Teams that this record belongs to.",
"items": {
"type": "object",
"description": "Teams assigned to the record list, if any.",
"properties": {
"id": {
"type": "string",
"description": "The team ID of the record list."
},
"name": {
"type": "string",
"description": "The team name of the record list."
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
}
},
"campaign_page": {
"description": "Campaigns associated with the record list.",
"type": "object",
"properties": {
"total": {
"description": "The number of items.",
"type": "integer"
},
"per_page": {
"description": "The number of items per page.",
"type": "integer"
},
"count": {
"description": "The total number of items in this page.",
"type": "integer"
},
"page": {
"description": "The number of the current page.",
"type": "integer"
},
"total_pages": {
"description": "The total number of pages.",
"type": "integer"
},
"_embedded": {
"properties": {
"campaigns": {
"description": "List of campaigns paginated.",
"items": {
"description": "Campaign HAL object.",
"readOnly": true,
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "External ID of the campaign created."
},
"campaign_name": {
"type": "string",
"description": "Campaign name."
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
},
"type": "array"
}
},
"type": "object",
"required": [
"campaigns"
]
},
"_links": {
"description": "HAL API related links.",
"type": "object",
"properties": {
"next": {
"description": "Link of the next page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"last": {
"description": "Link of the last page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"prev": {
"description": "Link of the previous page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"self": {
"description": "Link of the current page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
},
"first": {
"description": "Link of the first page.",
"type": "object",
"properties": {
"href": {
"description": "Address of the resource.",
"type": "string"
}
},
"required": [
"href"
]
}
},
"required": [
"self",
"next",
"prev",
"first",
"last"
]
}
},
"required": [
"per_page",
"page",
"total",
"_links"
]
},
"_links": {
"type": "object",
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
}
},
"type": "array"
}
},
"type": "object",
"required": [
"record_lists"
]
}
},
"required": [
"per_page",
"page",
"total",
"_links"
],
"type": "object"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0530900",
"message": "Bad request."
}
}
}
},
"401": {
"description": "Unauthorized",
"content": {
"application/hal+json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0530901",
"message": "Missing or invalid authentication token."
}
}
}
},
"403": {
"description": "Forbidden",
"content": {
"application/hal+json": {
"schema": {
"type": "object",
"required": [
"code",
"message"
],
"properties": {
"code": {
"type": "string"
},
"message": {
"type": "string"
},
"description": {
"type": "string"
},
"fields": {
"type": "array",
"items": {
"type": "object",
"required": [
"name",
"description"
],
"properties": {
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
}
},
"example": {
"code": "0530902",
"message": "Insufficient scopes for the requested operation."
}
}
}
}
}
}
}
},
"components": {
"securitySchemes": {
"GA": {
"type": "oauth2",
"flows": {
"authorizationCode": {
"authorizationUrl": "https://{account_name}.talkdeskid.com/oauth/authorize",
"tokenUrl": "https://{account_name}.talkdeskid.com/oauth/token",
"scopes": {
"account:read": "Show account details",
"apps:read": "Get details about app installations for an account",
"apps:write": "Update an app installation state programatically",
"attributes:read": "List attributes or attribute categories for an account and get details for a specific attribute",
"attributes:write": "Create, update and remove attributes or attributes categories for an account",
"bulk-imports:read": "Get list of imports and export errors into CSV file",
"bulk-imports:write": "Create and update import data",
"messages:write": "Ability to send messages from the API",
"callback:write": "Request a new direct callback",
"contacts-integrations:read": "Get details for contacts' integrations",
"contacts:read": "Get details for contact(s)",
"contacts:write": "Create, update or delete contacts",
"contact-gdpr:write": "GDPR Contacts",
"continuity-settings:read": "Read business continuity settings",
"continuity-settings:write": "Change business continuity settings",
"continuity-settings-activation:read": "Read information on activation of the continuity settings",
"continuity-settings-activation:write": "Edit information on activation of the continuity settings",
"data-reports:read": "Download previously generated data reports",
"data-reports:write": "Create new data reports",
"data-tables:read": "Fetch and list data tables",
"data-tables:write": "Create and update data tables",
"data-tables-exports:read": "List and download data table exports",
"data-tables-exports:write": "Create and cancel data table exports",
"events:read": "Get details from received events",
"express-provisioning:read": "Express-provisioning validate if account exists",
"express-provisioning:write": "Provisioning of an account",
"express-accounts-usage:read": "Read usage information for an account",
"express-accounts:read": "Read account information",
"express-accounts-contracts:read": "Get contract info for express accounts",
"express-accounts-contracts-actions:write": "Create contract actions for express accounts",
"express-accounts-contracts-actions:read": "Read contract actions of express accounts",
"express-products:read": "Read product information",
"express-accounts-subscriptions:read": "Read subscription information for an account",
"express-accounts-invoices:read": "Read invoice information for an account",
"erc-ecommerce-shopify-webhooks-handler-credentials:write": "Create or update Shopify webhook handler credentials",
"erc-ecommerce-shopify-webhooks-handler-credentials:read": "Read Shopify webhook handler credentials",
"flows-interactions:start": "Starts an interaction associated with a flow",
"flows-platform:submit": "Trigger an automation flow associated with an account",
"fsi-accounts:read": "List of accounts associated with a contact",
"fsi-contacts:write": "Update contact information",
"fsi-contacts:read": "List and get contact details",
"fsi-cards:read": "List of cards from a account",
"fsi-cards:write": "Update the status for a card",
"fsi-payments:read": "List of payments from a specific account",
"fsi-transactions:read": "List of transactions for a specific account",
"fsi-payoff:read": "Get the payoff for an FSI account",
"fsi-transfers:write": "Create an FSI Transfer",
"fsi-stop-payment:write": "Cancel a payment before it’s been processed",
"fsi-travel-notification:write": "Create a new endpoint for Travel Notifications",
"fsi-checks:read": "Search for a check",
"fsi-set-ach-transfer:write": "FSI Set ACH Transfer",
"fsi-unlock-account:write": "Unlock account for a banking customer",
"fsi-decrypt:read": "The decryption based on AES algorithm",
"fsi-write-back:write": "FSI Write Data Back",
"fsi-spend-limit:read": "Daily limit for reading debit cards",
"fsi-spend-limit:write": "Modify the daily limit of debit cards",
"guardian-call-quality:read": "Read Guardian call quality data.",
"guardian-sessions:read": "Read Sessions Guardian data.",
"guardian-users:read": "Read Users Guardian data.",
"guardian-cases:read": "Read Cases Guardian data.",
"identity-activity:read": "Identity activity read access",
"identity-email-validation:read": "Identity Email Validation read access",
"identity-ip-validation:read": "Identity IP Validation read access",
"identity-phone-validation:read": "Identity Phone Validation read access",
"openid": "User info endpoint",
"recordings:read": "Get recording files",
"recordings:delete": "Delete recording files",
"refresh_token": "Token refresh flow",
"reports:read": "List previously generated reports and download them",
"reports:write": "Create new reports or delete existing ones",
"queues:read": "List CCAAS queues",
"queues:write": "Create/update CCAAS queues details",
"queues-users:read": "List users assigned to a CCAAS queue",
"users:read": "List users for an account and get details for a specific user",
"users:write": "Create, Update and Delete users",
"interactions:control-recordings": "Control the recording status of an interaction",
"fsi-workspace-contact-synchronization:write": "Synchronize Talkdesk contact with fsi member information",
"voicebiometrics-enroll:write": "Update and delete Voice Biometrics enroll data",
"voicebiometrics-consent:read": "VoiceBiometrics consent read access",
"voicebiometrics-consent:write": "VoiceBiometrics consent write access",
"live-queries:read": "Read and list queries from Live API",
"live-subscriptions:read": "Read subscriptions from Live API",
"live-subscriptions:write": "Create a new subscription for Live API",
"wfm-aion-public:write": "Create, Update and Delete WFM Aion related data by an external client.",
"wfm-request-management-public:write": "Create, Update and Delete WFM Request Management related data by an external client.",
"wfm-request-management-public:read": "Read WFM Request Management related data by an external client.",
"account-wallets:read": "Get information about account wallets",
"bucket-configurations:read": "Get all bucket configurations",
"cases-public:write": "Create,update and delete case data",
"cases-public:read": "Read case",
"case-notes-public:read": "Read case note data",
"case-notes-public:write": "Create, edit, and delete case note data",
"case-fields-public:read": "Read case field",
"do-not-call-lists:manage": "Update a DNCL by adding or deleting a entry on a do not call list",
"do-not-call-lists:read": "Read entries in a do not call list",
"record-lists:manage": "Ability to view, add and update records of a Record List",
"record-lists:write": "Create and update record lists for an account",
"role-permissions:skip": "Skip role permissions validation",
"campaigns:write": "Create, update and delete campaigns",
"campaigns:read": "List and view available campaigns",
"schedule-callbacks:read": "List schedule callbacks",
"schedule-callbacks:write": "schedule a callbacks or reschedule a callbacks",
"po-record-list-automations:write": "Custom record list automations for proactive outbound clients",
"prompts:read": "Read prompts",
"prompts:write": "Create a prompt",
"prompts:delete": "Delete a prompt",
"prompts:download": "Get prompt download link",
"webhooks-trigger:write": "Create, update and delete a webhook trigger",
"cfm-public:write": "Collect feedback data",
"digital-connect:read": "List and Get digital-connect Resources",
"digital-connect:write": "Create, Update and Delete digital-connect Resources",
"entitymapper-contact-interactions:write": "Update interaction's contact mappings",
"locations-directory:read": "Read locations information",
"locations-directory:write": "Write/update locations information and custom fields",
"locations-directory:support": "Create/Update/Delete locations-directory support features",
"staffs-directory:read": "Read staffs information",
"staffs-directory:write": "Write/update staffs information",
"automated-notifications-management:read": "Read Automated Notifications related account information",
"automated-notifications-management:write": "Write Automated Notifications related account information",
"automated-notifications:read": "Read Automated Notifications event information",
"automated-notifications:write": "Write Automated Notifications event information",
"automated-notifications-bridge:write": "Write permissions for automated-notifications-bridge webhooks",
"automated-notifications-subscriptions:read": "Read Automated Notifications subscriptions related to a topic/channel",
"automated-notifications-subscriptions:write": "Write (subscribe/unsubscribe) Automated Notifications subscriptions related to a topic/channel",
"entitymapper-map:write": "Write mappings with external entities",
"entitymapper-contacts:read": "Search Talkdesk contact",
"entitymapper-contacts:write": "Write Talkdesk contact",
"appointment-scheduling-va:read": "Read appointment scheduling va entries",
"hls-coverage:read": "Read healthcare & life sciences coverage information",
"hls-balance:read": "Read healthcare & life sciences balance information",
"hls-patient:read": "Read healthcare & life sciences patient information",
"hls-providers:call-answered": "Write healthcare & life sciences call answered information",
"hls-appointment:read": "Read healthcare & life sciences patient appointments",
"hls-medication-order:read": "Read healthcare & life sciences patient medication orders",
"hls-appointment:write": "Write healthcare & life sciences patient appointments",
"hls-contact:write": "Write healthcare & life sciences data into talkdesk contact",
"hls-provider:read": "Read healthcare & life sciences provider appointments",
"hls-phone-action:write": "Write healthcare & life sciences phone action",
"hls-click-to-call:write": "Write healthcare & life sciences click-to-call action",
"hls-epic-outgoing-sms:write": "Trigger outgoing SMS from Epic",
"hls-epic-agent-status-sync:write": "Trigger agent status sync from Epic",
"hls-inbasket-message:write": "Send in-basket message to Epic",
"hls-popup-intent:write": "Save intent of a patient",
"hls-prescription:read": "Read healthcare & life sciences prescription information",
"hls-prescription:write": "Write healthcare & life sciences prescription information",
"hls-encounter:read": "Read healthcare & life sciences patient encounters",
"hls-service-request:read": "Read healthcare & life sciences patient service requests",
"hls-procedure:read": "Read healthcare & life sciences patient procedures",
"hls-payers-connections:read": "Read healthcare & life sciences payers information",
"hls-payers-connections:write": "Write healthcare & life sciences payers information",
"hls-symptom-checker:write": "Symptom checker for patient",
"hls-patient:write": "Write healthcare & life sciences patient information",
"hls-epic:call-answered": "Write healthcare & life sciences call answered information",
"hls-sycurio:integrate": "Integrate with Sycurio platform",
"hls-patient-case:write": "Write healthcare & life sciences patient case information",
"hls-outstanding-order:read": "Read healthcare & life sciences outstanding orders",
"hls-medication-order:write": "Write healthcare & life sciences medication order(request)",
"hls-medication-statement:write": "Write healthcare & life sciences medication statement",
"hls-medication-statement:read": "Read healthcare & life sciences medication statement",
"hls-hl7-events:write": "Write healthcare providers HL7 events",
"erc-ecommerce-connections-orders:write": "Update e-commerce connections orders info",
"erc-ecommerce-connections-customers:read": "Read e-commerce connections customers info",
"erc-ecommerce-connections-customers:write": "Write e-commerce connections customers info",
"erc-ecommerce-connections-orders:read": "Read e-commerce connections orders info",
"erc-ecommerce-connections-products:read": "Read e-commerce connections products info",
"erc-ecommerce-customers:read": "Read e-commerce customers info",
"erc-ecommerce-customers:write": "Write e-commerce customers info",
"erc-ecommerce-return-reasons:read": "Read e-commerce return reasons",
"erc-ecommerce-return:read": "Read e-commerce return info",
"erc-ecommerce-return:write": "Write e-commerce return info",
"erc-ecommerce-cart:write": "Sync e-commerce cart items",
"erc-ecommerce-products:read": "Search e-commerce catalog products",
"erc-ecommerce-orders:read": "Show e-commerce integrations orders info",
"erc-ecommerce-orders:write": "Update e-commerce integrations orders info",
"erc-ecommerce-recall:write": "Write e-commerce recall contacts",
"industries-settings-public:write": "Write industries settings",
"industries-contexts:write": "Create, update, and delete context values",
"fsi-insurance-connections-automated-notifications:write": "Write Automated Notifications event information",
"fsi-insurance-connections-contacts:write": "Sync Talkdesk contacts",
"fsi-insurance-connections-claims:read": "Read claims by id from FSI Insurance",
"fsi-insurance-integrations-policies:read": "Read policies from FSI Insurance",
"fsi-insurance-integrations-accounts:read": "Read accounts from FSI Insurance",
"fsi-insurance-integrations-claims:write": "Write claims from FSI Insurance",
"fsi-insurance-integrations-billing:read": "Read billing info from FSI Insurance",
"fsi-insurance-integrations-claims:read": "Read claims from FSI Insurance",
"fsi-insurance-integrations-contacts:write": "Update contact details from FSI Insurance",
"fsi-insurance-integrations-send-docs:read": "Send document deliveries from FSI Insurance",
"fsi-insurance-integrations-data-back:write": "Write contact event data back to FSI Insurance",
"automated-notifications-interactions:read": "Read Automated Notifications related with interactions",
"industries-scheduler-teams:read": "Read teams from industries-scheduler",
"industries-scheduler-availabilities:read": "Get users availabilities by email",
"industries-scheduler-appointment:write": "Create cancel event on specialist's calendar",
"industries-scheduler-appointment:read": "Read appointments from industries-scheduler",
"industries-messaging-service:write": "Write messages in industries-messaging-service",
"interaction-custom-fields:write": "Allows to populate interaction custom fields",
"user-session-public:end": "Terminate a user session",
"industries-settings-public:read": "Read industries settings",
"industries-contexts:read": "Read context values",
"dialer-integrations-records:read": "Read dialer integrations campaign records",
"scim": "Access SCIM-related routes",
"hls-epic-my-chart-reset-password:write": "Trigger Epic MyChart password reset (Deprecated - use hls-patient-password-reset:write)",
"hls-patient-password-reset:write": "Trigger patient password reset for healthcare portal",
"locations-directory-bulk-operation:write": "Write locations directory data",
"locations-directory-batch-operation:write": "Apply a batch of locations directory create/update/delete operations",
"hls-patient-location:read": "Read loction patient data",
"hls-patient-practice:read": "Read healthcare & life sciences patient practices",
"hls-guarantor:read": "Read guarantor identifiers from providers",
"hls-guarantor-billing:read": "Read guarantor billing summary from providers",
"hls-guarantor-password-reset:write": "Trigger guarantor password reset for healthcare portal",
"hls-patient-billing:read": "Read patient billing details from providers",
"hls-interaction-overrides:write": "Write healthcare & life sciences interaction-specific configuration overrides",
"industries-workflows:read": "Read industries workflow schedules and workflows",
"industries-workflows:write": "Create, update, start, and delete industries workflow schedules and workflows",
"digital-messaging-adapter:write": "Write or update Digital Messaging Adapter data"
}
}
}
}
}
},
"externalDocs": {
"description": "External Documentation",
"url": "https://api-docs.talkdeskapp.com/external_docs"
}
}
```