--- updatedAt: 2026-04-24T14:41:51.000Z agentTools: projectIndex: https://docs.talkdesk.com/llms.txt --- # Get activities Returns the paginated history of contact voice authentication activities for the account, such as authentication attempts and other identity-related events captured during calls. Use this endpoint to power dashboards, audit views or reporting flows that need a chronological feed of identity activity for contacts in the account.
The list is paginated and the maximum page size is 250 items, so larger exports must use the CSV-producing variant of this endpoint instead. When the contact query parameter is true (the default), activity entries are enriched with the matching contact's name and id resolved from the phone number; setting it to false skips that lookup and returns the raw activity records. ## Scope `identity-activity: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": "Identity API", "description": "Identity API" } ], "paths": { "/identity/activities": { "get": { "operationId": "getActivities", "summary": "Get activities", "description": "Returns the paginated history of contact voice authentication activities for the account, such as authentication attempts and other identity-related events captured during calls.\nUse this endpoint to power dashboards, audit views or reporting flows that need a chronological feed of identity activity for contacts in the account.
\nThe list is paginated and the maximum page size is 250 items, so larger exports must use the CSV-producing variant of this endpoint instead.\nWhen the contact query parameter is true (the default), activity entries are enriched with the matching contact's name and id resolved from the phone number; setting it to false skips that lookup and returns the raw activity records.", "parameters": [ { "name": "contact", "in": "query", "description": "Populate contact name and id, from contacts API, based on the phone number.", "required": false, "schema": { "default": true, "type": "boolean" } }, { "name": "filter", "in": "query", "description": "Allows filtering by using comparison and logical operators.

