List Users

Returns a list of users ID, including user metadata.

Retrieve a list of all users in the company (pod)

get

/v2/admin/user/list

Query parameters

skipinteger

Number of users to skip. Default is 0. Must be a integer equals or bigger than 0.

limitinteger

Maximum number of users to return. Default is 100. Must be a positive integer and must not exceed 1000.

Header parameters

sessionTokenstringrequired

Session Authentication token.

Responses

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'yourpodURL.symphony.com/pod/v2/admin/user/list' \
  --header 'sessionToken: text'

200

400

401

403

500

200

[
  {
    "roles": [
      "USER_PROVISIONING",
      "CONTENT_MANAGEMENT",
      "INDIVIDUAL"
    ],
    "userAttributes": {
      "emailAddress": "[e-mail]",
      "userName": "nexus.user",
      "displayName": "nexus.user",
      "accountType": "SYSTEM"
    },
    "userSystemInfo": {
      "id": 9826885173290,
      "status": "ENABLED",
      "suspended": false,
      "createdDate": 1499375475000,
      "createdBy": "9826885173255",
      "lastUpdatedDate": 1499375475852,
      "lastLoginDate": 1504899124191
    }
  },
  {
    "roles": [
      "SUPER_COMPLIANCE_OFFICER",
      "INDIVIDUAL",
      "SUPER_ADMINISTRATOR"
    ],
    "userSystemInfo": {
      "id": 7696581394433,
      "status": "ENABLED",
      "suspended": false,
      "createdDate": 1438054194000,
      "lastUpdatedDate": 1527532171729,
      "lastLoginDate": 1523912043015
    },
    "userAttributes": {
      "emailAddress": "[e-mail]",
      "firstName": "admin",
      "lastName": "admin",
      "userName": "[e-mail]",
      "displayName": "Admin Admin",
      "companyName": "Company Name",
      "department": "Departament",
      "division": "Division",
      "title": "Administrator",
      "twoFactorAuthPhone": "[phone]",
      "workPhoneNumber": "[phone]",
      "mobilePhoneNumber": "[phone]",
      "accountType": "NORMAL",
      "assetClasses": [
        "Currencies"
      ],
      "industries": [
        "Technology"
      ]
    }
  }
]

Success

Note: Some properties of the user are not included in the List users response for performance reasons. For example, the disclaimers and features are not present. Please use the dedicated endpoints (List Features and List Disclaimers) instead.

🚧 Required Permissions

Calling this endpoint requires the ACCESS_USER_PROVISIONING_API privilege. See Bot Permissions for a list of roles and associated privileges.