Get Settings
This endpoint retrieves the settings for a specific agent by their unique identifier.
Parameters
Response Fields
The unique identifier of the agent.
A test field for the agent’s settings.
Indicates whether the agent take over tag is enabled.
Indicates whether the agent should skip certain emails.
An array of tags that the agent should skip.
The name of the model used by the agent.
The type of model used by the agent.
The provider of the model used by the agent.
The temperature setting for the model.
The maximum number of tokens allowed in the agent’s responses.
An array of subjects that the agent should skip.
Keywords indicating out-of-office status that the agent should recognize.
An array of channels that the agent should skip.
Indicates whether the agent should skip Instagram messages.
An array of emails associated with the agent.
The time threshold for the agent’s operations, in minutes.
The user ID of the person assigned to the agent.
An array of intents that the agent is allowed to process.
Keywords related to health concerns that the agent should recognize.
Phrases that trigger the agent to take over a conversation.
The team ID for escalations.
The name of the tag used for escalations.
The email used by the StateSet response system integrated with Gorgias.
The user ID in the StateSet response system integrated with Gorgias.
The name of the response used by StateSet.
The name that appears in the “From” field of the agent’s communications.
The address that appears in the “From” field of the agent’s communications.
The analytics platform used by the agent.
The agent’s average response time, in seconds.
The frequency of backups for the agent’s data.
The retention period for the agent’s backups.
Indicates whether the agent is compliant with CCPA regulations.
The timestamp when the agent was created.
The CRM system used by the agent.
The agent’s customer satisfaction score.
The target customer satisfaction score for the agent.
The level of encryption used by the agent.
The data retention period for the agent’s data.
The ID of the fallback agent in case of issues.
Indicates whether the agent is GDPR compliant.
The rate at which the agent resolves issues on first contact.
The average handle time for the agent’s tasks, in seconds.
Indicates whether the agent should skip emails based on intent.
A list of IP addresses that are whitelisted for the agent.
The language preferences set for the agent.
The maximum duration of a conversation handled by the agent, in minutes.
The organization ID associated with the agent.
Indicates whether the agent is PCI DSS compliant.
Indicates whether the agent has a profanity filter enabled.
The resolution rate for the agent’s tasks.
The target resolution rate for the agent’s tasks.
The threshold for the agent’s response time, in seconds.
The threshold for the agent’s sentiment analysis.
The ticketing system used by the agent.
The data sources used for training the agent.
The frequency of the agent’s training sessions.
The last date the agent’s training was updated.
Indicates whether two-factor authentication is required for the agent.
The timestamp when the agent’s settings were last updated.