Chilkat Online Tools

phpAx / DocuSign Rooms API - v2 / Gets a paged-list of

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

$queryParams = new COM("Chilkat_9_5_0.JsonObject");
$queryParams->UpdateString('filter','{{filter}}');
$queryParams->UpdateString('sort','{{sort}}');
$queryParams->UpdateString('defaultOfficeId','{{defaultOfficeId}}');
$queryParams->UpdateString('accessLevel','{{accessLevel}}');
$queryParams->UpdateString('titleId','{{titleId}}');
$queryParams->UpdateString('roleId','{{roleId}}');
$queryParams->UpdateString('status','{{status}}');
$queryParams->UpdateString('lockedOnly','{{lockedOnly}}');
$queryParams->UpdateInt('startPosition',0);
$queryParams->UpdateInt('count',100);

// Adds the "Authorization: Bearer {{accessToken}}" header.
$http->AuthToken = '{{accessToken}}';
$http->SetRequestHeader('Accept','text/plain, application/json, text/json');

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->QuickRequestParams('GET','https://domain.com/v2/accounts/{{accountId}}/users',$queryParams);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -G -d "filter=%7B%7Bfilter%7D%7D"
	-d "sort=%7B%7Bsort%7D%7D"
	-d "defaultOfficeId=%7B%7BdefaultOfficeId%7D%7D"
	-d "accessLevel=%7B%7BaccessLevel%7D%7D"
	-d "titleId=%7B%7BtitleId%7D%7D"
	-d "roleId=%7B%7BroleId%7D%7D"
	-d "status=%7B%7Bstatus%7D%7D"
	-d "lockedOnly=%7B%7BlockedOnly%7D%7D"
	-d "startPosition=0"
	-d "count=100"
	-H "Accept: text/plain, application/json, text/json"
	-H "Authorization: Bearer {{accessToken}}"
https://domain.com/v2/accounts/{{accountId}}/users

Postman Collection Item JSON

{
  "name": "Gets a paged-list of ",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "text/plain, application/json, text/json"
      },
      {
        "key": "Authorization",
        "value": "Bearer {{accessToken}}"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/v2/accounts/{{accountId}}/users?filter={{filter}}&sort={{sort}}&defaultOfficeId={{defaultOfficeId}}&accessLevel={{accessLevel}}&titleId={{titleId}}&roleId={{roleId}}&status={{status}}&lockedOnly={{lockedOnly}}&startPosition=0&count=100",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "v2",
        "accounts",
        "{{accountId}}",
        "users"
      ],
      "query": [
        {
          "key": "filter",
          "value": "{{filter}}"
        },
        {
          "key": "sort",
          "value": "{{sort}}"
        },
        {
          "key": "defaultOfficeId",
          "value": "{{defaultOfficeId}}"
        },
        {
          "key": "accessLevel",
          "value": "{{accessLevel}}"
        },
        {
          "key": "titleId",
          "value": "{{titleId}}"
        },
        {
          "key": "roleId",
          "value": "{{roleId}}"
        },
        {
          "key": "status",
          "value": "{{status}}"
        },
        {
          "key": "lockedOnly",
          "value": "{{lockedOnly}}"
        },
        {
          "key": "startPosition",
          "value": "0"
        },
        {
          "key": "count",
          "value": "100"
        }
      ],
      "variable": [
        {
          "key": "accountId",
          "value": "{{accountId}}"
        }
      ]
    },
    "description": "Retrieves a paged-list of Company Users in the User's company using the given filter and sort parameters."
  },
  "response": [
  ]
}