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.
Call through Alter
Section titled “Call through Alter”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 osfrom alter_sdk import Appfrom 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()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.organizationId | string | Required within parent | Format: uuid |
path.assetGroupId | string | Required within parent | Format: uuid |
path.assetGroupWorkId | string | Required within parent | Format: uuid |
query | object | Optional | Additional keys: not allowed |
query.include_details | boolean | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Get a single account creation process — response body |
Referenced models: Get a single account creation process — response body
Schemas
Section titled “Schemas”Get a single account creation process — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
assetGroupId | string | Optional | The ID of the asset group to which the accounts belong. Format: uuid Read only: true |
assetGroupWorkId | string | Optional | The ID of the job that is created by the request. Format: uuid Read only: true |
assetGroupWorkType | string | Optional | The type of asset group work. This property is read-only. Known values: Undefined, GroupAssetFulfillment, AccountAssetFulfillment, AccountAssetClone, AccountAssetCreate, SubscriptionSync Read only: true |
attempts | JSON | Optional | |
attempts (anyOf 1) | integer | Alternative | The number of times the job has been attempted. Format: int32 Read only: true |
attempts (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
createAccountProcessingFailureDetails | Model | Optional | Expand 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 |
createdByEmail | string | Optional | The email of the creator of the account clone work. Read only: true |
createdByName | string | Optional | The name of the creator of the account clone work. Read only: true |
createdDate | string | Optional | The date the account clone work is created. Format: date-time Read only: true |
message | string | Optional | The message associated with the account clone work. Read only: true |
orderId | string | Optional | The order ID created by the clone work. Format: uuid Read only: true |
status | string | Optional | The status of the account creation request. Known values: Undefined, Pending, Processing, ProcessingOnHold, PendingError, ProcessingError, Completed, Canceled, PermanentFailure Read only: true |
subscriptionDetails | Model | Required within parent | Expand Get a single account creation process — response body — subscription Details The subscription info for the new account. |
targetAccount | Model | Required within parent | Expand 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Optional | Subscription ID |
modules | array | Optional | List of module IDs selected for creating the new account |
modules[] | Model | Each item | Expand Get a single account creation process — response body — subscription Details modules item |
planId | string | Optional | Plan ID Format: uuid |
planName | string | Optional | Plan 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
admin | Model | Optional | Expand Get a single account creation process — response body — target Account admin The admin user for the target account. |
countryCode | string | Optional | The country code where the target account is in. This value is ignored if region is provided. |
id | string | Optional | The account ID of the new account. The GUID will be empty if the account has not been created yet. Format: uuid |
name | string | Optional | The name of the target account. |
region | string | Optional | The region where the target account is in. |
site | string | Optional | The 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
error | string | Optional | The error code. Read only: true |
errorDescription | string | Optional | The error description. Read only: true |
isSystemError | boolean | Optional | Whether the error is caused by the system or user. Read only: true |
Get a single account creation process — response body — subscription Details modules item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
moduleId | string | Optional | Module ID Format: uuid |
moduleName | string | Optional | Module name |
Get a single account creation process — response body — target Account admin
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
email | string | Optional | The email address of the target account's admin user. |
firstName | string | Optional | |
lastName | string | Optional | |
locale | string | Optional | Known values: None, zh_cn, zh_tw, nl, en, fr, de, it, ja, ko, pt, pt_br, ru, es, pl |
Policy, approvals and errors
Section titled “Policy, approvals and errors”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"]