Get the direct members of the specified group.
get
/social/api/v1/groups/{groupID}/members
Request
Supported Media Types
- application/json
Path Parameters
-
groupID: integer(int64)
The group ID. The object's unique identifier from a long integer representation.
Response
Supported Media Types
- application/json
200 Response
Successful operation.
V1 Group Direct Member List Information DTO.
Root Schema : XV1GroupMemberListInfo
Type:
object
V1 Group Direct Member List Information DTO.
Show Source
-
hasMore:
boolean
If true, there are more items to be returned.
-
items:
array items
The Members being returned.
-
nextURL:
string(url)
Next page URL for the list. Null if this is the last page.
-
previousURL:
string(url)
Previous page URL for the list. Null if this is the first page.
-
total:
integer(int32)
If specified, this is the total number of available items. Null if the total is unknown.
Nested Schema : items
Type:
array
The Members being returned.
Show Source
-
[0]:
object XV1GroupMemberInfo
V1 Group Direct Member Information DTO.
Nested Schema : XV1GroupMemberInfo
Type:
object
V1 Group Direct Member Information DTO.
Show Source
-
altitude:
number(double)
The object's altitude.
-
collectionURL:
string(url)
A URL to this object's containing collection.
-
conversationURL:
string(url)
A URL to this object's containing conversation.
-
createdByID:
An object's unique identifier from a long integer representation.
-
createdByURL:
string(url)
A URL to the user that created this object.
-
createdByUserDisplayName:
string
The display name of the user that created this object.
-
createdByUserName:
string
The name of the user that created this object.
-
createdDate:
string(date)
The date this object was created.
-
createdDateInISO8601Format:
string
The date this object was created, in ISO 8601 format.
-
displayName:
string
The display name of this object.
-
groupURL:
string(url)
A URL to the containing Group.
-
id:
An object's unique identifier from a long integer representation.
-
isDirect:
boolean
The Member's direct status.
-
isRemoved:
boolean
True if this message has been removed.
-
latitude:
number(double)
The object's latitude.
-
longitude:
number(double)
The object's longitude.
-
membersURL:
string(url)
A URL to the Members of this Group.
-
modifiedByID:
An object's unique identifier from a long integer representation.
-
modifiedByURL:
string(url)
A URL to the user that last modified this object.
-
modifiedByUserDisplayName:
string
The display name of the user that last modified this object.
-
modifiedByUserName:
string
The name of the user that last modified this object.
-
modifiedDate:
string(date)
The date this object was last modified.
-
modifiedDateInISO8601Format:
string
The date this object was last modified, in ISO 8601 format.
-
name:
string
The name of this object.
-
objectType:
string
The type of this object.
-
removedByID:
An object's unique identifier from a long integer representation.
-
removedByURL:
string(url)
A URL to the user that last removed this object.
-
removedByUserDisplayName:
string
The display name of the user that last removed this object.
-
removedByUserName:
string
The name of the user that last removed this object.
-
removedDate:
string(date)
The date this object was removed.
-
removedDateInISO8601Format:
string
The date this object was removed, in ISO 8601 format.
-
role:
object XV1ConversationRole
-
socialObjectURL:
string(url)
A URL to this object's containing collaboration object.
-
url:
string(url)
A URL to this object.
Nested Schema : XV1ConversationRole
Type:
Show Source
object
-
field:
string
Allowed Values:
[ "ADMIN", "BYPASS", "CONTRIBUTOR", "DISCOVERER", "GROUP_MANAGER", "GROUP_MEMBER", "HOST", "MANAGER", "MEMBER", "MODERATOR", "NONE", "VIEWER" ]
V1 Conversation Roles.Conversation roles are used to define grantable and nongrantable access to conversations.