Back to Collection Items
Use ChilkatAx-win32.pkg
Procedure Test
Handle hoHttp
Boolean iSuccess
Variant vSbResponseBody
Handle hoSbResponseBody
Handle hoJResp
Integer iRespStatusCode
String sAdditionalLabel
String sAnnouncement
String sBannerPhotoUrl
String sBannerPhotoVersionId
String sV_Url
Boolean iCanHaveChatterGuests
String sCommunity
String sDescription
String sEmailToChatterAddress
Integer iFileCount
String sId
String sText
String sTitle
Boolean iIsArchived
Boolean iIsAutoArchiveDisabled
Boolean iIsBroadcast
String sLastFeedElementPostDate
Integer iMemberCount
String sColor
String sLargeIconUrl
String sMediumIconUrl
String sSmallIconUrl
String sSvgIconUrl
String sMyRole
String sId
String sMySubscriptionUrl
String sName
String sAdditionalLabel
String sCommunityNickname
String sCompanyName
String sDisplayName
String sFirstName
String sOwnerId
Boolean iIsActive
Boolean iIsInThisCommunity
String sLastName
String sMotifColor
String sMotifLargeIconUrl
String sMotifMediumIconUrl
String sMotifSmallIconUrl
String sMotifSvgIconUrl
String sMySubscription
String sName
String sMessage
String sFullEmailPhotoUrl
String sLargePhotoUrl
String sMediumPhotoUrl
String sPhotoVersionId
String sSmallPhotoUrl
String sStandardEmailPhotoUrl
String sPhotoUrl
String sReputation
String sOwnerTitle
String sV_Type
String sOwnerUrl
String sUserType
String sPendingRequests
String sPhotoFullEmailPhotoUrl
String sPhotoLargePhotoUrl
String sPhotoMediumPhotoUrl
String sPhotoPhotoVersionId
String sPhotoSmallPhotoUrl
String sPhotoStandardEmailPhotoUrl
String sPhotoUrl
String sV_type
String sUrl
String sVisibility
String sCurrentPageUrl
String sNextPageUrl
String sPreviousPageUrl
Integer i
Integer iCount_i
String sTemp1
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
Get Create (RefClass(cComChilkatHttp)) To hoHttp
If (Not(IsComObjectCreated(hoHttp))) Begin
Send CreateComObject of hoHttp
End
// Adds the "Authorization: Bearer <access_token>" header.
Set ComAuthToken Of hoHttp To "<access_token>"
Get Create (RefClass(cComChilkatStringBuilder)) To hoSbResponseBody
If (Not(IsComObjectCreated(hoSbResponseBody))) Begin
Send CreateComObject of hoSbResponseBody
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComQuickGetSb Of hoHttp "https://domain.com/services/data/v{{version}}/chatter/groups" vSbResponseBody To iSuccess
If (iSuccess = False) Begin
Get ComLastErrorText Of hoHttp To sTemp1
Showln sTemp1
Procedure_Return
End
Get Create (RefClass(cComChilkatJsonObject)) To hoJResp
If (Not(IsComObjectCreated(hoJResp))) Begin
Send CreateComObject of hoJResp
End
Get pvComObject of hoSbResponseBody to vSbResponseBody
Get ComLoadSb Of hoJResp vSbResponseBody To iSuccess
Set ComEmitCompact Of hoJResp To False
Showln "Response Body:"
Get ComEmit Of hoJResp To sTemp1
Showln sTemp1
Get ComLastStatus Of hoHttp To iRespStatusCode
Showln "Response Status Code = " iRespStatusCode
If (iRespStatusCode >= 400) Begin
Showln "Response Header:"
Get ComLastHeader Of hoHttp To sTemp1
Showln sTemp1
Showln "Failed."
Procedure_Return
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
Get ComStringOf Of hoJResp "currentPageUrl" To sCurrentPageUrl
Get ComStringOf Of hoJResp "nextPageUrl" To sNextPageUrl
Get ComStringOf Of hoJResp "previousPageUrl" To sPreviousPageUrl
Move 0 To i
Get ComSizeOfArray Of hoJResp "groups" To iCount_i
While (i < iCount_i)
Set ComI Of hoJResp To i
Get ComStringOf Of hoJResp "groups[i].additionalLabel" To sAdditionalLabel
Get ComStringOf Of hoJResp "groups[i].announcement" To sAnnouncement
Get ComStringOf Of hoJResp "groups[i].bannerPhoto.bannerPhotoUrl" To sBannerPhotoUrl
Get ComStringOf Of hoJResp "groups[i].bannerPhoto.bannerPhotoVersionId" To sBannerPhotoVersionId
Get ComStringOf Of hoJResp "groups[i].bannerPhoto.url" To sV_Url
Get ComBoolOf Of hoJResp "groups[i].canHaveChatterGuests" To iCanHaveChatterGuests
Get ComStringOf Of hoJResp "groups[i].community" To sCommunity
Get ComStringOf Of hoJResp "groups[i].description" To sDescription
Get ComStringOf Of hoJResp "groups[i].emailToChatterAddress" To sEmailToChatterAddress
Get ComIntOf Of hoJResp "groups[i].fileCount" To iFileCount
Get ComStringOf Of hoJResp "groups[i].id" To sId
Get ComStringOf Of hoJResp "groups[i].information.text" To sText
Get ComStringOf Of hoJResp "groups[i].information.title" To sTitle
Get ComBoolOf Of hoJResp "groups[i].isArchived" To iIsArchived
Get ComBoolOf Of hoJResp "groups[i].isAutoArchiveDisabled" To iIsAutoArchiveDisabled
Get ComBoolOf Of hoJResp "groups[i].isBroadcast" To iIsBroadcast
Get ComStringOf Of hoJResp "groups[i].lastFeedElementPostDate" To sLastFeedElementPostDate
Get ComIntOf Of hoJResp "groups[i].memberCount" To iMemberCount
Get ComStringOf Of hoJResp "groups[i].motif.color" To sColor
Get ComStringOf Of hoJResp "groups[i].motif.largeIconUrl" To sLargeIconUrl
Get ComStringOf Of hoJResp "groups[i].motif.mediumIconUrl" To sMediumIconUrl
Get ComStringOf Of hoJResp "groups[i].motif.smallIconUrl" To sSmallIconUrl
Get ComStringOf Of hoJResp "groups[i].motif.svgIconUrl" To sSvgIconUrl
Get ComStringOf Of hoJResp "groups[i].myRole" To sMyRole
Get ComStringOf Of hoJResp "groups[i].mySubscription.id" To sId
Get ComStringOf Of hoJResp "groups[i].mySubscription.url" To sMySubscriptionUrl
Get ComStringOf Of hoJResp "groups[i].name" To sName
Get ComStringOf Of hoJResp "groups[i].owner.additionalLabel" To sAdditionalLabel
Get ComStringOf Of hoJResp "groups[i].owner.communityNickname" To sCommunityNickname
Get ComStringOf Of hoJResp "groups[i].owner.companyName" To sCompanyName
Get ComStringOf Of hoJResp "groups[i].owner.displayName" To sDisplayName
Get ComStringOf Of hoJResp "groups[i].owner.firstName" To sFirstName
Get ComStringOf Of hoJResp "groups[i].owner.id" To sOwnerId
Get ComBoolOf Of hoJResp "groups[i].owner.isActive" To iIsActive
Get ComBoolOf Of hoJResp "groups[i].owner.isInThisCommunity" To iIsInThisCommunity
Get ComStringOf Of hoJResp "groups[i].owner.lastName" To sLastName
Get ComStringOf Of hoJResp "groups[i].owner.motif.color" To sMotifColor
Get ComStringOf Of hoJResp "groups[i].owner.motif.largeIconUrl" To sMotifLargeIconUrl
Get ComStringOf Of hoJResp "groups[i].owner.motif.mediumIconUrl" To sMotifMediumIconUrl
Get ComStringOf Of hoJResp "groups[i].owner.motif.smallIconUrl" To sMotifSmallIconUrl
Get ComStringOf Of hoJResp "groups[i].owner.motif.svgIconUrl" To sMotifSvgIconUrl
Get ComStringOf Of hoJResp "groups[i].owner.mySubscription" To sMySubscription
Get ComStringOf Of hoJResp "groups[i].owner.name" To sName
Get ComStringOf Of hoJResp "groups[i].owner.outOfOffice.message" To sMessage
Get ComStringOf Of hoJResp "groups[i].owner.photo.fullEmailPhotoUrl" To sFullEmailPhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.photo.largePhotoUrl" To sLargePhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.photo.mediumPhotoUrl" To sMediumPhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.photo.photoVersionId" To sPhotoVersionId
Get ComStringOf Of hoJResp "groups[i].owner.photo.smallPhotoUrl" To sSmallPhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.photo.standardEmailPhotoUrl" To sStandardEmailPhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.photo.url" To sPhotoUrl
Get ComStringOf Of hoJResp "groups[i].owner.reputation" To sReputation
Get ComStringOf Of hoJResp "groups[i].owner.title" To sOwnerTitle
Get ComStringOf Of hoJResp "groups[i].owner.type" To sV_Type
Get ComStringOf Of hoJResp "groups[i].owner.url" To sOwnerUrl
Get ComStringOf Of hoJResp "groups[i].owner.userType" To sUserType
Get ComStringOf Of hoJResp "groups[i].pendingRequests" To sPendingRequests
Get ComStringOf Of hoJResp "groups[i].photo.fullEmailPhotoUrl" To sPhotoFullEmailPhotoUrl
Get ComStringOf Of hoJResp "groups[i].photo.largePhotoUrl" To sPhotoLargePhotoUrl
Get ComStringOf Of hoJResp "groups[i].photo.mediumPhotoUrl" To sPhotoMediumPhotoUrl
Get ComStringOf Of hoJResp "groups[i].photo.photoVersionId" To sPhotoPhotoVersionId
Get ComStringOf Of hoJResp "groups[i].photo.smallPhotoUrl" To sPhotoSmallPhotoUrl
Get ComStringOf Of hoJResp "groups[i].photo.standardEmailPhotoUrl" To sPhotoStandardEmailPhotoUrl
Get ComStringOf Of hoJResp "groups[i].photo.url" To sPhotoUrl
Get ComStringOf Of hoJResp "groups[i].type" To sV_type
Get ComStringOf Of hoJResp "groups[i].url" To sUrl
Get ComStringOf Of hoJResp "groups[i].visibility" To sVisibility
Move (i + 1) To i
Loop
End_Procedure
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}"
}
]
}
