Returns all current users. The optional request parameters 'filter', 'ascending', 'offset', and 'pageSize' can be used to filter, sort, and paginate. The response is an object with an array of user objects. A 'managedGroupKeys' array value of -1 signifies that the user had one or more managed group keys deleted, leaving no valid group keys.

Parameters

Name Required Data Type Value Range Description
filter No expression* N/A limits results to records with values that match expression
ascending No sort list N/A list of resource fields to set sort order and priority
offset No non-negative integer 0-100 offset of report content in lines from the top of the page
pageSize No non-negative integer 0-120 quantity of output in lines

Roles

Any

URL

https://api.getgo.com/admin/rest/v1/accounts/{accountKey}/users

Method

GET

Response Type

JSON

HTTP Request Example

GET
https://api.getgo.com/admin/rest/v1/accounts/8830995/users
HTTP 1.1
Accept: application/json
Content-type: application/json
Authorization: OAuth oauth_token= ZlUe11FakEyCWxtOkeN3wk0uTKuL

Response Example

200 OK
{
 "key":"123",
 "email":"Juvene.Loral@realwhirled.org",
 "firstName":"Juvene",
 "lastName":"Loral",
 "admin":true,
 "locale":"en_US",
 "licenseKeys":["9000,7000"],
 "products":["G2M","G2W"],
 "groupKey":"555",
 "groupName":"Corporate",
 "groupKeyPath":["111", "555"],
 "groupNamePath":["Sales", "Corporate"],
 "adminRoles":["MANAGE_USERS","MANAGE_SEATS"],
 "identityReadOnly":false,
 "managedGroupKeys":["555,"777"],
 "settings":{
  "g2m":{
   "attendeeListEnabled":true,
   "keyboardMouseControlEnabled":true,
   "chatEnabled":true,
   "recordingEnabled":true,
   "webcamEnabled":true,
   "tollAccessible":true,
   "voipAccessible":true,
   "privateConfCallAccessible":true,
   "tollFreeAccessible":true,
   "tollFreeProvisioned":true,
   "moderatorPrivateMessage":"Message",
   "tollCountries":["US","FR"],
   "allowedTollCountries":["US","FR"],
   "tollFreeCountries":["US","DE"],
   "allowedTollFreeCountries":["US","DE"],
   "preferredCountry":"US"
  },
  "g2w":{
   "chatAndQaEnabled":true,
   "tollAccessible":true,
   "voipAccessible":true,
   "privateConfCallAccessible":true,
   "tollFreeAccessible":true,
   "tollFreeProvisioned":true,
   "moderatorPrivateMessage":"Message",
   "tollCountries":["US","FR"],
   "allowedTollCountries":["US","FR"],
   "tollFreeCountries":["US","DE"],
   "allowedTollFreeCountries":["US","DE"],
   "preferredCountry":"US"
  }
 }
}

Status Codes

Status Code Field/Rejected Value Description
400 Bad Request request.offset.min offset Offset is negative
400 Bad Request request.pagesize.min pagesize Page size is non positive
400 Bad Request request.filter.invalid filter Filter is invalid
400 Bad Request request.filter.maxlength filter Filter exceeds 1000 characters
400 Bad Request invalid.data.type ascending Invalid ascending syntax
400 Bad Request invalid.data.type ascending[] Invalid ascending syntax