Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://domain.com/services/data/v{{version}}/chatter/groups" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set currentPageUrl [CkJsonObject_stringOf $jResp "currentPageUrl"]
set nextPageUrl [CkJsonObject_stringOf $jResp "nextPageUrl"]
set previousPageUrl [CkJsonObject_stringOf $jResp "previousPageUrl"]
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "groups"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set additionalLabel [CkJsonObject_stringOf $jResp "groups[i].additionalLabel"]
set announcement [CkJsonObject_stringOf $jResp "groups[i].announcement"]
set BannerPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].bannerPhoto.bannerPhotoUrl"]
set BannerPhotoVersionId [CkJsonObject_stringOf $jResp "groups[i].bannerPhoto.bannerPhotoVersionId"]
set v_Url [CkJsonObject_stringOf $jResp "groups[i].bannerPhoto.url"]
set canHaveChatterGuests [CkJsonObject_BoolOf $jResp "groups[i].canHaveChatterGuests"]
set community [CkJsonObject_stringOf $jResp "groups[i].community"]
set description [CkJsonObject_stringOf $jResp "groups[i].description"]
set emailToChatterAddress [CkJsonObject_stringOf $jResp "groups[i].emailToChatterAddress"]
set fileCount [CkJsonObject_IntOf $jResp "groups[i].fileCount"]
set id [CkJsonObject_stringOf $jResp "groups[i].id"]
set Text [CkJsonObject_stringOf $jResp "groups[i].information.text"]
set Title [CkJsonObject_stringOf $jResp "groups[i].information.title"]
set isArchived [CkJsonObject_BoolOf $jResp "groups[i].isArchived"]
set isAutoArchiveDisabled [CkJsonObject_BoolOf $jResp "groups[i].isAutoArchiveDisabled"]
set isBroadcast [CkJsonObject_BoolOf $jResp "groups[i].isBroadcast"]
set lastFeedElementPostDate [CkJsonObject_stringOf $jResp "groups[i].lastFeedElementPostDate"]
set memberCount [CkJsonObject_IntOf $jResp "groups[i].memberCount"]
set Color [CkJsonObject_stringOf $jResp "groups[i].motif.color"]
set LargeIconUrl [CkJsonObject_stringOf $jResp "groups[i].motif.largeIconUrl"]
set MediumIconUrl [CkJsonObject_stringOf $jResp "groups[i].motif.mediumIconUrl"]
set SmallIconUrl [CkJsonObject_stringOf $jResp "groups[i].motif.smallIconUrl"]
set SvgIconUrl [CkJsonObject_stringOf $jResp "groups[i].motif.svgIconUrl"]
set myRole [CkJsonObject_stringOf $jResp "groups[i].myRole"]
set Id [CkJsonObject_stringOf $jResp "groups[i].mySubscription.id"]
set mySubscriptionUrl [CkJsonObject_stringOf $jResp "groups[i].mySubscription.url"]
set name [CkJsonObject_stringOf $jResp "groups[i].name"]
set AdditionalLabel [CkJsonObject_stringOf $jResp "groups[i].owner.additionalLabel"]
set CommunityNickname [CkJsonObject_stringOf $jResp "groups[i].owner.communityNickname"]
set CompanyName [CkJsonObject_stringOf $jResp "groups[i].owner.companyName"]
set DisplayName [CkJsonObject_stringOf $jResp "groups[i].owner.displayName"]
set FirstName [CkJsonObject_stringOf $jResp "groups[i].owner.firstName"]
set ownerId [CkJsonObject_stringOf $jResp "groups[i].owner.id"]
set IsActive [CkJsonObject_BoolOf $jResp "groups[i].owner.isActive"]
set IsInThisCommunity [CkJsonObject_BoolOf $jResp "groups[i].owner.isInThisCommunity"]
set LastName [CkJsonObject_stringOf $jResp "groups[i].owner.lastName"]
set MotifColor [CkJsonObject_stringOf $jResp "groups[i].owner.motif.color"]
set MotifLargeIconUrl [CkJsonObject_stringOf $jResp "groups[i].owner.motif.largeIconUrl"]
set MotifMediumIconUrl [CkJsonObject_stringOf $jResp "groups[i].owner.motif.mediumIconUrl"]
set MotifSmallIconUrl [CkJsonObject_stringOf $jResp "groups[i].owner.motif.smallIconUrl"]
set MotifSvgIconUrl [CkJsonObject_stringOf $jResp "groups[i].owner.motif.svgIconUrl"]
set MySubscription [CkJsonObject_stringOf $jResp "groups[i].owner.mySubscription"]
set Name [CkJsonObject_stringOf $jResp "groups[i].owner.name"]
set Message [CkJsonObject_stringOf $jResp "groups[i].owner.outOfOffice.message"]
set FullEmailPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.fullEmailPhotoUrl"]
set LargePhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.largePhotoUrl"]
set MediumPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.mediumPhotoUrl"]
set PhotoVersionId [CkJsonObject_stringOf $jResp "groups[i].owner.photo.photoVersionId"]
set SmallPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.smallPhotoUrl"]
set StandardEmailPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.standardEmailPhotoUrl"]
set PhotoUrl [CkJsonObject_stringOf $jResp "groups[i].owner.photo.url"]
set Reputation [CkJsonObject_stringOf $jResp "groups[i].owner.reputation"]
set ownerTitle [CkJsonObject_stringOf $jResp "groups[i].owner.title"]
set v_Type [CkJsonObject_stringOf $jResp "groups[i].owner.type"]
set ownerUrl [CkJsonObject_stringOf $jResp "groups[i].owner.url"]
set UserType [CkJsonObject_stringOf $jResp "groups[i].owner.userType"]
set pendingRequests [CkJsonObject_stringOf $jResp "groups[i].pendingRequests"]
set photoFullEmailPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.fullEmailPhotoUrl"]
set photoLargePhotoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.largePhotoUrl"]
set photoMediumPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.mediumPhotoUrl"]
set photoPhotoVersionId [CkJsonObject_stringOf $jResp "groups[i].photo.photoVersionId"]
set photoSmallPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.smallPhotoUrl"]
set photoStandardEmailPhotoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.standardEmailPhotoUrl"]
set photoUrl [CkJsonObject_stringOf $jResp "groups[i].photo.url"]
set v_type [CkJsonObject_stringOf $jResp "groups[i].type"]
set url [CkJsonObject_stringOf $jResp "groups[i].url"]
set visibility [CkJsonObject_stringOf $jResp "groups[i].visibility"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}