\n
  • To search parts of a string within a field of type string then the contains operator should be used.
    \n The syntax is the following: contains(field, 'value')
    • \n
    \n Logical operators are and and or.
    \n When using multiple ANDs and ORs, you should use parentheses to explicitly define the logical operators evaluation order.
    \n (note: this is recommended because the usual precedence rules aren't supported due to an implementation detail).

    \n Examples:\n \n More information here", "required": false, "schema": { "maxLength": 1600, "type": "string", "x-operators": [ "eq", "ne", "gt", "ge", "lt", "le", "and", "or", "not", "( )", "contains" ] }, "example": "interaction_id eq 'c5572384a4c340c2b326965fdb13ca0e'" }, { "name": "order_by", "in": "query", "description": "The list of fields to sort by.", "schema": { "default": "timestamp:desc", "type": "string", "maxLength": 40, "x-sorting_default_order": "desc", "x-sorting_fields": [ "timestamp" ] }, "example": "score:desc" }, { "name": "page", "in": "query", "description": "Number of the requested page", "schema": { "default": 1, "minimum": 1, "type": "integer" }, "example": 1 }, { "name": "per_page", "in": "query", "description": "Max number of the items in a page", "schema": { "default": 5, "minimum": 1, "maximum": 250, "type": "integer" }, "example": 50 } ], "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "required": [ "count", "page", "per_page", "total", "total_pages", "_embedded", "_links" ], "properties": { "count": { "description": "The number of results in the current page.", "type": "integer", "example": 10 }, "page": { "description": "The current page.", "type": "integer", "example": 1 }, "per_page": { "description": "The number of results per page.", "type": "integer", "example": 10 }, "total": { "description": "The total number of results.", "type": "integer", "example": 10 }, "total_pages": { "description": "The total number of pages.", "type": "integer", "example": 5 }, "_embedded": { "type": "array", "items": { "description": "Contact History view data", "type": "object", "required": [ "id", "timestamp", "contact_id" ], "properties": { "id": { "description": "Activity id", "type": "integer", "example": "2345kj4h234524" }, "name": { "description": "Contacts API caller name", "type": "string", "example": "John Doe" }, "contacts_api_id": { "description": "Contacts API caller id", "type": "string", "example": "John Doe" }, "contact_id": { "description": "User contact ID, which can be a phone number, VAT number or any other identifier number", "type": "string", "example": "753" }, "interaction_id": { "description": "Interaction ID", "type": "string", "example": "c5572384a4c340c2b326965fdb13ca0e" }, "timestamp": { "description": "Contact call timestamp.", "type": "string", "example": "2020-02-12T10:00:00.000Z" }, "phone_status": { "description": "Is the contact's number considered safe, suspicious, or high risk?", "enum": [ "HIGH_RISK", "SAFE", "SUSPICIOUS", "ERROR" ], "type": "string" }, "phone_message": { "description": "Phone validation message", "type": "string", "example": "valid" }, "phone_success": { "description": "Was the validation request successful?", "type": "boolean" }, "phone_formatted": { "description": "Formatted phone number", "type": "string", "example": "969-999-999" }, "phone_local_format": { "description": "Local formatted phone number", "type": "string", "example": "969-999-999" }, "phone_valid": { "description": "Is the phone number properly formatted and considered valid based on assigned phone numbers available to carriers in that country?", "type": "boolean" }, "phone_risk_score": { "description": "The phone risk score which estimating how likely the phone number is to be fraudulent. Scores 85+ are high risk.", "type": "integer", "example": 10 }, "phone_recent_abuse": { "description": "Was there a recent abuse from this number?", "type": "boolean" }, "phone_voip": { "description": "Is this a VoIP number?", "type": "boolean" }, "phone_prepaid": { "description": "Is this a prepaid phone?", "type": "boolean" }, "phone_risky": { "description": "Is this phone marked as risky?", "type": "boolean" }, "phone_active": { "description": "Is this phone active?", "type": "boolean" }, "phone_carrier": { "description": "Phone carrier", "type": "string", "example": "VODAFONE" }, "phone_line_type": { "description": "Phone line type", "type": "string", "example": "VOIP" }, "phone_country": { "description": "Phone country", "type": "string", "example": "PT" }, "phone_region": { "description": "Phone region", "type": "string", "example": "PT" }, "phone_dialing_code": { "description": "Phone country dialing code", "type": "integer", "example": 351 }, "phone_request_id": { "description": "Phone validation request ID", "type": "string", "example": "requestId1" }, "phone_call_attestation_type": { "description": "Phone call attestation type", "type": "string", "example": "TN-Validation-Passed-C" }, "phone_call_attestation_valid": { "description": "Phone call attestation result", "type": "boolean" }, "voice_operation": { "description": "Is the voice operation a consent, enroll, verify or delete", "enum": [ "VERIFY", "DELETE", "ENROLL", "CONSENT" ], "type": "string" }, "voice_risk_score": { "description": "Voice authentication risk score", "type": "number", "example": 40 }, "voice_result": { "description": "Is the voice result a success, failure, error, allowed, not_allowed, refused, no_speech, utterance_failure, deep_fake, replay_attack or second_speaker", "type": "object", "properties": { "result": { "description": "The result of the activity.", "enum": [ "SUCCESS", "FAILURE", "ALLOWED", "NOT_ALLOWED", "REFUSED" ], "example": "SUCCESS", "type": "string", "nullable": false }, "error_details": { "description": "Error details if Result has the value \"FAILURE\"", "properties": { "error_code": { "type": "string", "example": "02001", "nullable": false }, "error_message": { "type": "string", "example": "Operation failed", "nullable": false } }, "type": "object", "required": [ "error_code", "error_message" ] } }, "required": [ "result" ] }, "overall_risk_score": { "description": "Risk score combined between phone and voice scores", "type": "number", "example": 50 }, "is_deleted": { "description": "Is this contact deleted?", "type": "boolean" }, "phone_number": { "description": "Phone number", "type": "string", "example": "969999999" }, "voice_type": { "description": "Whether the voice authentication is active or passive", "enum": [ "ACTIVE", "PASSIVE" ], "type": "string" }, "email_status": { "description": "Is the email address considered safe, suspicious, or high risk?", "enum": [ "HIGH_RISK", "SAFE", "SUSPICIOUS", "ERROR" ], "type": "string" }, "email_valid": { "description": "Is the email address properly formatted and considered valid?", "type": "boolean" }, "email_fraud_score": { "description": "The email risk score estimating how likely the address is to be fraudulent. Scores 85+ are high risk.", "type": "integer", "example": 10 }, "email_disposable": { "description": "Is this email associated with a known disposable email service?", "type": "boolean" }, "email_deliverability": { "description": "How likely is it that this email address will successfully receive mail? Values are \"high\", \"medium\", or \"low\".", "type": "string", "example": "high" }, "email_catch_all": { "description": "Is this email likely to be a catch-all address for the domain?", "type": "boolean" }, "email_leaked": { "description": "Was this email address exposed in a data breach?", "type": "boolean" }, "email_suspect": { "description": "This value indicates the email address may be invalid due to the email domain's SPF record failing.", "type": "boolean" }, "email_smtp_score": { "description": "Confidence level of the SMTP check. Values range from -1 to 3. Scores of -1 indicate no response from the server.", "type": "integer", "example": 3 }, "email_overall_score": { "description": "Overall email quality score ranging from 0 to 4 where 4 is the highest quality score.", "type": "integer", "example": 4 }, "email_first_name": { "description": "Suspected first name based on email. Returns \"CORPORATE\" if suspected of being a generic company email.", "type": "string" }, "email_common": { "description": "Is this email from common free email providers? (gmail.com, yahoo.com, hotmail.com, etc.)", "type": "boolean" }, "email_generic": { "description": "Is this email suspected as being a catch all or shared email for a domain? (admin@, webmaster@, etc.)", "type": "boolean" }, "email_dns_valid": { "description": "Does the email's hostname have valid DNS entries?", "type": "boolean" }, "email_honeypot": { "description": "Is this email believed to be a \"honeypot\" or \"SPAM trap\"?", "type": "boolean" }, "email_spam_trap_score": { "description": "Confidence level of the email address being an active SPAM trap. Values can be \"high\", \"medium\", \"low\", or \"none\".", "type": "string" }, "email_recent_abuse": { "description": "Has this email address been associated with recent or ongoing fraud?", "type": "boolean" }, "email_frequent_complainer": { "description": "Indicates if this email frequently unsubscribes from marketing lists or reports spam complaints.", "type": "boolean" }, "email_suggested_domain": { "description": "Indicates if this email's domain should be corrected to a popular mail service (e.g. \"gmai.com\" -> \"gmail.com\"). \"N/A\" if not applicable.", "type": "string" }, "email_domain_velocity": { "description": "Level of legitimate users interacting with the email address domain. Values can be \"high\", \"medium\", \"low\", or \"none\".", "type": "string" }, "email_domain_trust": { "description": "Risk classification of the email's domain. Values: \"trusted\", \"positive\", \"neutral\", \"suspicious\", \"malicious\", or \"not rated\".", "type": "string" }, "email_risky_tld": { "description": "Signals that the domain belongs to a risky TLD extension frequently associated with malware, scams, or phishing.", "type": "boolean" }, "email_spf_record": { "description": "Confirms if the domain has a proper SPF DNS record.", "type": "boolean" }, "email_dmarc_record": { "description": "Confirms if the domain has a proper DMARC DNS record.", "type": "boolean" }, "email_sanitized_email": { "description": "Sanitized email address with all aliases and masking removed.", "type": "string" }, "email_timed_out": { "description": "Did the email verification connection to the mail service provider timeout?", "type": "boolean" }, "email_mx_records": { "description": "Comma-separated list of MX records associated with the email's domain name.", "type": "string" }, "email_a_records": { "description": "Comma-separated list of A records associated with the email's domain name.", "type": "string" }, "email_first_seen_human": { "description": "Human-readable description of when the email address was first seen (e.g. \"3 months ago\").", "type": "string" }, "email_first_seen_timestamp": { "description": "Unix timestamp of when the email address was first seen.", "type": "integer", "format": "int64" }, "email_first_seen_iso": { "description": "Date the email address was first seen, in ISO8601 format.", "type": "string" }, "email_domain_age_human": { "description": "Human-readable description of the email domain's age (e.g. \"3 months ago\").", "type": "string" }, "email_domain_age_timestamp": { "description": "Unix timestamp of when the email domain was registered.", "type": "integer", "format": "int64" }, "email_domain_age_iso": { "description": "Date the email domain was registered, in ISO8601 format.", "type": "string" }, "email_request_id": { "description": "A unique identifier for this email validation request that can be used to lookup the request details.", "type": "string" }, "email_message": { "description": "A generic status message for the email validation, either success or some form of an error notice.", "type": "string" }, "ip_address": { "description": "IP address.", "type": "string", "example": "8.8.8.8" }, "ip_status": { "description": "Is the IP address considered safe, suspicious, or high risk?", "enum": [ "HIGH_RISK", "SAFE", "SUSPICIOUS", "ERROR" ], "type": "string" }, "ip_fraud_score": { "description": "The overall fraud score of the IP based on its reputation and recent behavior. Scores 85+ are high risk.", "type": "integer", "example": 10 }, "ip_country_code": { "description": "Two character country code of the IP address or \"N/A\" if unknown.", "type": "string", "example": "US" }, "ip_region": { "description": "Region (state) of the IP address if available or \"N/A\" if unknown.", "type": "string", "example": "California" }, "ip_city": { "description": "City of the IP address if available or \"N/A\" if unknown.", "type": "string", "example": "Mountain View" }, "ip_isp": { "description": "ISP if one is known. Otherwise \"N/A\".", "type": "string", "example": "Google LLC" }, "ip_asn": { "description": "Autonomous System Number if one is known. Null if nonexistent.", "type": "integer", "example": 15169 }, "ip_organization": { "description": "Organization if one is known. Otherwise \"N/A\".", "type": "string", "example": "Google LLC" }, "ip_is_crawler": { "description": "Is this IP associated with being a confirmed crawler from any of the major search engines, based on hostname or IP address verification?", "type": "boolean" }, "ip_timezone": { "description": "Timezone of the IP address if available or \"N/A\" if unknown.", "type": "string", "example": "America/Los_Angeles" }, "ip_mobile": { "description": "Is this IP address associated with a mobile carrier?", "type": "boolean" }, "ip_host": { "description": "Hostname of the IP address if one is available.", "type": "string", "example": "dns.google" }, "ip_proxy": { "description": "Is this IP address suspected to be a proxy? (SOCKS, Elite, Anonymous, VPN, Tor, etc.)", "type": "boolean" }, "ip_vpn": { "description": "Is this IP suspected of being a VPN connection?", "type": "boolean" }, "ip_tor": { "description": "Is this IP suspected of being a TOR connection?", "type": "boolean" }, "ip_active_vpn": { "description": "Identifies active VPN connections used by popular VPN services and private VPN servers.", "type": "boolean" }, "ip_active_tor": { "description": "Identifies active TOR exits on the TOR network.", "type": "boolean" }, "ip_recent_abuse": { "description": "Has this IP address been associated with recent or ongoing fraud?", "type": "boolean" }, "ip_bot_status": { "description": "Indicates if bots or non-human traffic has recently used this IP address to engage in automated fraudulent behavior.", "type": "boolean" }, "ip_connection_type": { "description": "Classification of the IP address connection type as \"Residential\", \"Corporate\", \"Education\", \"Mobile\", or \"Data Center\".", "type": "string", "example": "Corporate" }, "ip_abuse_velocity": { "description": "How frequently the IP address is engaging in abuse. Values can be \"high\", \"medium\", \"low\", or \"none\".", "type": "string", "example": "none" }, "ip_shared_connection": { "description": "Designates IP addresses which are likely to have more than a few users active on the IP address at the same time.", "type": "boolean" }, "ip_dynamic_connection": { "description": "Indicates IP addresses with dynamic assignment protocols, which means that a user on this IP address will likely be assigned a different IP address by this provider in the near future.", "type": "boolean" }, "ip_frequent_abuser": { "description": "Identifies IP addresses with a consistent history of abusive behavior across 6 months or more.", "type": "boolean" }, "ip_high_risk_attacks": { "description": "Confirms if this IP address has engaged in malicious abuse such as phishing, brute forcing, DDoS, credential stuffing & account takeover, scraping, form submission spam, and similar attacks.", "type": "boolean" }, "ip_security_scanner": { "description": "Indicates a verified online security scanner or endpoint by a trusted security vendor.", "type": "boolean" }, "ip_trusted_network": { "description": "Identifies company networks and corporate access points which have low abuse rates and high security protocols.", "type": "boolean" }, "ip_zip_code": { "description": "Postal code of the IP address if available or \"N/A\" if unknown.", "type": "string", "example": "94035" }, "ip_latitude": { "description": "Latitude of the IP address if available or null if unknown.", "type": "number", "format": "float", "example": 37.405991 }, "ip_longitude": { "description": "Longitude of the IP address if available or null if unknown.", "type": "number", "format": "float", "example": -122.078514 } } } }, "_links": { "type": "object", "description": "The paginated links.", "required": [ "first", "last", "next", "prev", "self", "show" ], "properties": { "first": { "description": "The first page link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" }, "last": { "description": "The last page link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" }, "next": { "description": "The next page link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" }, "prev": { "description": "The previous page link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" }, "self": { "description": "The current page link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" }, "show": { "description": "Show current link.", "required": [ "href" ], "properties": { "href": { "description": "The hypertext reference describing this link.", "example": "https://api.talkdeskstg.com/identity?page=1&per_page=10", "type": "string" } }, "type": "object" } } } } }, "example": { "count": 10, "page": 1, "per_page": 10, "total": 10, "total_pages": 5, "_embedded": [ { "id": 1889, "contact_id": "753", "interaction_id": "c5572384a4c340c2b326965fdb13ca0e", "timestamp": "2022-08-23T10:36:17.803596Z", "phone_status": "SAFE", "phone_message": "valid", "phone_success": true, "phone_formatted": "969-999-999", "phone_local_format": "969-999-999", "phone_valid": true, "phone_risk_score": 10, "phone_recent_abuse": false, "phone_voip": true, "phone_prepaid": false, "phone_risky": false, "phone_active": true, "phone_carrier": "VODAFONE", "phone_line_type": "VoIP", "phone_country": "PT", "phone_region": "PT", "phone_dialing_code": 351, "phone_request_id": "requestId1", "phone_call_attestation_type": "TN-Validation-Passed-C", "phone_call_attestation_valid\"": true, "voice_operation": "VERIFY", "voice_risk_score": 27.99999713897705, "voice_result": { "result": "SUCCESS" }, "overall_risk_score": 27.99999713897705, "is_deleted": false, "phone_number": "+351912345678", "voice_type": "PASSIVE" } ], "_links": { "first": { "href": "https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=2" }, "last": { "href": "https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=10" }, "next": { "href": "https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=3" }, "prev": { "href": "https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27&page=1" }, "self": { "href": "https://api-docs.talkdesk.org/identity/activities?filter=voice_type%20eq%20%27PASSIVE%27%20and%20contact_id%20eq%20%27753%27%20and%20%20interaction_id%20eq%20%27c5572384a4c340c2b326965fdb13ca0e%27" }, "show": { "href": "https://api-docs.talkdesk.org/identity/activities?page=1&per_page=10" } } } } }, "description": "Contact voice authentication history response" }, "400": { "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": "1910003", "message": "A constraint violation error has occurred." } } }, "description": "Bad Request" }, "401": { "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": "1910010", "message": "Unauthorized" } } }, "description": "Unauthorized" }, "403": { "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": "1910009", "message": "Forbidden" } } }, "description": "Forbidden" }, "404": { "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": "1910001", "message": "Phone quality service not available." } } }, "description": "Not Found" } }, "security": [ { "GA": [ "identity-activity:read" ] } ], "tags": [ "Identity API" ] } } }, "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" } } ```