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",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)
# {
# "currentPageUrl": "/services/data/v58.0/chatter/groups",
# "groups": [
# {
# "additionalLabel": null,
# "announcement": null,
# "bannerPhoto": {
# "bannerPhotoUrl": "https://<my_domain>/profilephoto/0F9/B",
# "bannerPhotoVersionId": null,
# "url": "/services/data/v58.0/chatter/groups/0F9.../banner-photo"
# },
# "canHaveChatterGuests": false,
# "community": null,
# "description": "Test group",
# "emailToChatterAddress": "0F9...@post.2o-i6mbeaq.eu25.chatter.salesforce.com",
# "fileCount": 0,
# "id": "0F9...",
# "information": {
# "text": null,
# "title": null
# },
# "isArchived": false,
# "isAutoArchiveDisabled": false,
# "isBroadcast": false,
# "lastFeedElementPostDate": "2023-11-22T11:25:37.000Z",
# "memberCount": 1,
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/groups64.png",
# "mediumIconUrl": "/img/icon/groups32.png",
# "smallIconUrl": "/img/icon/groups16.png",
# "svgIconUrl": null
# },
# "myRole": "GroupOwner",
# "mySubscription": {
# "id": "0FB...",
# "url": "/services/data/v58.0/chatter/group-memberships/0FB..."
# },
# "name": "Test",
# "owner": {
# "additionalLabel": null,
# "communityNickname": "User1696423780773910041",
# "companyName": "Salesforce",
# "displayName": "Firstname",
# "firstName": "Firstname",
# "id": "005...",
# "isActive": true,
# "isInThisCommunity": true,
# "lastName": "Name",
# "motif": {
# "color": "1B96FF",
# "largeIconUrl": "/img/icon/profile64.png",
# "mediumIconUrl": "/img/icon/profile32.png",
# "smallIconUrl": "/img/icon/profile16.png",
# "svgIconUrl": null
# },
# "mySubscription": null,
# "name": "Firstname",
# "outOfOffice": {
# "message": ""
# },
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/M",
# "photoVersionId": "729...",
# "smallPhotoUrl": "https://<my_domain>/profilephoto/7292o000000oAgZ/T",
# "standardEmailPhotoUrl": "https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?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"
# },
# "pendingRequests": null,
# "photo": {
# "fullEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_group_profile_200_v2.png?fromEmail=1",
# "largePhotoUrl": "https://<my_domain>/profilephoto/0F9/F",
# "mediumPhotoUrl": "https://<my_domain>/profilephoto/0F9/M",
# "photoVersionId": null,
# "smallPhotoUrl": "https://<my_domain>/profilephoto/0F9/T",
# "standardEmailPhotoUrl": "https://<my_domain>/img/userprofile/default_group_profile_45_v2.png?fromEmail=1",
# "url": "/services/data/v58.0/chatter/groups/0F9.../photo"
# },
# "type": "CollaborationGroup",
# "url": "/services/data/v58.0/chatter/groups/0F9...",
# "visibility": "PublicAccess"
# }
# ],
# "nextPageUrl": null,
# "previousPageUrl": null
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
currentPageUrl = jResp.stringOf("currentPageUrl")
nextPageUrl = jResp.stringOf("nextPageUrl")
previousPageUrl = jResp.stringOf("previousPageUrl")
i = 0
count_i = jResp.SizeOfArray("groups")
while i < count_i
jResp.put_I(i)
additionalLabel = jResp.stringOf("groups[i].additionalLabel")
announcement = jResp.stringOf("groups[i].announcement")
BannerPhotoUrl = jResp.stringOf("groups[i].bannerPhoto.bannerPhotoUrl")
BannerPhotoVersionId = jResp.stringOf("groups[i].bannerPhoto.bannerPhotoVersionId")
v_Url = jResp.stringOf("groups[i].bannerPhoto.url")
canHaveChatterGuests = jResp.BoolOf("groups[i].canHaveChatterGuests")
community = jResp.stringOf("groups[i].community")
description = jResp.stringOf("groups[i].description")
emailToChatterAddress = jResp.stringOf("groups[i].emailToChatterAddress")
fileCount = jResp.IntOf("groups[i].fileCount")
id = jResp.stringOf("groups[i].id")
Text = jResp.stringOf("groups[i].information.text")
Title = jResp.stringOf("groups[i].information.title")
isArchived = jResp.BoolOf("groups[i].isArchived")
isAutoArchiveDisabled = jResp.BoolOf("groups[i].isAutoArchiveDisabled")
isBroadcast = jResp.BoolOf("groups[i].isBroadcast")
lastFeedElementPostDate = jResp.stringOf("groups[i].lastFeedElementPostDate")
memberCount = jResp.IntOf("groups[i].memberCount")
Color = jResp.stringOf("groups[i].motif.color")
LargeIconUrl = jResp.stringOf("groups[i].motif.largeIconUrl")
MediumIconUrl = jResp.stringOf("groups[i].motif.mediumIconUrl")
SmallIconUrl = jResp.stringOf("groups[i].motif.smallIconUrl")
SvgIconUrl = jResp.stringOf("groups[i].motif.svgIconUrl")
myRole = jResp.stringOf("groups[i].myRole")
Id = jResp.stringOf("groups[i].mySubscription.id")
mySubscriptionUrl = jResp.stringOf("groups[i].mySubscription.url")
name = jResp.stringOf("groups[i].name")
AdditionalLabel = jResp.stringOf("groups[i].owner.additionalLabel")
CommunityNickname = jResp.stringOf("groups[i].owner.communityNickname")
CompanyName = jResp.stringOf("groups[i].owner.companyName")
DisplayName = jResp.stringOf("groups[i].owner.displayName")
FirstName = jResp.stringOf("groups[i].owner.firstName")
ownerId = jResp.stringOf("groups[i].owner.id")
IsActive = jResp.BoolOf("groups[i].owner.isActive")
IsInThisCommunity = jResp.BoolOf("groups[i].owner.isInThisCommunity")
LastName = jResp.stringOf("groups[i].owner.lastName")
MotifColor = jResp.stringOf("groups[i].owner.motif.color")
MotifLargeIconUrl = jResp.stringOf("groups[i].owner.motif.largeIconUrl")
MotifMediumIconUrl = jResp.stringOf("groups[i].owner.motif.mediumIconUrl")
MotifSmallIconUrl = jResp.stringOf("groups[i].owner.motif.smallIconUrl")
MotifSvgIconUrl = jResp.stringOf("groups[i].owner.motif.svgIconUrl")
MySubscription = jResp.stringOf("groups[i].owner.mySubscription")
Name = jResp.stringOf("groups[i].owner.name")
Message = jResp.stringOf("groups[i].owner.outOfOffice.message")
FullEmailPhotoUrl = jResp.stringOf("groups[i].owner.photo.fullEmailPhotoUrl")
LargePhotoUrl = jResp.stringOf("groups[i].owner.photo.largePhotoUrl")
MediumPhotoUrl = jResp.stringOf("groups[i].owner.photo.mediumPhotoUrl")
PhotoVersionId = jResp.stringOf("groups[i].owner.photo.photoVersionId")
SmallPhotoUrl = jResp.stringOf("groups[i].owner.photo.smallPhotoUrl")
StandardEmailPhotoUrl = jResp.stringOf("groups[i].owner.photo.standardEmailPhotoUrl")
PhotoUrl = jResp.stringOf("groups[i].owner.photo.url")
Reputation = jResp.stringOf("groups[i].owner.reputation")
ownerTitle = jResp.stringOf("groups[i].owner.title")
v_Type = jResp.stringOf("groups[i].owner.type")
ownerUrl = jResp.stringOf("groups[i].owner.url")
UserType = jResp.stringOf("groups[i].owner.userType")
pendingRequests = jResp.stringOf("groups[i].pendingRequests")
photoFullEmailPhotoUrl = jResp.stringOf("groups[i].photo.fullEmailPhotoUrl")
photoLargePhotoUrl = jResp.stringOf("groups[i].photo.largePhotoUrl")
photoMediumPhotoUrl = jResp.stringOf("groups[i].photo.mediumPhotoUrl")
photoPhotoVersionId = jResp.stringOf("groups[i].photo.photoVersionId")
photoSmallPhotoUrl = jResp.stringOf("groups[i].photo.smallPhotoUrl")
photoStandardEmailPhotoUrl = jResp.stringOf("groups[i].photo.standardEmailPhotoUrl")
photoUrl = jResp.stringOf("groups[i].photo.url")
v_type = jResp.stringOf("groups[i].type")
url = jResp.stringOf("groups[i].url")
visibility = jResp.stringOf("groups[i].visibility")
i = i + 1
end
Curl Command
curl -X GET
-H "Authorization: Bearer <access_token>"
https://domain.com/services/data/v{{version}}/chatter/groups
Postman Collection Item JSON
{
"name": "List of Groups",
"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",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups"
]
},
"description": "A list of all the groups in the organization. Get information about groups or create a group.\n\nhttps://developer.salesforce.com/docs/atlas.en-us.chatterapi.meta/chatterapi/connect_resources_groups_ListOfGroups.htm"
},
"response": [
{
"name": "Successful List of Groups",
"originalRequest": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/chatter/groups",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"chatter",
"groups"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Date",
"value": "Wed, 22 Nov 2023 11:25:52 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 \"currentPageUrl\": \"/services/data/v58.0/chatter/groups\",\n \"groups\": [\n {\n \"additionalLabel\": null,\n \"announcement\": null,\n \"bannerPhoto\": {\n \"bannerPhotoUrl\": \"https://<my_domain>/profilephoto/0F9/B\",\n \"bannerPhotoVersionId\": null,\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../banner-photo\"\n },\n \"canHaveChatterGuests\": false,\n \"community\": null,\n \"description\": \"Test group\",\n \"emailToChatterAddress\": \"0F9...@post.2o-i6mbeaq.eu25.chatter.salesforce.com\",\n \"fileCount\": 0,\n \"id\": \"0F9...\",\n \"information\": {\n \"text\": null,\n \"title\": null\n },\n \"isArchived\": false,\n \"isAutoArchiveDisabled\": false,\n \"isBroadcast\": false,\n \"lastFeedElementPostDate\": \"2023-11-22T11:25:37.000Z\",\n \"memberCount\": 1,\n \"motif\": {\n \"color\": \"1B96FF\",\n \"largeIconUrl\": \"/img/icon/groups64.png\",\n \"mediumIconUrl\": \"/img/icon/groups32.png\",\n \"smallIconUrl\": \"/img/icon/groups16.png\",\n \"svgIconUrl\": null\n },\n \"myRole\": \"GroupOwner\",\n \"mySubscription\": {\n \"id\": \"0FB...\",\n \"url\": \"/services/data/v58.0/chatter/group-memberships/0FB...\"\n },\n \"name\": \"Test\",\n \"owner\": {\n \"additionalLabel\": null,\n \"communityNickname\": \"User1696423780773910041\",\n \"companyName\": \"Salesforce\",\n \"displayName\": \"Firstname\",\n \"firstName\": \"Firstname\",\n \"id\": \"005...\",\n \"isActive\": true,\n \"isInThisCommunity\": true,\n \"lastName\": \"Name\",\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\": \"Firstname\",\n \"outOfOffice\": {\n \"message\": \"\"\n },\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0IogXzXAXaYKJnuWCNQmXymRq?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/M\",\n \"photoVersionId\": \"729...\",\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/7292o000000oAgZ/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/ncsphoto/1wsMlOd3tVC7boygqBO8wMT9KzA0D6tqzpbs-Uw0Ioi-dtynkoFWsl46as__TDFU?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 \"pendingRequests\": null,\n \"photo\": {\n \"fullEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_group_profile_200_v2.png?fromEmail=1\",\n \"largePhotoUrl\": \"https://<my_domain>/profilephoto/0F9/F\",\n \"mediumPhotoUrl\": \"https://<my_domain>/profilephoto/0F9/M\",\n \"photoVersionId\": null,\n \"smallPhotoUrl\": \"https://<my_domain>/profilephoto/0F9/T\",\n \"standardEmailPhotoUrl\": \"https://<my_domain>/img/userprofile/default_group_profile_45_v2.png?fromEmail=1\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9.../photo\"\n },\n \"type\": \"CollaborationGroup\",\n \"url\": \"/services/data/v58.0/chatter/groups/0F9...\",\n \"visibility\": \"PublicAccess\"\n }\n ],\n \"nextPageUrl\": null,\n \"previousPageUrl\": null\n}"
}
]
}
