Group Members—Private

Request membership in a private group or get the status of requests to a join a private group.

To request membership in a public group use the Group Members resource.

Note

Resource

1/chatter/groups/groupId/members/requests

1/connect/communities/communityId/chatter/groups/groupId/members/requests

Available since version

27.0

Requires Chatter

Yes

HTTP methods

GET, HEAD, and POST

Request parameter for GET

Parameter Name	Type	Description	Available Since
`status`	String	Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values: `Accepted` `Declined` `Pending`	27.0

Response body for GET or HEAD

Group Membership Request Collection

Response body for POST

Group Membership Request

This table lists HTTP response code descriptions that are unique to this resource. For descriptions of other HTTP response codes, see Status Codes and Error Responses.

HTTP Response Code	Description
201	One of the following: Success User already has a membership request for this group
204	User is already a member of this group.
403	One of the following: Group is private: `INSUFFICIENT_ACCESS_OR_READONLY` User is an external user: `INSUFFICIENT_ACCESS`

Example for GET

This example gets information about all the requests to join that have been accepted for this private group:

1/chatter/groups/0F9D00000000izfKAA/members/requests?status=Accepted

The JSON Group Membership Request Collection response body includes one request from the user Gordon Johnson:

1{
2   "requests": [{
3      "createdDate": "2012-10-19T00:23:23.000Z",
4      "id": "0I5D000000002fmKAA",
5      "lastUpdateDate": "2012-10-19T00:24:06.000Z",
6      "requestedGroup": {
7         "id": "0F9D00000000izfKAA",
8         "url": "/services/data/v38.0/chatter/groups/0F9D00000000izfKAA"
9      },
10      "responseMessage": null,
11      "status": "Accepted",
12      "url": "/services/data/v38.0/chatter/group-membership-requests/0I5D000000002fmKAA",
13      "user": {
14         "companyName": "Universal Containers",
15         "firstName": "Gordon",
16         "id": "005D0000001LLO1IAO",
17         "isActive": true,
18         "lastName": "Johnson",
19         "motif": {
20            "color": "1797C0",
21            "largeIconUrl": "/img/icon/profile64.png",
22            "mediumIconUrl": "/img/icon/profile32.png",
23            "smallIconUrl": "/img/icon/profile16.png"
24         },
25         "mySubscription": {
26            "id": "0E8D0000000T5ZUKA0",
27            "url": "/services/data/v38.0/chatter/subscriptions/0E8D0000000T5ZUKA0"
28         },
29         "name": "Gordon Johnson",
30         "photo": {
31            "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhK
32rC7plNhUw5eOz7Aj1u-zWLMxsSybO7lwUPg5_Xne",
33            "largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
34            "photoVersionId": "729D00000000LJLIA2",
35            "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
36            "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0
37cPhKrC7plNhUw5eOz7Aj1u_2Vnyzx4jZ2zFiKBz_sTt2",
38            "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO/photo"
39         },
40         "title": "VP Sales",
41         "type": "User",
42         "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO",
43         "userType": "Internal"
44      }
45   }],
46   "total": 1
47}

Example for POST

This example requests membership in a private group with the ID 0F9D00000000lpK:

1/chatter/groups/0F9D00000000lpK/members/requests

The Group Membership Request response body is in JSON format:

1{
2   "createdDate": "2013-04-02T23:44:25.000Z",
3   "id": "0I5D000000002kOKAQ",
4   "lastUpdateDate": "2013-04-02T23:44:25.000Z",
5   "requestedGroup": {
6      "id": "0F9D00000000lpKKAQ",
7      "url": "/services/data/v38.0/chatter/groups/0F9D00000000lpKKAQ"
8   },
9   "responseMessage": null,
10   "status": "Pending",
11   "url": "/services/data/v38.0/chatter/group-membership-requests/0I5D000000002kOKAQ",
12   "user": {
13      "companyName": "Universal Containers",
14      "firstName": "Gordon",
15      "id": "005D0000001LLO1IAO",
16      "isActive": true,
17      "isInThisCommunity": true,
18      "lastName": "Johnson",
19      "motif": {
20         "color": "1797C0",
21         "largeIconUrl": "/img/icon/profile64.png",
22         "mediumIconUrl": "/img/icon/profile32.png",
23         "smallIconUrl": "/img/icon/profile16.png"
24      },
25      "mySubscription": null,
26      "name": "Gordon Johnson",
27      "photo": {
28         "fullEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-oFL0K-ff2oe04ZAmT2MqC",
29         "largePhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/F",
30         "photoVersionId": "729D00000000LJLIA2",
31         "smallPhotoUrl": "https://instance_name/profilephoto/729D00000000LJL/T",
32         "standardEmailPhotoUrl": "https://instance_name/ncsphoto/SqRfG_-PUTY6KtfOp_f0cPhKrC7plNhUw5eOz7Aj1u-6d5rE2mNaMaBZfGnFX65O",
33         "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO/photo"
34      },
35      "title": "VP Sales",
36      "type": "User",
37      "url": "/services/data/v38.0/chatter/users/005D0000001LLO1IAO",
38      "userType": "Internal"
39   }
40}

Chatter REST API Developer Guide

Group Members—Private

See Also: