Skip to content

DocuSign: Returns the list of groups in an account

DocuSign admin.adminAccountAccountsGetGroupsV2: arguments, response, policy and SDK examples.

← Admin operations · Get started

Operation docusign.admin_account_accounts_getgroupsv2

Provider route: GET /Management/v2/organizations/{organizationId}/accounts/{accountId}/groups. Alter supplies the connection’s credentials and routing.

Install @alter-ai/sdk @alter-ai/docusign with npm, or alter-sdk-docusign with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { DocuSignIntegration } from "@alter-ai/docusign";
async function execute(input: Parameters<DocuSignIntegration["admin"]["adminAccountAccountsGetGroupsV2"]>[0]) {
const app = new App({ apiKey: process.env.ALTER_API_KEY! });
try {
const provider = new DocuSignIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
const call = await provider.admin.adminAccountAccountsGetGroupsV2(input);
const result = await call.wait();
return result.bodyJson();
} finally {
await app.close();
}
}
import os
from alter_sdk import App
from alter_sdk_docusign import DocuSignIntegration
async def execute(arguments):
async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
provider = DocuSignIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
call = await provider.admin.admin_account_accounts_get_groups_v2(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.organizationIdstringRequired within parentFormat: uuid
path.accountIdstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.startintegerOptionalFormat: int32
query.takeintegerOptionalFormat: int32
query.endintegerOptionalFormat: int32

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns the list of groups in an account — response body

Referenced models: Returns the list of groups in an account — response body

Returns the list of groups in an account — response body
FieldTypePresenceDescription and constraints
$objectRootA response about member groups. It contains the groups and paging information.
groupsarrayOptionalA list of the responses.
groups[]ModelEach itemExpand Returns the list of groups in an account — response body — groups item
pagingModelOptionalExpand Returns the list of groups in an account — response body — paging
Information about paging though the responses.

Referenced models: Returns the list of groups in an account — response body — groups item, Returns the list of groups in an account — response body — paging

Returns the list of groups in an account — response body — groups item
FieldTypePresenceDescription and constraints
$objectRootAnd individual group responses,.
idJSONOptional
id (anyOf 1)integerAlternativeThe unique ID of the group.
Format: int64
id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
namestringOptionalThe name of the group.
typestringOptionalThe type of group. One of:

- `invalid`
- `admin_group`
- `everyone_group`
- `custom_group`
Returns the list of groups in an account — response body — paging
FieldTypePresenceDescription and constraints
$objectRoot
nextstringOptionalA URL to the next set of results.
previousstringOptionalA URL to the previous set of results.
result_set_end_positionJSONOptional
result_set_end_position (anyOf 1)integerAlternativeThe index position of the last result in this set.
Format: int32
result_set_end_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_sizeJSONOptional
result_set_size (anyOf 1)integerAlternativeThe number of items in a result set (page).
Format: int32
result_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
result_set_start_positionJSONOptional
result_set_start_position (anyOf 1)integerAlternativeThe index position of the first result in this set.
Format: int32
result_set_start_position (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
total_set_sizeJSONOptional
total_set_size (anyOf 1)integerAlternativeThe total number of results.
Format: int32
total_set_size (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

SDK function policy ID: docusign.admin_account_accounts_getgroupsv2. Catalog operation: admin:Account_Accounts_GetGroupsV2. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["group_read"]

Official provider source

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.