Search Users

Search for end-users, bots or distribution lists (groups) by first name, last name, display name, and email, and filter results by company, title, location, marketCoverage, responsibility, function, or instrument.

Search for users by name or email address

post

Query parameters

skipintegerOptional

number of records to skip

limitintegerOptional

Max number of records to return. If no value is provided, 50 is the default.

localbooleanOptional

If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

Header parameters

sessionTokenstringRequired

Session authentication token.

Body

application/json

querystringOptional

search / query term. This can be firstname, lastname, displayname or email

Example: jane

Responses

200

OK

application/json

countinteger · int64Optional

The total number of users which matched the search criteria.

Example: 1

skipinteger · int64Optional

The number of skipped results.

limitinteger · int64Optional

The number of returned results.

Example: 1

204

No user found.

400

Client error, see response body for further details.

application/json

401

Unauthorized: Invalid session token.

application/json

403

Forbidden: Caller lacks necessary entitlement.

application/json

500

Server error, see response body for further details.

application/json

post

/v1/user/search

HTTPcURLJavaScriptPython

POST /pod/v1/user/search HTTP/1.1
Host: yourpodURL.symphony.com
sessionToken: text
Content-Type: application/json
Accept: */*
Content-Length: 223

{
  "query": "jane",
  "filters": {
    "accountTypes": "NORMAL",
    "title": "Sales Manager",
    "company": "Symphony",
    "location": "Marseille",
    "marketCoverage": "EMEA",
    "responsibility": "BAU",
    "function": "Trade Management",
    "instrument": "Securities"
  }
}

{
  "count": 1,
  "skip": 0,
  "limit": 1,
  "searchQuery": {
    "query": "jane",
    "filters": {
      "title": "Sales Manager",
      "company": "Symphony",
      "location": "San Francisco",
      "marketCoverage": "EMEA",
      "responsibility": "BAU",
      "function": "Trade Management",
      "instrument": "Securities",
      "accountTypes": [
        "NORMAL"
      ]
    }
  },
  "users": [
    {
      "id": 13056700581099,
      "emailAddress": "[email protected]",
      "firstName": "Jane",
      "lastName": "Doe",
      "displayName": "Jane Doe",
      "title": "Sales Manager",
      "company": "Symphony",
      "location": "San Francisco",
      "accountType": "NORMAL",
      "avatars": [
        {
          "size": "original",
          "url": "../avatars/static/150/default.png"
        },
        {
          "size": "small",
          "url": "../avatars/static/50/default.png"
        }
      ]
    }
  ]
}

Request Example

curl -X POST \
https://acme.symphony.com/pod/v1/user/search?local=false \
-H "sessionToken: SESSION_TOKEN" \
-H "Content-Type: application/json"  \
-d '{
  "query": "jane",
  "filters": {
    "title": "Sales Manager",
    "location": "San Francisco",
    "company": "Symphony",
    "marketCoverage":"EMEA",
    "responsibility":"BAU",
    "function":"Trade Management",
    "instrument":"Securities",
    "accountTypes":["NORMAL","SDL"]
  }
}'

📘 Note

• This endpoint can return inexact matches of the specified criteria, while Find Users returns only exact matches.

• Account type:

  • The accountType field can contain a list of strings with the following supported values: NORMAL, SYSTEM, or SDL. Please note that if this is not specified, then the default search will return NORMAL and SYSTEM users in the payload.

  • The accountType field returns NORMAL if the user is a user account, SYSTEM if the user is a service account, or SDL if the user is a Symphony Distribution List (Groups). User location, title and email: the location, title and emailAddress fields are returned only if the user is an internal user of the current pod. When searching between cross-pods, these fields will not be returned.

The caller can specify whether to search locally (within the caller's company) or globally across companies that have enabled external communications.

To search for external users, the parameter local needs to be set as false and the service account has to be enabled externally. To do so, make sure at least one of the two following external entitlements are enabled, otherwise, the search will return zero results. • Can chat in external IM/MIMs • Can chat in private external rooms

By default, searches are performed externally. Set local=true to search locally.

Searching external users by email

The service account is allowed to search for users using their registered email even without having a previous connection with them.

OBO enabled endpoint

When calling this as an OBO-enabled endpoint, use the OBO User Authenticate token for sessionToken.