API Dokumentation
ticket
- GETGet next ticket id to work on
- POSTGet a list of tickets
- POSTCreate a ticket
- PATCHUpdate a few tickets at once
- GETGet a ticket
- PATCHUpdate a ticket
- GETGet ticket variables
- GETGet a tickets history
- POSTForward a ticket
- POSTAuto-execute a ticket
- GETPing a ticket
- GETGet ticket activity
- GETGet ticket stats
- GETGet agent queue status
customer
intent
aiAgent
- GETList of all available AI agents as an array
- GETList of all available AI agents as an tree based on associated tag
- POSTLoad enneo default AI Agents
- POSTCreate a new aiAgent
- GETGet an AI Agent by id
- DELDelete an existing AI Agent
- PATCHUpdate an existing AI Agent
- GETGet similar tickets for an AI Agent
- POSTPreview an AI Agent
- POSTGet the outcome of an AI Agent
aiQualityCheck
- GETGet all test runs with pagination
- POSTSchedule a new AI quality check
- GETGet a specific test run by ID
- DELDelete a specific test run by ID
- PATCHUpdate the expected result of a test ticket
- PATCHAccept the expected result of a test ticket
- POSTAccept ALL the expected results of for a test run
- GETGet all AI agents for which test runs can be triggered
- GETGet all AI agents for which test runs can be triggered
- GETGet test cases by AI agent ID
- POSTAdd test cases for an AI agent
- DELDelete a test case by ID
- PATCHUpdate a test case by ID
intentTemplate
profile
team
reminder
settings
- GETGet settings of a client
- POSTUpdate multiple settings at once
- GETGet settings of a client and return the results in a compact form
- GETGet settings of a client in a grouped way for a category
- PUTUpdate setting
- GETSearch settings
- GETGet Subchannels
- POSTAdd a new Subchannel
- DELDelete a Subchannel
- GETGet User Defined Functions
- POSTAdd a new User Defined Function
- DELDelete a User Defined Function
- GETRedirect to Microsoft authorization page
- GETCallback for Microsoft authorization
tag
cron
version
knowledgeSourceStructure
knowledgeSource
pcProxy
cortex
Search profiles
curl --request GET \
--url https://demo.enneo.ai/api/mind/profiles
{
"success": true,
"profiles": [
{
"id": 1,
"firstName": "Max",
"lastName": "Mustermann",
"email": "demo@enneo.dev",
"phone": "+49 123 456789",
"lastSeen": "2021-08-12 12:21:21",
"type": "enneo",
"isSsoOnly": false,
"lang": "de",
"settings": {
"roleId": 1,
"skills": {
"intents": [
"process_meter_reading"
],
"tagIds": [
1
],
"channels": [
"email"
]
},
"status": "available",
"departmentId": 1,
"teamIds": [
1
],
"supersetRole": "<string>",
"ticketsFilters": {
"groups": [
1
],
"intents": [
"process_meter_reading"
],
"tagIds": [
1
],
"personalQueue": true,
"onlyIntents": true
},
"freshdeskApiAuth": "STj8Iajtp5iMzogZalVT",
"actualRoleId": 1,
"isPersonalFilters": false,
"inheritTeamSettings": false,
"nameReports": "Tapfere Feige"
}
}
]
}
Authorizations
Cookie-based authentication
Query Parameters
Search string. It searches in any part of firstName, lastName or email. Defaults to all users
Which profiles to show. Defaults to 'users'
users
, all
, enneo
, serviceWorkers
Determines the format of the profiles. Possible values are 'full' or 'short'. In 'full' format, the settings and last login date of the user are included, provided the user has sufficient permissions.
full
, short
List of team IDs. If provided, only users from these teams will be returned. When not specified, all users are returned. When "unassigned", only users without a team are returned.
List of tag IDs. If provided, only users with these skills will be returned
List of channel IDs. If provided, only users with these channels will be returned
Filter profiles by role ID
Filter users by their last seen time. Can be either a datetime value (e.g. "2023-12-01 14:30:00") or "online" to show only currently active users. When "online" is used, it shows users active in the last 10 minutes. Note: Requires 'readUserLastSeenDate' or 'readAnyUserProfile' permission.
Response
User ID
First name
Last name
Email address
Phone number
The last time the user was seen online
The type of the user
If true, the user can only login via SSO
The language of the user
The id of the role that is used for the user
The status of the user
available
, busy
The id of the department that is used for the user
The ids of the teams that the user is in
The superset role of the user. List of available options is retrieved from /api/mind/profile/{id:\d+}/supersetRoles
Use skills to filter tickets
Show only tickets with intents
The freshdesk api auth of the user
The id of the role that is used for the user
If true, the filters are personal and only apply to the user
If true, the filters are inherited from the team
The name of the reports
curl --request GET \
--url https://demo.enneo.ai/api/mind/profiles
{
"success": true,
"profiles": [
{
"id": 1,
"firstName": "Max",
"lastName": "Mustermann",
"email": "demo@enneo.dev",
"phone": "+49 123 456789",
"lastSeen": "2021-08-12 12:21:21",
"type": "enneo",
"isSsoOnly": false,
"lang": "de",
"settings": {
"roleId": 1,
"skills": {
"intents": [
"process_meter_reading"
],
"tagIds": [
1
],
"channels": [
"email"
]
},
"status": "available",
"departmentId": 1,
"teamIds": [
1
],
"supersetRole": "<string>",
"ticketsFilters": {
"groups": [
1
],
"intents": [
"process_meter_reading"
],
"tagIds": [
1
],
"personalQueue": true,
"onlyIntents": true
},
"freshdeskApiAuth": "STj8Iajtp5iMzogZalVT",
"actualRoleId": 1,
"isPersonalFilters": false,
"inheritTeamSettings": false,
"nameReports": "Tapfere Feige"
}
}
]
}