Released in 1.50
Search users by emails, ids or username
curl -X GET \ 'https://acme.symphony.com/pod/v3/users?uid=7696581394433,7696581394434&local=true' \ -H 'SessionToken: SESSION_TOKEN' \
curl -X GET \ 'https://cip3-qa.symphony.com/pod/v3/[email protected],[email protected]&local=true' \ -H 'SessionToken: SESSION_TOKEN' \
curl -X GET \ 'https://cip3-qa.symphony.com/pod/v3/users?username=test_1,test_2&local=true' \ -H 'SessionToken: SESSION_TOKEN' \
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
Xpod entitlements set
The callers need to have the xpod (cross-company) entitlements set, otherwise, the API will return a 204 error (no content).
Rules & Limitations
- Please note that the endpoint returns only the first 1000 entries.
Search list sizes: search lists may contain up to 100 elements.
Inactive users: the results will include inactive users.
Account type: the
NORMALif the user is a user account and
SYSTEMif the user is a service account.
User department, location, title and email: the
emailAddressfields 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.