Skip To Content ArcGIS for Developers Sign In Dashboard

Group Users List

Description

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

Request parameters

ParameterDetails
[Common Parameters]

For a complete listing, see Common parameters.

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: start=11 (Returns result #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.

Note that the actual number of returned results may be fewer than num. This happens when the number of results remaining after start is fewer than num.

Example: num=50 (Returns a max of 50 results in the response).

sortField

Field to sort by. Default is username.

Values: username | membertype | joined (the date the user joined the group shown in UNIX time in milliseconds)

sortOrder

Describes whether the results return in ascending or descending order. The default is ascending.

Values: asc | desc

memberType

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.

Both stand-alone time stamp and time range with either endpoint omissible are supported.

Example: joined=1484875784000 or joined=1484875784000,1500000000000 or joined=1484875784000, or joined=,1500000000000

name

Users with a specific full name (case sensitive) to be returned.

Example: name=Jeff Smith

Response properties

PropertyDetails
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 user name and full name of the group owner.

Example:

{
    "username": "jsmith",
    "fullName": "Jeff Smith"
  }
users

An array of JSON objects with each containing the user name, full name, member type, profile picture, and date they joined the group.

Example:

[
    {
      "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
    }
 ]

Example usage

URL for Group Users List

https://www.arcgis.com/sharing/rest/community/groups/d605ce8c5bb44ed8a0f911bf6568f623/userList

JSON Response syntax

{
  "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

{
  "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
    }
  ]
}