Users Lookup

Search users by emails, ids or username.

Search users by emails or ids. Only one of the search lists should be informed at a time. Search lists may containt up to 100 elements.

get

/v3/users

Query parameters

uidstring

User IDs as a list of decimal integers separated by comma

emailstring

List of email addresses separated by comma

usernamestring

List of username separated by comma

localboolean

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.

activeboolean

If not set all user status will be returned, if true all active users will be returned, if false all inactive users will be returned

Header parameters

sessionTokenstringrequired

Session authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v3/users' \
  --header 'sessionToken: text'

200

204

400

401

403

500

200

{
  "errors": [
    {
      "error": "invalid.format",
      "email": "notavalidemail"
    },
    {
      "error": "invalid.format",
      "id": 654321
    }
  ],
  "users": [
    {
      "id": 15942919536460,
      "emailAddress": "[e-mail]",
      "firstName": "Technical",
      "lastName": "Writer",
      "displayName": "Technical Writer",
      "title": "Technical Writer",
      "company": "Symphony",
      "department": "Marketing // if internal user",
      "username": "tw",
      "accountType": "NORMAL",
      "location": "France // if internal user",
      "avatars": [
        {
          "size": "original",
          "url": "../avatars/static/150/default.png"
        },
        {
          "size": "small",
          "url": "../avatars/static/50/default.png"
        }
      ]
    },
    {
      "id": 15942919536461,
      "emailAddress": "[e-mail]",
      "firstName": null,
      "lastName": null,
      "displayName": "Service Account",
      "title": null,
      "company": "pod232",
      "department": "Marketing // if internal user",
      "username": "SA",
      "location": "France // if internal user",
      "accountType": "SYSTEM",
      "avatars": [
        {
          "size": "original",
          "url": "../avatars/static/150/default.png"
        },
        {
          "size": "small",
          "url": "../avatars/static/50/default.png"
        }
      ]
    }
  ]
}

OK

Request Examples

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/users?email=[e-mail],[e-mail]&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' \

Search for external users

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 IMs • Can chat in private external rooms

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

The following fields are stripped for external users that don't have an established connection with you:

• Email address

• Location

• Title

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.

🚧 Rules & Limitations

• Please note that the endpoint returns only the first 1000 entries.

📘 Note

Search list sizes: search lists may contain up to 100 elements. Inactive users: the results will include inactive users. Account type: the accountType field returns NORMAL if the user is a user account and SYSTEM if the user is a service account. User department, location, title and email: the department, 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.