Chilkat Online Tools

C / DocuSign Admin API / Returns information about the users in the organization

Back to Collection Items

#include <C_CkHttp.h>
#include <C_CkJsonObject.h>
#include <C_CkHttpResponse.h>

void ChilkatSample(void)
    {
    HCkHttp http;
    BOOL success;
    HCkJsonObject queryParams;
    HCkHttpResponse resp;

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

    http = CkHttp_Create();

    queryParams = CkJsonObject_Create();
    CkJsonObject_UpdateString(queryParams,"start","{{start}}");
    CkJsonObject_UpdateString(queryParams,"take","{{take}}");
    CkJsonObject_UpdateString(queryParams,"end","{{end}}");
    CkJsonObject_UpdateString(queryParams,"email","{{email}}");
    CkJsonObject_UpdateString(queryParams,"email_user_name_like","{{email_user_name_like}}");
    CkJsonObject_UpdateString(queryParams,"status","{{status}}");
    CkJsonObject_UpdateString(queryParams,"membership_status","{{membership_status}}");
    CkJsonObject_UpdateString(queryParams,"account_id","{{account_id}}");
    CkJsonObject_UpdateString(queryParams,"organization_reserved_domain_id","{{organization_reserved_domain_id}}");
    CkJsonObject_UpdateString(queryParams,"last_modified_since","{{last_modified_since}}");

    CkHttp_SetRequestHeader(http,"Content-Type","application/json");
    // Adds the "Authorization: Bearer {{accessToken}}" header.
    CkHttp_putAuthToken(http,"{{accessToken}}");
    CkHttp_SetRequestHeader(http,"Accept","application/json");

    resp = CkHttp_QuickRequestParams(http,"GET","https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users",queryParams);
    if (CkHttp_getLastMethodSuccess(http) == FALSE) {
        printf("%s\n",CkHttp_lastErrorText(http));
        CkHttp_Dispose(http);
        CkJsonObject_Dispose(queryParams);
        return;
    }

    printf("%d\n",CkHttpResponse_getStatusCode(resp));
    printf("%s\n",CkHttpResponse_bodyStr(resp));
    CkHttpResponse_Dispose(resp);


    CkHttp_Dispose(http);
    CkJsonObject_Dispose(queryParams);

    }

Curl Command

curl -G -d "start=%7B%7Bstart%7D%7D"
	-d "take=%7B%7Btake%7D%7D"
	-d "end=%7B%7Bend%7D%7D"
	-d "email=%7B%7Bemail%7D%7D"
	-d "email_user_name_like=%7B%7Bemail_user_name_like%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "membership_status=%7B%7Bmembership_status%7D%7D"
	-d "account_id=%7B%7Baccount_id%7D%7D"
	-d "organization_reserved_domain_id=%7B%7Borganization_reserved_domain_id%7D%7D"
	-d "last_modified_since=%7B%7Blast_modified_since%7D%7D"
	-H "Accept: application/json"
	-H "Content-Type: application/json"
	-H "Authorization: Bearer {{accessToken}}"
https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users

Postman Collection Item JSON

{
  "name": "Returns information about the users in the organization",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      },
      {
        "key": "Content-Type",
        "value": "application/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "https://{{hostenv}}/Management/v2/organizations/{{organizationId}}/users?start={{start}}&take={{take}}&end={{end}}&email={{email}}&email_user_name_like={{email_user_name_like}}&status={{status}}&membership_status={{membership_status}}&account_id={{account_id}}&organization_reserved_domain_id={{organization_reserved_domain_id}}&last_modified_since={{last_modified_since}}",
      "protocol": "https",
      "host": [
        "{{hostenv}}"
      ],
      "path": [
        "Management",
        "v2",
        "organizations",
        "{{organizationId}}",
        "users"
      ],
      "query": [
        {
          "key": "start",
          "value": "{{start}}"
        },
        {
          "key": "take",
          "value": "{{take}}"
        },
        {
          "key": "end",
          "value": "{{end}}"
        },
        {
          "key": "email",
          "value": "{{email}}"
        },
        {
          "key": "email_user_name_like",
          "value": "{{email_user_name_like}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "membership_status",
          "value": "{{membership_status}}"
        },
        {
          "key": "account_id",
          "value": "{{account_id}}"
        },
        {
          "key": "organization_reserved_domain_id",
          "value": "{{organization_reserved_domain_id}}"
        },
        {
          "key": "last_modified_since",
          "value": "{{last_modified_since}}"
        }
      ],
      "variable": [
        {
          "key": "organizationId",
          "value": "{{organizationId}}"
        }
      ]
    },
    "description": "Required scopes: user_read"
  },
  "response": [
  ]
}