Skip to content

DocuSign: Get a single account creation process

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

← Admin operations · Get started

Operation docusign.admin_organizationsubaccount_getsubaccountcreateprocessbyassetgroupworkid

Provider route: GET /Management/v2/organizations/{organizationId}/assetGroup/{assetGroupId}/subAccountCreated/{assetGroupWorkId}. 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"]["adminOrganizationSubAccountGetSubAccountCreateProcessByAssetGroupWorkId"]>[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.adminOrganizationSubAccountGetSubAccountCreateProcessByAssetGroupWorkId(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_organization_sub_account_get_sub_account_create_process_by_asset_group_work_id(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.assetGroupIdstringRequired within parentFormat: uuid
path.assetGroupWorkIdstringRequired within parentFormat: uuid
queryobjectOptionalAdditional keys: not allowed
query.include_detailsbooleanOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Get a single account creation process — response body

Referenced models: Get a single account creation process — response body

Get a single account creation process — response body
FieldTypePresenceDescription and constraints
$objectRoot
assetGroupIdstringOptionalThe ID of the asset group to which the accounts belong.
Format: uuid
Read only: true
assetGroupWorkIdstringOptionalThe ID of the job that is created by the request.
Format: uuid
Read only: true
assetGroupWorkTypestringOptionalThe type of asset group work. This property is read-only.
Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync
Read only: true
attemptsJSONOptional
attempts (anyOf 1)integerAlternativeThe number of times the job has been attempted.
Format: int32
Read only: true
attempts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
createAccountProcessingFailureDetailsModelOptionalExpand Gets information about a single cloned account — response body — clone Processing Failure Details
The processing failure details if the job has a status of `PendingError` or `ProcessingError`.
Read only: true
createdByEmailstringOptionalThe email of the creator of the account clone work.
Read only: true
createdByNamestringOptionalThe name of the creator of the account clone work.
Read only: true
createdDatestringOptionalThe date the account clone work is created.
Format: date-time
Read only: true
messagestringOptionalThe message associated with the account clone work.
Read only: true
orderIdstringOptionalThe order ID created by the clone work.

Format: uuid
Read only: true
statusstringOptionalThe status of the account creation request.
Known values: Undefined, Pending, Processing, ProcessingOnHold, PendingError, ProcessingError, Completed, Canceled, PermanentFailure
Read only: true
subscriptionDetailsModelRequired within parentExpand Get a single account creation process — response body — subscription Details
The subscription info for the new account.
targetAccountModelRequired within parentExpand Get a single account creation process — response body — target Account
The target account to clone to.

Referenced models: Get a single account creation process — response body — subscription Details, Get a single account creation process — response body — target Account, Gets information about a single cloned account — response body — clone Processing Failure Details

Get a single account creation process — response body — subscription Details
FieldTypePresenceDescription and constraints
$objectRoot
idstringOptionalSubscription ID
modulesarrayOptionalList of module IDs selected for creating the new account
modules[]ModelEach itemExpand Get a single account creation process — response body — subscription Details modules item
planIdstringOptionalPlan ID
Format: uuid
planNamestringOptionalPlan name

Referenced models: Get a single account creation process — response body — subscription Details modules item

Get a single account creation process — response body — target Account
FieldTypePresenceDescription and constraints
$objectRoot
adminModelOptionalExpand Get a single account creation process — response body — target Account admin
The admin user for the target account.
countryCodestringOptionalThe country code where the target account is in. This value is ignored if region is provided.
idstringOptionalThe account ID of the new account. The GUID will be empty if the account has not been created yet.
Format: uuid
namestringOptionalThe name of the target account.
regionstringOptionalThe region where the target account is in.
sitestringOptionalThe site where the target account is on.

Referenced models: Get a single account creation process — response body — target Account admin

Gets information about a single cloned account — response body — clone Processing Failure Details
FieldTypePresenceDescription and constraints
$objectRoot
errorstringOptionalThe error code.
Read only: true
errorDescriptionstringOptionalThe error description.
Read only: true
isSystemErrorbooleanOptionalWhether the error is caused by the system or user.
Read only: true
Get a single account creation process — response body — subscription Details modules item
FieldTypePresenceDescription and constraints
$objectRoot
moduleIdstringOptionalModule ID
Format: uuid
moduleNamestringOptionalModule name
Get a single account creation process — response body — target Account admin
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address of the target account's admin user.
firstNamestringOptional
lastNamestringOptional
localestringOptionalKnown values: None, zh_cn, zh_tw, nl, en, fr, de, it, ja, ko, pt, pt_br, ru, es, pl

SDK function policy ID: docusign.admin_organizationsubaccount_getsubaccountcreateprocessbyassetgroupworkid. Catalog operation: admin:OrganizationSubAccount_GetSubAccountCreateProcessByAssetGroupWorkId. 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: ["organization_sub_account_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.