Skip to content

DocuSign: Gets the BCC email archive configurations for an account

DocuSign esignature.esignatureBccemailArchiveGetBccemailArchiveList: arguments, response, policy and SDK examples.

← Esignature operations · Get started

Operation docusign.esignature_bccemailarchive_getbccemailarchivelist

Provider route: GET /restapi/v2.1/accounts/{accountId}/settings/bcc_email_archives. 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["esignature"]["esignatureBccemailArchiveGetBccemailArchiveList"]>[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.esignature.esignatureBccemailArchiveGetBccemailArchiveList(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.esignature.esignature_bccemail_archive_get_bccemail_archive_list(arguments)
result = await call.wait()
return result.body_json()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
pathobjectRequired within parentAdditional keys: not allowed
path.accountIdstringRequired within parent
queryobjectOptionalAdditional keys: not allowed
query.countstringOptional
query.start_positionstringOptional

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Gets the BCC email archive configurations for an account — response body

Referenced models: Gets the BCC email archive configurations for an account — response body

Gets the BCC email archive configurations for an account — response body
FieldTypePresenceDescription and constraints
$objectRootContains a list of BCC email archive configurations.
bccEmailArchivesarrayOptionalA list of BCC email archive configurations.
bccEmailArchives[]ModelEach itemExpand Creates a BCC email archive configuration — response body
endPositionstringOptionalThe last index position in the result set.
nextUristringOptionalThe URI for the next chunk of records based on the search request. It is `null` if this is the last set of results for the search.
previousUristringOptionalThe URI for the prior chunk of records based on the search request. It is `null` if this is the first set of results for the search.
resultSetSizestringOptionalThe number of results in this response. Because you can filter which entries are included in the response, this value is always less than or equal to the `totalSetSize`.
startPositionstringOptionalThe starting index position of the current result set.
totalSetSizestringOptionalThe total number of items in the result set. This value is always greater than or equal to the value of `resultSetSize`.

Referenced models: Creates a BCC email archive configuration — response body

Creates a BCC email archive configuration — response body
FieldTypePresenceDescription and constraints
$objectRootThis object contains information abut a BCC email archive configuration (a BCC email address used to archive Docusign-generated emails).
accountIdstringOptionalThe ID of the account that owns the BCC email archive configuration.
bccEmailArchiveIdstringOptionalThe ID of the BCC email archive configuration.
createdstringOptionalThe UTC DateTime when the BCC email archive configuration was created.
createdByModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Details about the user who created the BCC email archive configuration.
emailstringOptionalThe BCC email address to use for archiving Docusign messages.

Example: customer_bcc@example.com
emailNotificationIdstringOptionalThe GUID of the activation email message sent to the BCC email address.
modifiedstringOptionalThe UTC DateTime when the BCC email archive configuration was last modified.
modifiedByModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Details about the user who last modified the BCC email archive configuration.
statusstringOptionalThe status of the BCC email address. Possible values are:

- `activation_sent`: An activation link has been sent to the BCC email address.
- `active`: The BCC email address is actively used for archiving.
- `closed`: The BCC email address is no longer used for archiving.
uristringOptionalThe helper URI for retrieving the BCC email archive.

Referenced models: Gets a specific template associated with a specified account — response body — owner

Gets a specific template associated with a specified account — response body — owner
FieldTypePresenceDescription and constraints
$objectRoot
accountIdstringOptionalThe account ID associated with the envelope.
accountNamestringOptionalThe name on the account.
activationAccessCodestringOptionalAccess code provided to the user to activate the account.
emailstringOptionalThe user's email address.
errorDetailsModelOptionalExpand Locks a template — response body — error Details
This object describes errors that occur. It is only valid for responses and ignored in requests.
ipAddressstringOptional
loginStatusstringOptionalWhen **true,** indicates that the user is logged in. This is a read-only property.
membershipIdstringOptionalThe user's membership ID.
sendActivationEmailstringOptionalThis field is no longer supported for most accounts. To create an eSignature user without sending an activation email, use the Admin API by following [these steps](/docs/admin-api/how-to/create-active-user/).
uristringOptionalA URI containing the user ID.
userIdstringOptionalThe ID of the user to access.
userNamestringOptionalThe name of the user.
userStatusstringOptionalStatus of the user's account. One of:

- `ActivationRequired`
- `ActivationSent`
- `Active`
- `Closed`
- `Disabled`
userTypestringOptionalThe type of user, for example `CompanyUser`.

Referenced models: Locks a template — response body — error Details

Locks a template — response body — error Details
FieldTypePresenceDescription and constraints
$objectRootThis object describes errors that occur. It is only valid for responses and ignored in requests.
errorCodestringOptionalThe code associated with the error condition.
messagestringOptionalA brief message describing the error condition.

SDK function policy ID: docusign.esignature_bccemailarchive_getbccemailarchivelist. Catalog operation: esignature:BCCEmailArchive_GetBCCEmailArchiveList. 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.

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.