Skip to main content
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",
      "settings": {
        "status": "available",
        "supersetRole": "<string>",
        "ticketsFilters": {
          "groups": [
            1
          ],
          "intents": [
            "process_meter_reading"
          ],
          "tagIds": [
            1
          ],
          "personalQueue": true,
          "onlyIntents": true
        },
        "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"
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

JWT-based authentication

Query Parameters

​
q
string

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

​
show
enum<string>

Which profiles to show. Defaults to 'users'

Available options:
users,
all,
enneo,
serviceWorkers
​
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.

Available options:
full,
short
​
limit
integer

Maximum number of profiles to return. Defaults to 100.

Required range: x >= 1
​
offset
integer

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

Required range: 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.

Example:
[1, 2]
​
tagIds
integer[]

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

Example:
[1, 2]
​
channels
string[]

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

Example:
["email", "chat"]
​
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.

Example:

"online"

Response

200 - application/json

Successful operation

​
success
boolean
Example:

true

​
profiles
object[]