Back to Collection Items
var
http: HCkHttp;
success: Boolean;
sbResponseBody: HCkStringBuilder;
jResp: HCkJsonObject;
respStatusCode: Integer;
additionalLabel: PWideChar;
announcement: PWideChar;
BannerPhotoUrl: PWideChar;
BannerPhotoVersionId: PWideChar;
v_Url: PWideChar;
canHaveChatterGuests: Boolean;
community: PWideChar;
description: PWideChar;
emailToChatterAddress: PWideChar;
fileCount: Integer;
id: PWideChar;
Text: PWideChar;
Title: PWideChar;
isArchived: Boolean;
isAutoArchiveDisabled: Boolean;
isBroadcast: Boolean;
lastFeedElementPostDate: PWideChar;
memberCount: Integer;
Color: PWideChar;
LargeIconUrl: PWideChar;
MediumIconUrl: PWideChar;
SmallIconUrl: PWideChar;
SvgIconUrl: PWideChar;
myRole: PWideChar;
Id: PWideChar;
mySubscriptionUrl: PWideChar;
name: PWideChar;
AdditionalLabel: PWideChar;
CommunityNickname: PWideChar;
CompanyName: PWideChar;
DisplayName: PWideChar;
FirstName: PWideChar;
ownerId: PWideChar;
IsActive: Boolean;
IsInThisCommunity: Boolean;
LastName: PWideChar;
MotifColor: PWideChar;
MotifLargeIconUrl: PWideChar;
MotifMediumIconUrl: PWideChar;
MotifSmallIconUrl: PWideChar;
MotifSvgIconUrl: PWideChar;
MySubscription: PWideChar;
Name: PWideChar;
Message: PWideChar;
FullEmailPhotoUrl: PWideChar;
LargePhotoUrl: PWideChar;
MediumPhotoUrl: PWideChar;
PhotoVersionId: PWideChar;
SmallPhotoUrl: PWideChar;
StandardEmailPhotoUrl: PWideChar;
PhotoUrl: PWideChar;
Reputation: PWideChar;
ownerTitle: PWideChar;
v_Type: PWideChar;
ownerUrl: PWideChar;
UserType: PWideChar;
pendingRequests: PWideChar;
photoFullEmailPhotoUrl: PWideChar;
photoLargePhotoUrl: PWideChar;
photoMediumPhotoUrl: PWideChar;
photoPhotoVersionId: PWideChar;
photoSmallPhotoUrl: PWideChar;
photoStandardEmailPhotoUrl: PWideChar;
photoUrl: PWideChar;
v_type: PWideChar;
url: PWideChar;
visibility: PWideChar;
currentPageUrl: PWideChar;
nextPageUrl: PWideChar;
previousPageUrl: PWideChar;
i: Integer;
count_i: Integer;
begin
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
http := CkHttp_Create();
// Adds the "Authorization: Bearer <access_token>" header.
CkHttp_putAuthToken(http,'<access_token>');
sbResponseBody := CkStringBuilder_Create();
success := CkHttp_QuickGetSb(http,'https://domain.com/services/data/v{{version}}/chatter/groups',sbResponseBody);
if (success = False) then
begin
Memo1.Lines.Add(CkHttp__lastErrorText(http));
Exit;
end;
jResp := CkJsonObject_Create();
CkJsonObject_LoadSb(jResp,sbResponseBody);
CkJsonObject_putEmitCompact(jResp,False);
Memo1.Lines.Add('Response Body:');
Memo1.Lines.Add(CkJsonObject__emit(jResp));
respStatusCode := CkHttp_getLastStatus(http);
Memo1.Lines.Add('Response Status Code = ' + IntToStr(respStatusCode));
if (respStatusCode >= 400) then
begin
Memo1.Lines.Add('Response Header:');
Memo1.Lines.Add(CkHttp__lastHeader(http));
Memo1.Lines.Add('Failed.');
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 := CkJsonObject__stringOf(jResp,'currentPageUrl');
nextPageUrl := CkJsonObject__stringOf(jResp,'nextPageUrl');
previousPageUrl := CkJsonObject__stringOf(jResp,'previousPageUrl');
i := 0;
count_i := CkJsonObject_SizeOfArray(jResp,'groups');
while i < count_i do
begin
CkJsonObject_putI(jResp,i);
additionalLabel := CkJsonObject__stringOf(jResp,'groups[i].additionalLabel');
announcement := CkJsonObject__stringOf(jResp,'groups[i].announcement');
BannerPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].bannerPhoto.bannerPhotoUrl');
BannerPhotoVersionId := CkJsonObject__stringOf(jResp,'groups[i].bannerPhoto.bannerPhotoVersionId');
v_Url := CkJsonObject__stringOf(jResp,'groups[i].bannerPhoto.url');
canHaveChatterGuests := CkJsonObject_BoolOf(jResp,'groups[i].canHaveChatterGuests');
community := CkJsonObject__stringOf(jResp,'groups[i].community');
description := CkJsonObject__stringOf(jResp,'groups[i].description');
emailToChatterAddress := CkJsonObject__stringOf(jResp,'groups[i].emailToChatterAddress');
fileCount := CkJsonObject_IntOf(jResp,'groups[i].fileCount');
id := CkJsonObject__stringOf(jResp,'groups[i].id');
Text := CkJsonObject__stringOf(jResp,'groups[i].information.text');
Title := CkJsonObject__stringOf(jResp,'groups[i].information.title');
isArchived := CkJsonObject_BoolOf(jResp,'groups[i].isArchived');
isAutoArchiveDisabled := CkJsonObject_BoolOf(jResp,'groups[i].isAutoArchiveDisabled');
isBroadcast := CkJsonObject_BoolOf(jResp,'groups[i].isBroadcast');
lastFeedElementPostDate := CkJsonObject__stringOf(jResp,'groups[i].lastFeedElementPostDate');
memberCount := CkJsonObject_IntOf(jResp,'groups[i].memberCount');
Color := CkJsonObject__stringOf(jResp,'groups[i].motif.color');
LargeIconUrl := CkJsonObject__stringOf(jResp,'groups[i].motif.largeIconUrl');
MediumIconUrl := CkJsonObject__stringOf(jResp,'groups[i].motif.mediumIconUrl');
SmallIconUrl := CkJsonObject__stringOf(jResp,'groups[i].motif.smallIconUrl');
SvgIconUrl := CkJsonObject__stringOf(jResp,'groups[i].motif.svgIconUrl');
myRole := CkJsonObject__stringOf(jResp,'groups[i].myRole');
Id := CkJsonObject__stringOf(jResp,'groups[i].mySubscription.id');
mySubscriptionUrl := CkJsonObject__stringOf(jResp,'groups[i].mySubscription.url');
name := CkJsonObject__stringOf(jResp,'groups[i].name');
AdditionalLabel := CkJsonObject__stringOf(jResp,'groups[i].owner.additionalLabel');
CommunityNickname := CkJsonObject__stringOf(jResp,'groups[i].owner.communityNickname');
CompanyName := CkJsonObject__stringOf(jResp,'groups[i].owner.companyName');
DisplayName := CkJsonObject__stringOf(jResp,'groups[i].owner.displayName');
FirstName := CkJsonObject__stringOf(jResp,'groups[i].owner.firstName');
ownerId := CkJsonObject__stringOf(jResp,'groups[i].owner.id');
IsActive := CkJsonObject_BoolOf(jResp,'groups[i].owner.isActive');
IsInThisCommunity := CkJsonObject_BoolOf(jResp,'groups[i].owner.isInThisCommunity');
LastName := CkJsonObject__stringOf(jResp,'groups[i].owner.lastName');
MotifColor := CkJsonObject__stringOf(jResp,'groups[i].owner.motif.color');
MotifLargeIconUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.motif.largeIconUrl');
MotifMediumIconUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.motif.mediumIconUrl');
MotifSmallIconUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.motif.smallIconUrl');
MotifSvgIconUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.motif.svgIconUrl');
MySubscription := CkJsonObject__stringOf(jResp,'groups[i].owner.mySubscription');
Name := CkJsonObject__stringOf(jResp,'groups[i].owner.name');
Message := CkJsonObject__stringOf(jResp,'groups[i].owner.outOfOffice.message');
FullEmailPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.fullEmailPhotoUrl');
LargePhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.largePhotoUrl');
MediumPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.mediumPhotoUrl');
PhotoVersionId := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.photoVersionId');
SmallPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.smallPhotoUrl');
StandardEmailPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.standardEmailPhotoUrl');
PhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.photo.url');
Reputation := CkJsonObject__stringOf(jResp,'groups[i].owner.reputation');
ownerTitle := CkJsonObject__stringOf(jResp,'groups[i].owner.title');
v_Type := CkJsonObject__stringOf(jResp,'groups[i].owner.type');
ownerUrl := CkJsonObject__stringOf(jResp,'groups[i].owner.url');
UserType := CkJsonObject__stringOf(jResp,'groups[i].owner.userType');
pendingRequests := CkJsonObject__stringOf(jResp,'groups[i].pendingRequests');
photoFullEmailPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.fullEmailPhotoUrl');
photoLargePhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.largePhotoUrl');
photoMediumPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.mediumPhotoUrl');
photoPhotoVersionId := CkJsonObject__stringOf(jResp,'groups[i].photo.photoVersionId');
photoSmallPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.smallPhotoUrl');
photoStandardEmailPhotoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.standardEmailPhotoUrl');
photoUrl := CkJsonObject__stringOf(jResp,'groups[i].photo.url');
v_type := CkJsonObject__stringOf(jResp,'groups[i].type');
url := CkJsonObject__stringOf(jResp,'groups[i].url');
visibility := CkJsonObject__stringOf(jResp,'groups[i].visibility');
i := i + 1;
end;
CkHttp_Dispose(http);
CkStringBuilder_Dispose(sbResponseBody);
CkJsonObject_Dispose(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}"
}
]
}
