Group Resource

A group is a collection of people (i.e., users) identified by a unique name and/or emblem.

Changelog

1.0.4

Added memberships relation.

1.0.13

Added lastModified property.

1.0.14

Added rootFolder relation.

1.0.22

Added hasExternalMembers property.

1.0.23

Added permissions metadata.

1.1

Added hidden, parent and subgroups properties.

1.1.10

Added membersMayPost and XID properties.

1.4.3

Added lockedBy membership metadata.

1.6.8

Added defaultEmblemThumbnailUrl property which contains a default group emblem
emblemThumbnailUrl will only be present when a group has a custom emblem

Endpoints

Representations

JSON Properties

Name	Type	Description
created	datetime	Read-only Date the group was created
defaultEmblemThumbnailUrl	string	Read-only File URL to network emblem
description	string	Description
EID	EID	Unique entity identifier
emblemThumbnailUrl	URI	Read-only File URL to network emblem or logo graphic
groupType	string	One of the four basic types: `public`, `restricted`, `private` and `secret`, or an enterprise-type custom to the network
hasExternalMembers	boolean	Since 1.0.22 Read-only Whether external network members are member of the group
headerBackgroundUrl	URI	Read-only File URL to header background image
hidden	boolean	Since 1.1 Read-only Whether this group is visible (by default) in group collections (clients can override this behavior with the include_hidden filter)
lastModified	datetime	Since 1.0.13 Read-only Last time the group was modified
membersMayPost	boolean	Since 1.1.10 Whether regular group members, besides the group administrators, may post messages to the group or not
name	string	Group name
numMembers	number	Read-only Number of members
type	string	"group"
XID	string	Since 1.1.10 Unique external identifier

Links

Relation	Resource	Description
emblem	message	File message containing the groups's emblem
headerBackground	message	File message containing the groups's header background
members	user	Group members
memberships	membership	Memberships of the group members
parent	group	Parent group
rootFolder	message	Root folder
subgroups	group	Children groups

End-user Metadata (read-only)

Name	Type	Description
member	boolean	Whether the logged in user is member of the group
permissions	string	List of permission the logged in user has in this group
role	string	Role of the user in the group (`guest` if not a member)

Membership Metadata (read-only)

This metadata is only available when request the User Groups subresource.

Name	Type	Description
admin	boolean	Since 1.0.24 Whether the logged in user is administrator of the group
lockedBy	string	Since 1.4.3 Hints the application that protects this membership from deletion

Example

{
    "_links": {
        "self": {
            "href": "/networks/fedcba0987654321/groups/1234567890abcdef/"
        },
        "emblem": {
            "href": "/networks/fedcba0987654321/messages/abcdef0123456789/"
        },
        "members": {
            "href": "/networks/fedcba0987654321/users/?group=1234567890abcdef"
        },
        "memberships": {
            "href": "/networks/fedcba0987654321/memberships/?group=1234567890abcdef/"
        },
        "rootfolder": {
            "href": "/networks/fedcba0987654321/messages/abcdef9876543210/"
        }
    },
    "_user": {
        "member": true,
        "role": "member",
        "permissons": "post_message,view_group,view_group_timeline,view_group_members"
    },
    "EID": "1234567890abcdef",
    "type": "group",
    "name": "Acme Engineers",
    "description": "Engineers group",
    "groupType": "private",
    "hasExternalMembers": false,
    "hidden": false,
    "emblemThumbnailUrl": "http://vault.speakap.com/file/1234567890ABCDEF",
    "defaultEmblemThumbnailUrl": "http://vault.speakap.com/file/1234567890ABCDEF",
    "headerThumbnailImageUrl": "http://vault.speakap.com/file/abcdef0123456789",
    "lastModified":"2015-03-23T10:02:25.123+01:00",
}