--- updatedAt: 2026-04-24T14:43:34.000Z agentTools: projectIndex: https://docs.talkdesk.com/llms.txt --- # Getting a list of cases Getting a list of cases. ## Scope `cases-public:read` # OpenAPI definition ```json { "openapi": "3.0.2", "info": { "title": "Public API", "version": "5.12.68", "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": "Case API", "description": "Case API" } ], "paths": { "/cm/core/va/cases": { "get": { "tags": [ "Case API" ], "summary": "Getting a list of cases", "description": "Getting a list of cases.", "operationId": "GettingAListOfCases", "security": [ { "GA": [ "cases-public:read" ] } ], "parameters": [ { "name": "page", "in": "query", "description": "Page.", "required": false, "schema": { "type": "integer", "default": 1, "minimum": 1, "maximum": 2147483647 }, "example": 1 }, { "name": "per_page", "in": "query", "description": "Page size.", "required": false, "schema": { "type": "integer", "default": 50, "minimum": 1, "maximum": 500 }, "example": 50 }, { "name": "ids", "in": "query", "description": "Comma-separated list of case ids to be queried.", "required": false, "schema": { "type": "array", "items": { "type": "string" } }, "example": [ "180", "5432", "1200875" ] }, { "name": "agent_id", "in": "query", "description": "Agent id, the unique numeric identifiers given to each agent.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "example": "62ff04ae644bcb001ebbca67" }, { "name": "agent_name", "in": "query", "description": "Agent name.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 125 }, "example": "doe" }, { "name": "agent_email", "in": "query", "description": "Agent email.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "example": "johndoe@talkdesk.com" }, { "name": "requester_type", "in": "query", "description": "The requester contains both the agent and contact. If this parameter passes in, it distinguishes; If doesn't pass in, it includes both.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255, "enum": [ "AGENT", "CONTACT" ] }, "example": "AGENT" }, { "name": "requester_id", "in": "query", "description": "The id of person who made the support request which can be a contact or an agent.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "example": "612ee2aabbf8fd000e0ad917" }, { "name": "requester_name", "in": "query", "description": "The name of person who made the support request which can be a contact or an agent.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 125 }, "example": "roe" }, { "name": "requester_email", "in": "query", "description": "The email of person who made the support request which can be a contact or an agent.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "example": "richardroe@talkdesk.com" }, { "name": "requester_phone", "in": "query", "description": "The phone of person who made the support request which can be a contact or an agent.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 20 }, "example": "+16785828251" }, { "name": "title", "in": "query", "description": "Case subject on the interface.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255 }, "example": "Inbound call with +16505146407" }, { "name": "description", "in": "query", "description": "When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 1000000000 }, "example": "call_answered Contact Phone: +16505146407" }, { "name": "status", "in": "query", "description": "Case status. For details, please see Overview.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 255, "items": { "type": "string", "minLength": 0, "maxLength": 31, "enum": [ "NEW", "OPEN", "PENDING", "ON_HOLD", "RESOLVED", "CLOSED" ] }, "example": [ "NEW" ] } }, { "name": "priority", "in": "query", "description": "Case priority. For details, please see Overview.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 255, "items": { "type": "string", "minLength": 0, "maxLength": 31, "enum": [ "LOW", "NORMAL", "HIGH", "URGENT" ] }, "example": [ "LOW" ] } }, { "name": "type", "in": "query", "description": "Case type. For details, please see Overview.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 255, "items": { "type": "string", "minLength": 0, "maxLength": 31, "enum": [ "QUESTION", "INCIDENT", "PROBLEM", "TASK" ] }, "example": [ "QUESTION" ] } }, { "name": "about", "in": "query", "description": "Case about. For details, please see Overview.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 255, "items": { "type": "string", "minLength": 0, "maxLength": 31 }, "example": "Area 1, Area 2" } }, { "name": "create_at", "in": "query", "description": "Time when the case was created.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 1000, "items": { "type": "string", "format": "date-time", "minLength": 0, "maxLength": 255 } }, "example": [ "2022-09-01 00:00:00.000", "2022-09-30 23:59:59.999" ] }, { "name": "update_at", "in": "query", "description": "Time when the case was updated.", "required": false, "schema": { "type": "array", "minLength": 0, "maxLength": 1000, "items": { "type": "string", "format": "date-time", "minLength": 0, "maxLength": 255 } }, "example": [ "2022-09-01 00:00:00.000", "2022-09-30 23:59:59.999" ] }, { "name": "order_by", "in": "query", "description": "Which field to sort.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255, "x-sorting_default_order": "desc", "x-sorting_fields": [ "create_at" ], "enum": [ "create_at", "update_at" ] }, "example": "update_at" }, { "name": "sort", "in": "query", "description": "In what order to sort.", "required": false, "schema": { "type": "string", "minLength": 0, "maxLength": 255, "enum": [ "ASC", "DESC" ], "default": "DESC" }, "example": "ASC" }, { "name": "custom_fields", "in": "query", "description": "Fields which added by users.", "required": false, "schema": { "type": "object", "properties": { "checkbox1": { "type": "object", "description": "Custom Fields Value. Use the JSON structure, the JSON key is named string, and the key is JSON.If you want to query by custom field, you must pass in the key name of the outer JSON, so use checkbox1 as an example and as the required item.", "properties": { "label": { "type": "string", "description": "The field label, can be empty", "minLength": 0, "maxLength": 255 }, "value": { "type": "boolean", "description": "The field value, cannot be empty. Supports multiple types: boolean, string, array, date, number, decimal, multi-line text, etc. Used type boolean here as an example" }, "name": { "type": "string", "description": "The field agent display name", "minLength": 0, "maxLength": 255 } }, "required": [ "value" ] } }, "required": [ "checkbox1" ] }, "example": [ { "checkbox1": { "value": true, "name": "Test Check Box" }, "drop_down1": { "label": "Cupertino", "value": "001", "name": "Test Drop Down" }, "text1": { "value": "This is a line of test text", "name": "Test Text" }, "dependent_field1": { "label": [ "Cupertino", "Santa Clara", "California" ], "value": [ "3a20c48f-3e33-49b0-af22-63eba6fa4cc3", "bbb2a5e7-6190-4eb1-b889-ec37e0badd0b", "e9e3c93a-1b28-489a-96fe-6b3e9ca60976" ], "name": "Test Dependent Field" }, "numeric1": { "value": 1, "name": "Test Num" }, "decimal1": { "value": 1.2, "name": "Test Decimal" }, "multi_line_text1": { "value": "This is a line of test text\\nThis is the second line of test text", "name": "Test Text" }, "multi_select1": { "label": [ "San Jose", "Cupertino" ], "value": [ "001", "002" ], "name": "Test Select" } } ] } ], "responses": { "200": { "description": "Success, return the list of cases.", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "count": { "type": "integer", "minimum": 1, "maximum": 2147483647 }, "page": { "type": "integer", "default": 1, "minimum": 1, "maximum": 2147483647 }, "per_page": { "type": "integer", "default": 50, "minimum": 1, "maximum": 500 }, "_links": { "type": "object", "properties": { "prev": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "self": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] }, "next": { "type": "object", "properties": { "href": { "type": "string" } }, "required": [ "href" ] } }, "required": [ "prev", "self", "next" ] }, "_embedded": { "type": "object", "properties": { "data": { "type": "array", "items": { "type": "object", "required": [ "id", "title", "description", "requester_id", "requester_name", "requester_integration", "group_id", "status", "create_at", "update_at" ], "properties": { "id": { "type": "string", "description": "Case id, the unique numeric identifiers given to each case. Starting from 1." }, "title": { "type": "string", "description": "Case subject on the interface." }, "description": { "type": "string", "description": "When a contact submits a support request via email, the body of the email request is used as the description. The description becomes the first comment in the case." }, "requester_id": { "type": "string", "description": "The id of person who made the support request which can be a contact or an agent." }, "requester_name": { "type": "string", "description": "The name of person who made the support request which can be a contact or an agent." }, "requester_email": { "type": "string", "description": "The email of person who made the support request which can be a contact or an agent." }, "requester_integration": { "type": "object", "properties": { "integration_id": { "type": "string", "description": "Integration identifier." }, "external_id": { "type": "string", "description": "Contact identifier in integration" }, "external_url": { "type": "string", "description": "Contact URL in external integration." }, "contact_type": { "type": "string", "description": "Contact type in external integration." }, "external_sync_state": { "type": "string", "description": "Contact sync state in integration." } } }, "requester_phone": { "type": "string", "description": "The phone of person who made the support request which can be a contact or an agent." }, "group_id": { "type": "string", "description": "The agent group id. The unique numeric identifiers given to each group." }, "group_name": { "type": "string", "description": "The agent group name." }, "agent_id": { "type": "string", "description": "Agent id, the unique numeric identifiers given to each agent." }, "agent_name": { "type": "string", "description": "Agent name." }, "form_name": { "type": "string", "description": "Case form name." }, "priority": { "type": "string", "description": "Case priority. For details, please see Overview." }, "status": { "type": "string", "description": "Case status. For details, please see Overview." }, "type": { "type": "string", "description": "Case type. For details, please see Overview." }, "about": { "type": "string", "description": "Case about. For details, please see Overview." }, "create_at": { "type": "string", "description": "Time when the field was created.", "format": "date-time" }, "update_at": { "type": "string", "description": "Time when the field was updated.", "format": "date-time" }, "custom_fields": { "type": "string", "description": "Fields which added by users." }, "notes": { "type": "array", "description": "Case notes.", "items": { "type": "object", "properties": { "id": { "type": "string", "description": "Notes Id, the unique numeric identifiers given to each note." }, "notes_title": { "type": "string", "description": "Notes Title." }, "notes_body": { "type": "string", "description": "Notes Body." }, "public": { "type": "boolean", "description": "Is true if any notes are public, false otherwise. Defaults to true." } } }, "required": [ "id", "public" ] } } } } }, "required": [ "data" ] } }, "required": [ "total", "count", "page", "per_page", "_links", "_embedded" ] }, "example": { "total": 493, "count": 10, "page": 1, "per_page": 50, "_links": { "prev": { "href": "https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=1&per_page=50" }, "self": { "href": "https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=2&per_page=50" }, "next": { "href": "https://api-docs.talkdesk.org/cm/core/va/cases/lists/?page=3&per_page=50" } }, "_embedded": { "required": [ "data" ], "data": [ { "id": "5432", "title": "Inbound call with +16505146407", "description": "call_answered Contact Phone: +16505146407", "requester_id": "62ff04ae644bcb001ebbca67", "requester_name": "roe", "requester_email": "richardroe@talkdesk.com", "requester_phone": "+16785828251", "requester_integration": "{\\\"integration_id\\\":\\\"testforce\\\",\\\"external_id\\\":\\\"0038d000006y2ceAAA\\\",\\\"external_url\\\":\\\"https://talkdesk-1cf-dev-ed.my.testforce.com/0038d000006y2ceAAA\\\",\\\"contact_type\\\":\\\"contact\\\", \\\"external_sync_state\\\":\\\"1;623db0bfbe376200017f97bc;2022-03-25T12:08:32.458482160Z;1;0\\\"}", "group_id": "agents", "group_name": "agents", "agent_id": "62feea698bb2e44234a9cd04", "agent_name": "doe", "form_name": "Default Case Form", "priority": "Low", "status": "New", "type": "Question", "about": "Area 1", "create_at": "2022-09-08T06:46:00Z", "update_at": "2022-09-08T06:46:00Z", "custom_fields": "{\\\"date1\\\": {\\\"label\\\": \\\"2022-09-21T06:30:21Z\\\", \\\"value\\\": \\\"2022-09-21T06:30:21Z\\\",\\\"name\\\":\\\"Date\\\"}, \\\"text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}, \\\"decimal1\\\": {\\\"label\\\": null, \\\"value\\\": 1.2,\\\"name\\\":\\\"Test Decimal\\\"}, \\\"numeric1\\\": {\\\"label\\\": null, \\\"value\\\": 1,\\\"name\\\":\\\"Num\\\"},\\\"checkbox1\\\": {\\\"label\\\": true, \\\"value\\\": true,\\\"name\\\":\\\"Test CheckBox\\\"}, \\\"drop_down1\\\": {\\\"label\\\": \\\"Cupertino\\\", \\\"value\\\": \\\"001\\\", \\\"name\\\":\\\"Test Drop Down\\\"}, \\\"multi_select1\\\": {\\\"label\\\": [\\\"San Jose\\\", \\\"Cupertino\\\"], \\\"value\\\": [\\\"001\\\", \\\"002\\\"],\\\"name\\\":\\\"Test Select\\\"}, \\\"dependent_field1\\\": {\\\"label\\\": [\\\"California\\\", \\\"Santa Clara\\\", \\\"California\\\"], \\\"value\\\": [\\\"3a20c48f-3e33-49b0-af22-63eba6fa4cc3\\\", \\\"bbb2a5e7-6190-4eb1-b889-ec37e0badd0b\\\", \\\"e9e3c93a-1b28-489a-96fe-6b3e9ca60976\\\"],\\\"name\\\":\\\"Test Dependent Field\\\"}, \\\"multi_line_text1\\\": {\\\"label\\\": null, \\\"value\\\": \\\"This is a line of test text\\\\\\\\nThis is the second line of test text\\\",\\\"name\\\":\\\"Test Text\\\"}}", "notes": [ { "id": "10000001", "notes_title": "test subject", "notes_body": "test body", "public": true } ] } ] } } } } }, "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": "1520005", "message": "Bad Request." } } } }, "401": { "description": "Unauthorized access - invalid or unverifiable JWT.", "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": "1520006", "message": "Unauthorized." } } } }, "403": { "description": "Forbidden.", "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": "1520007", "message": "Forbidden." } } } }, "404": { "description": "Not Found.", "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": "1520008", "message": "Connection not found." } } } } } } } }, "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" } } ```