Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")
sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",sbResponseBody)
if (success == false)
print http.lastErrorText() + "\n";
exit
end
jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)
print "Response Body:" + "\n";
print jResp.emit() + "\n";
respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
print "Response Header:" + "\n";
print http.lastHeader() + "\n";
print "Failed." + "\n";
exit
end
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "requests": [
# {
# "createdDate": "2023-11-22T11:46:32.000Z",
# "id": "0I5...",
# "lastUpdateDate": "2023-11-22T11:46:32.000Z",
# "requestedGroup": {
# "id": "0F9...",
# "url": "/services/data/v58.0/chatter/groups/0F9..."
# },
# "responseMessage": null,
# "status": "Pending",
# "url": "/services/data/v58.0/chatter/group-membership-requests/0I5...",
# "user": {
# "additionalLabel": null,
# "communityNickname": "User1700653511864742682",
# "companyName": null,
# "displayName": "User Sample",
# "firstName": "User",
# "id": "005...",
# "isActive": true,
# "isInThisCommunity": true,
# "lastName": "Sample",
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/profile64.png",
# "mediumIconUrl": "/img/icon/profile32.png",
# "smallIconUrl": "/img/icon/profile16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "User Sample",
# "outOfOffice": {
# "message": ""
# },
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/005/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/005/M",
# "photoVersionId": null,
# "smallPhotoUrl": "https://<my_domain>/profilephoto/005/T",
# "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1",
# "url": "/services/data/v58.0/connect/user-profiles/005.../photo"
# },
# "reputation": null,
# "title": null,
# "type": "User",
# "url": "/services/data/v58.0/chatter/users/005...",
# "userType": "Internal"
# }
# }
# ],
# "total": null
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
total = jResp.stringOf("total")
i = 0
count_i = jResp.SizeOfArray("requests")
while i < count_i
jResp.put_I(i)
createdDate = jResp.stringOf("requests[i].createdDate")
id = jResp.stringOf("requests[i].id")
lastUpdateDate = jResp.stringOf("requests[i].lastUpdateDate")
Id = jResp.stringOf("requests[i].requestedGroup.id")
v_Url = jResp.stringOf("requests[i].requestedGroup.url")
responseMessage = jResp.stringOf("requests[i].responseMessage")
status = jResp.stringOf("requests[i].status")
url = jResp.stringOf("requests[i].url")
AdditionalLabel = jResp.stringOf("requests[i].user.additionalLabel")
CommunityNickname = jResp.stringOf("requests[i].user.communityNickname")
CompanyName = jResp.stringOf("requests[i].user.companyName")
DisplayName = jResp.stringOf("requests[i].user.displayName")
FirstName = jResp.stringOf("requests[i].user.firstName")
userId = jResp.stringOf("requests[i].user.id")
IsActive = jResp.BoolOf("requests[i].user.isActive")
IsInThisCommunity = jResp.BoolOf("requests[i].user.isInThisCommunity")
LastName = jResp.stringOf("requests[i].user.lastName")
Color = jResp.stringOf("requests[i].user.motif.color")
LargeIconUrl = jResp.stringOf("requests[i].user.motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("requests[i].user.motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("requests[i].user.motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("requests[i].user.motif.svgIconUrl")
MySubscription = jResp.stringOf("requests[i].user.mySubscription")
Name = jResp.stringOf("requests[i].user.name")
Message = jResp.stringOf("requests[i].user.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("requests[i].user.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("requests[i].user.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("requests[i].user.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("requests[i].user.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("requests[i].user.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("requests[i].user.photo.standardEmailPhotoUrl")
PhotoUrl = jResp.stringOf("requests[i].user.photo.url")
Reputation = jResp.stringOf("requests[i].user.reputation")
Title = jResp.stringOf("requests[i].user.title")
v_Type = jResp.stringOf("requests[i].user.type")
userUrl = jResp.stringOf("requests[i].user.url")
UserType = jResp.stringOf("requests[i].user.userType")
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests
Postman Collection Item JSON
{
"name": "Group Members—Private",
"event": [
{
"listen": "prerequest",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
},
{
"listen": "test",
"script": {
"exec": [
""
],
"type": "text/javascript"
}
}
],
"protocolProfileBehavior": {
"disabledSystemHeaders": {}
},
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members",
"requests"
],
"query": [
{
"key": "status",
"value": "Accepted",
"description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending",
"disabled": true
}
],
"variable": [
{
"key": "GROUP_ID",
"value": "0F9..."
}
]
},
"description": "Request membership in a private group or get the status of requests to a join a private group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_GroupMembersRequests.htm"
},
"response": [
{
"name": "Successful Group Members—Private",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups/:GROUP_ID/members/requests",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups",
":GROUP_ID",
"members",
"requests"
],
"query": [
{
"key": "status",
"value": "Accepted",
"description": "Optional. If you include this parameter, results are filtered to include those that match the specified status. Valid values:\nAccepted\nDeclined\nPending",
"disabled": true
}
],
"variable": [
{
"key": "GROUP_ID",
"value": "0F9..."
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:47:04 GMT"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=63072000; includeSubDomains"
},
{
"key": "X-Content-Type-Options",
"value": "nosniff"
},
{
"key": "X-XSS-Protection",
"value": "1; mode=block"
},
{
"key": "X-Robots-Tag",
"value": "none"
},
{
"key": "Cache-Control",
"value": "no-cache,must-revalidate,max-age=0,no-store,private"
},
{
"key": "Content-Type",
"value": "application/json;charset=UTF-8"
},
{
"key": "Vary",
"value": "Accept-Encoding"
},
{
"key": "Content-Encoding",
"value": "gzip"
},
{
"key": "Transfer-Encoding",
"value": "chunked"
}
],
"cookie": [
],
"body": "{\n \"requests\": [\n {\n \"createdDate\": \"2023-11-22T11:46:32.000Z\",\n \"id\": \"0I5...\",\n \"lastUpdateDate\": \"2023-11-22T11:46:32.000Z\",\n \"requestedGroup\": {\n \"id\": \"0F9...\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\"\n },\n \"responseMessage\": null,\n \"status\": \"Pending\",\n \"url\": \"/services/data/v58.0/chatter/group-membership-requests/0I5...\",\n \"user\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1700653511864742682\",\n \"companyName\": null,\n \"displayName\": \"User Sample\",\n \"firstName\": \"User\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Sample\",\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/profile64.png\",\n \"mediumIconUrl\": \"/img/icon/profile32.png\",\n \"smallIconUrl\": \"/img/icon/profile16.png\",\n \"svgIconUrl\": null\n },\n \"mySubscription\": null,\n \"name\": \"User Sample\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/005/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/005/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/005/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/connect/user-profiles/005.../photo\"\n },\n \"reputation\": null,\n \"title\": null,\n \"type\": \"User\",\n \"url\": \"/services/data/v58.0/chatter/users/005...\",\n \"userType\": \"Internal\"\n }\n }\n ],\n \"total\": null\n}"
}
]
}
