List Sub Teamsbeta

get/team/sub_teams/{team_id}

Provides a paginated list of sub teams that belong to a given team.

beta
Feature only available in closed beta. Contact us to request access.
Securityapi_key or oauth2
Request
path Parameters
team_id
required
string

The id of the parent Team.

Example: 4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c
query Parameters
page
integer
Default: 1

Which page number of the SubTeam List to return. Defaults to 1.

page_size
integer [ 1 .. 100 ]
Default: 20

Number of objects to be returned per page. Must be between 1 and 100. Default is 20.

Responses
200

successful operation

4XX

failed_operation

Request samples
<?php

require_once __DIR__ . "/vendor/autoload.php";

$config = HelloSignSDK\Configuration::getDefaultConfiguration();

// Configure HTTP basic authorization: api_key
$config->setUsername("YOUR_API_KEY");

// or, configure Bearer (JWT) authorization: oauth2
// $config->setAccessToken("YOUR_ACCESS_TOKEN");

$api = new HelloSignSDK\Api\TeamApi($config);

$teamId = "4fea99bfcf2b26bfccf6cea3e127fb8bb74d8d9c";

try {
    $result = $api->teamSubTeams($teamId);
    print_r($result);
} catch (HelloSignSDK\ApiException $e) {
    $error = $e->getResponseObject();
    echo "Exception when calling HelloSign API: "
        . print_r($error->getError());
}
Response samples
application/json
{
  • "list_info": {
    },
  • "sub_teams": [
    ]
}