Skip to content

DocuSign: Returns metadata about the branding resources for an account

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

← Esignature operations · Get started

Operation docusign.esignature_brandresources_getbrandresourceslist

Provider route: GET /restapi/v2.1/accounts/{accountId}/brands/{brandId}/resources. 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"]["esignatureBrandResourcesGetBrandResourcesList"]>[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.esignatureBrandResourcesGetBrandResourcesList(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_brand_resources_get_brand_resources_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
path.brandIdstringRequired within parent

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

FieldTypePresenceDescription and constraints
$ModelRootExpand Returns metadata about the branding resources for an account — response body

Referenced models: Returns metadata about the branding resources for an account — response body

Returns metadata about the branding resources for an account — response body
FieldTypePresenceDescription and constraints
$objectRoot
resourcesContentTypesarrayOptionalA list of resources that the brand uses.
resourcesContentTypes[]ModelEach itemExpand Updates a branding resource file — response body

Referenced models: Updates a branding resource file — response body

Updates a branding resource file — response body
FieldTypePresenceDescription and constraints
$objectRootInformation about the resource files that the brand uses for the email, signing, sending, and captive (embedded) signing experiences.
createdByUserInfoModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
The user ID of the user who created the brand resource.
createdDatestringOptionalThe date and time that the brand resource was created.
dataNotSavedNotInMasterarrayOptionalDeprecated.
dataNotSavedNotInMaster[]stringEach item
modifiedByUserInfoModelOptionalExpand Gets a specific template associated with a specified account — response body — owner
Information about the user who last modified the brand resource.
modifiedDatestringOptionalThe date on which this user record was last modified.
modifiedTemplatesarrayOptionalThis property is returned in the response to the [AccountBrands::listResources][listResources] request. It contains a list of any email templates that have been modified to differ from the master resource files.

[listResources]: /docs/esign-rest-api/reference/accounts/accountbrands/listresources/
modifiedTemplates[]stringEach item
resourcesContentTypestringOptionalThe type of brand resource file. A brand uses a different resource file to control each of the following experiences:

- Sending (`sending`)
- Signing (`signing`)
- Email messages (`email`)
- Captive (embedded) signing (`signing_captive`)

You can modify the default email messages and formats in these files and upload them to your brand to customize the user experience.
resourcesContentUristringOptionalThe URI for the brand resource file.

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_brandresources_getbrandresourceslist. Catalog operation: esignature:BrandResources_GetBrandResourcesList. 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.