Chilkat Online Tools

Objective-C / DocuSign REST API / Gets information about groups associated with the account.

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

CkoJsonObject *queryParams = [[CkoJsonObject alloc] init];
[queryParams UpdateString: @"count" value: @"{{count}}"];
[queryParams UpdateString: @"group_type" value: @"{{group_type}}"];
[queryParams UpdateString: @"include_usercount" value: @"{{include_usercount}}"];
[queryParams UpdateString: @"search_text" value: @"{{search_text}}"];
[queryParams UpdateString: @"start_position" value: @"{{start_position}}"];

// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];

CkoHttpResponse *resp = [http QuickRequestParams: @"GET" url: @"https://domain.com/v2.1/accounts/{{accountId}}/groups" json: queryParams];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

Curl Command

curl -G -d "count=%7B%7Bcount%7D%7D"
	-d "group_type=%7B%7Bgroup_type%7D%7D"
	-d "include_usercount=%7B%7Binclude_usercount%7D%7D"
	-d "search_text=%7B%7Bsearch_text%7D%7D"
	-d "start_position=%7B%7Bstart_position%7D%7D"
	-H "Accept: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2.1/accounts/{{accountId}}/groups

Postman Collection Item JSON

{
  "name": "Gets information about groups associated with the account.",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/groups?count={{count}}&group_type={{group_type}}&include_usercount={{include_usercount}}&search_text={{search_text}}&start_position={{start_position}}",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2.1",
        "accounts",
        "{{accountId}}",
        "groups"
      ],
      "query": [
        {
          "key": "count",
          "value": "{{count}}"
        },
        {
          "key": "group_type",
          "value": "{{group_type}}"
        },
        {
          "key": "include_usercount",
          "value": "{{include_usercount}}"
        },
        {
          "key": "search_text",
          "value": "{{search_text}}"
        },
        {
          "key": "start_position",
          "value": "{{start_position}}"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Retrieves information about groups associated with the account."
  },
  "response": [
  ]
}