/userList: Group Users List

URL:: https://[root]/community/groups/[groupID]/userList
Methods:: GET

Example usage

The following is a sample ArcGIS Online request URL used to access the userList resource:

Use dark colors for code blocksCopy
https://org.arcgis.com/sharing/rest/community/groups/d605ce8c5bb44ed8a0f911bf6568f623/userList?f=pjson

The following is a sample ArcGIS Enterprise request URL used to access the userList resource:

Use dark colors for code blocksCopy
https://machine.domain.com/webadaptor/sharing/rest/community/groups/d605ce8c5bb44ed8a0f911bf6568f623/userList?f=pjson

Description

The userList resource lists the owner and the users of a given group, including group members and administrators.

Request parameters

Parameter	Details
`start`	The number of the first entry in the result set response. The index number is 1-based. The default value of `start` is 1. Example: Use dark colors for code blocksCopy `1 start=11 //Returns results number 11 as the first entry in the response.`
`num`	The maximum number of results to be included in the result set response. The default value is 25, and the maximum allowed value is 100. The actual number of returned results may be fewer than the `num` value. This happens when the number of results remaining after the `start` value is fewer than the `num` value. Example: Use dark colors for code blocksCopy `1 num=50 //Returns a maximum of 50 results in the response.`
`sortField`	Specifies the field to sort by. The default is `username`. Values: `username` \| `membertype` \| `joined` (the date the user joined the group shown in Unix time in milliseconds)
`sortOrder`	Specifies whether the results are returned in ascending or descending order. The default is `asc`. Values: `asc` \| `desc`
`memberType`	Specifies the type of members in the group to be returned. Values: `admin` (group manager) \| `member` (group member)
`joined`	Users who joined the group during a specific time frame in Unix time in milliseconds to be returned. A stand-alone time stamp and a time range with either endpoint omissible are supported. Example: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 //stand-alone time stamp joined=1484875784000 //time range joined=1484875784000,1500000000000 //time range missing last endpoint joined=1484875784000, //time range missing first endpoint joined=,1500000000000`
`name`	The name of the user. The full name or a portion of the first or last name can be used. Example: Use dark colors for code blocksCopy `1 name=Jeff Smith`

Response properties

Property	Details
`total`	The total number of results for the query.
`start`	The number of the first entry in the result set for the response. The index number is 1-based.
`num`	The number of results included in the result set for the response.
`nextStart`	The next entry index if the current result set does not contain all results, or -1 if it is the last batch.
`owner`	A JSON object that contains the username and full name of the group owner. Example: Use dark colors for code blocksCopy `1 2 3 4 { "username": "jsmith", "fullName": "Jeff Smith" }`
`users`	An array of JSON objects with each containing the username, full name, member type, profile picture, and date the user joined the group. Example: Use dark colors for code blocksCopy `1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 [ { "username": "username1", "fullName": "First1 Last1", "memberType": "member", "thumbnail": null, "joined": 1460497506000 }, { "username": "username2", "fullName": "First2 Last2", "memberType": "admin", "thumbnail": null, "joined": 1475885887000 }, { "username": "username3", "fullName": "First3 Last3", "memberType": "member", "thumbnail": "profile_pic.PNG", "joined": 1475885887000 } ]`

JSON Response syntax

Use dark colors for code blocksCopy
{
  "total": <total number of results>,
  "start": <the number of first entry in result set>,
  "num": <number of results included in the result set>,
  "nextStart": <the next entry index>,
  "owner": {
    "username": "<group owner username>",
    "fullName": "<group owner full name>"
  },
  "users": [
    {
      "username": "<group user username>",
      "fullName": "<group user full name>",
      "memberType": "admin | member",
      "thumbnail": "<profile picture>",
      "joined": <date joined group shown in Unix time>
    },
    {
      "username": "<group user username>",
      "fullName": "<group user full name>",
      "memberType": "admin | member",
      "thumbnail": "<profile picture>",
      "joined": <date joined group shown in Unix time>
    }
  ]
}

JSON Response example

Use dark colors for code blocksCopy
{
  "total": 35,
  "start": 1,
  "num": 3,
  "nextStart": 4,
  "owner": {
    "username": "jsmith",
    "fullName": "Jeff Smith"
  },
  "users": [
    {
      "username": "jane_doe",
      "fullName": "Jane Doe",
      "memberType": "member",
      "thumbnail": "profile.jpg",
      "joined": 1453497930000
    },
    {
      "username": "john_smith",
      "fullName": "John Smith",
      "memberType": "admin",
      "thumbnail": null,
      "joined": 1464157223000
    },
    {
      "username": "chrisw",
      "fullName": "Chris White",
      "memberType": "member",
      "thumbnail": null,
      "joined": 1484875784000
    }
  ]
}