Search profiles

curl --request GET \
  --url https://demo.enneo.ai/api/mind/profiles \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "profiles": [
    {
      "id": 1,
      "firstName": "Max",
      "lastName": "Mustermann",
      "email": "[email protected]",
      "phone": "+49 123 456789",
      "lastSeen": "2021-08-12 12:21:21",
      "type": "enneo",
      "isSsoOnly": 0,
      "lang": "de",
      "nameAlias": "Johnny",
      "externalId": "EMP-12345",
      "settings": {
        "status": "available",
        "supersetRole": "<string>",
        "ticketsFilters": {
          "groups": [
            1
          ],
          "intents": [
            "process_meter_reading"
          ],
          "tagIds": [
            1
          ],
          "personalQueue": true,
          "onlyIntents": true
        },
        "roleId": 1,
        "teamIds": [
          1
        ],
        "skills": {
          "tagIds": [
            1,
            2
          ],
          "channels": [
            "email",
            "chat"
          ]
        },
        "actualRoleId": 1,
        "actualTeamIds": [
          1
        ],
        "actualSkills": {
          "intents": [
            "process_meter_reading"
          ],
          "tagIds": [
            1
          ],
          "channels": [
            "email"
          ]
        },
        "limitTicketBacklogAccess": false,
        "ticketBacklogRequiredTagIds": [
          1
        ],
        "tagsOnRoute": [
          1
        ],
        "tagsOnEdit": [
          1
        ],
        "actualLimitTicketBacklogAccess": false,
        "actualTicketBacklogRequiredTagIds": [
          1
        ],
        "actualTagsOnRoute": [
          1
        ],
        "actualTagsOnEdit": [
          1
        ],
        "isPersonalFilters": false,
        "inheritTeamSettings": false,
        "nameReports": "Tapfere Feige",
        "callRoutingStatus": "idle",
        "chatRoutingStatus": "idle"
      }
    }
  ]
}

GET

profiles

Search profiles

curl --request GET \
  --url https://demo.enneo.ai/api/mind/profiles \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "profiles": [
    {
      "id": 1,
      "firstName": "Max",
      "lastName": "Mustermann",
      "email": "[email protected]",
      "phone": "+49 123 456789",
      "lastSeen": "2021-08-12 12:21:21",
      "type": "enneo",
      "isSsoOnly": 0,
      "lang": "de",
      "nameAlias": "Johnny",
      "externalId": "EMP-12345",
      "settings": {
        "status": "available",
        "supersetRole": "<string>",
        "ticketsFilters": {
          "groups": [
            1
          ],
          "intents": [
            "process_meter_reading"
          ],
          "tagIds": [
            1
          ],
          "personalQueue": true,
          "onlyIntents": true
        },
        "roleId": 1,
        "teamIds": [
          1
        ],
        "skills": {
          "tagIds": [
            1,
            2
          ],
          "channels": [
            "email",
            "chat"
          ]
        },
        "actualRoleId": 1,
        "actualTeamIds": [
          1
        ],
        "actualSkills": {
          "intents": [
            "process_meter_reading"
          ],
          "tagIds": [
            1
          ],
          "channels": [
            "email"
          ]
        },
        "limitTicketBacklogAccess": false,
        "ticketBacklogRequiredTagIds": [
          1
        ],
        "tagsOnRoute": [
          1
        ],
        "tagsOnEdit": [
          1
        ],
        "actualLimitTicketBacklogAccess": false,
        "actualTicketBacklogRequiredTagIds": [
          1
        ],
        "actualTagsOnRoute": [
          1
        ],
        "actualTagsOnEdit": [
          1
        ],
        "isPersonalFilters": false,
        "inheritTeamSettings": false,
        "nameReports": "Tapfere Feige",
        "callRoutingStatus": "idle",
        "chatRoutingStatus": "idle"
      }
    }
  ]
}

Autorisierungen

Authorization

string

header

erforderlich

JWT-based authentication

Abfrageparameter

string

Search string. It searches in any part of firstName, lastName or email. Defaults to all users

userIds[]

integer[]

List of specific user IDs to retrieve. When provided, only profiles with these IDs will be returned. Works in combination with other filters (e.g., show, teamIds).

show[]

enum<string>[]

Which profiles to show. Can be provided as a single string value (?show=users) or as array values (?show[]=users&show[]=enneo). Defaults to 'users'

Verfügbare Optionen:

users,

all,

enneo,

serviceWorkers,

codeExecutors

format

enum<string>

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.

Verfügbare Optionen:

full,

short

limit

integer

Maximum number of profiles to return. Defaults to 100.

Erforderlicher Bereich: x >= 1

offset

integer

Number of profiles to skip. Useful for pagination. Defaults to 0.

Erforderlicher Bereich: x >= 0

teamIds[]

integer[] | null

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.

tagIds[]

integer[]

List of tag IDs. If provided, only users with these skills will be returned

channels[]

string[]

List of channel IDs. If provided, only users with these channels will be returned

roleId

integer

Filter profiles by role ID

lastSeen

string

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.

Beispiel:

"online"