Skip to content

DocuSign: Returns the details metadata for a Bulk Account Settings Import request

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

← Admin operations · Get started

Operation docusign.admin_organizationimport_organizationimportaccountsettings_getbyid

Provider route: GET /Management/v2/organizations/{organizationId}/imports/account_settings/{importId}. 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"]["adminOrganizationImportOrganizationImportAccountSettingsGetById"]>[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.adminOrganizationImportOrganizationImportAccountSettingsGetById(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_import_organization_import_account_settings_get_by_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.importIdstringRequired within parentFormat: uuid

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Creates a new account settings import request — response body

Referenced models: Creates a new account settings import request — response body

Creates a new account settings import request — response body
FieldTypePresenceDescription and constraints
$objectRoot
completedstringOptionalFormat: date-time
createdstringOptionalFormat: date-time
expiresstringOptionalFormat: date-time
idstringOptional
last_modifiedstringOptionalFormat: date-time
number_processed_accountsJSONOptional
number_processed_accounts (anyOf 1)integerAlternativeFormat: int64
number_processed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_unprocessed_accountsJSONOptional
number_unprocessed_accounts (anyOf 1)integerAlternativeFormat: int64
number_unprocessed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
organization_idstringOptional
percent_completedJSONOptional
percent_completed (anyOf 1)integerAlternativeFormat: int32
percent_completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestorModelOptionalExpand Creates a new account settings import request — response body — requestor
resultsarrayOptional
results[]ModelEach itemExpand Creates a new account settings import request — response body — results item
skipped_settings_by_accountobjectOptionalAdditional keys: see wildcard field
skipped_settings_by_account.*arrayAdditional keys
skipped_settings_by_account.*[]stringEach item
statusstringOptionalStatus.
successbooleanOptional
typestringOptional

Referenced models: Creates a new account settings import request — response body — requestor, Creates a new account settings import request — response body — results item

Creates a new account settings import request — response body — requestor
FieldTypePresenceDescription and constraints
$objectRoot
emailstringOptionalThe email address.
idstringOptional
namestringOptional
typestringOptional
Creates a new account settings import request — response body — results item
FieldTypePresenceDescription and constraints
$objectRoot
error_detailsModelOptionalExpand Creates a user list export request — response body — results item error details
Error results.
idstringOptionalFormat: uuid
number_processed_accountsJSONOptional
number_processed_accounts (anyOf 1)integerAlternativeFormat: int64
number_processed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
number_unprocessed_accountsJSONOptional
number_unprocessed_accounts (anyOf 1)integerAlternativeFormat: int64
number_unprocessed_accounts (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
processing_issues_by_accountarrayOptional
processing_issues_by_account[]ModelEach itemExpand Creates a new account settings import request — response body — results item processing issues by account item
site_idJSONOptional
site_id (anyOf 1)integerAlternativeFormat: int32
site_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
urlstringOptional

Referenced models: Creates a user list export request — response body — results item error details, Creates a new account settings import request — response body — results item processing issues by account item

Creates a user list export request — response body — results item error details
FieldTypePresenceDescription and constraints
$objectRoot
errorstringOptionalThe error number.
error_descriptionstringOptionalA longer description of the error.
Creates a new account settings import request — response body — results item processing issues by account item
FieldTypePresenceDescription and constraints
$objectRoot
account_idstringOptionalSelect users that are members of the specified account. At least one of `email`, `account_id` or `organization_reserved_domain_id` must be specified.
account_namestringOptional
errorstringOptionalThe error number.
error_keystringOptional
setting_keystringOptional

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