📢  For documentation aligned with the current release, access the main Planful Help.

List Users and Groups (User Management)

  • 1 minute(s) read
Prev Next

These APIs are provided in JSON format. They return the names of users or user groups for an applcation (tenant).

Returns a list of User Objects for that application (tenant).

GET /api/ui/user/getRaw
Content-Type: application/json
Accept: application/json
X-ACCESS-TOKEN: <Token>
Sample Response in JSON

[
  {
  "email": "testuser1@test.com",
  "name": "",
  "status": "Unverified",
  "groups": [
  {
  "name": "Group1"
  }
 ],
  "role": "Admin",
  "invalidPasswordAttempts": 0,
  "lockedStatus": "UnLocked",
  "emailSubscription": "Subscribe",
  "userType": "External",
  "supportRole": "Administrator"
  },
  {
  "email": "testuser2@test.com",
  "name": "",
  "status": "Unverified",
  "groups": [
  {
  "name": "Group1"
  },
  {
  "name": "Group2"
  }
 ],
  "role": "Reviewer",
  "invalidPasswordAttempts": 0,
  "lockedStatus": "UnLocked",
  "emailSubscription": "Subscribe",
  "userType": "Business",
  "supportRole": "Administrator"
  }
]
Returns a List <String> of group names.

GET /api/ui/group/getRaw
Content-Type: application/json
Accept: application/json
X-ACCESS-TOKEN: <Token>
Sample Response in JSON

[
"Group1",
"Group2"
]