AccountBrands: listResources

Request

HTTP request

GET /v2/accounts/{accountId}/brands/{brandId}/resources

Parameters

Parameter NameValueDescription
Path Parameters
accountIdstring

The external account number (int) or account ID Guid.

brandIdstring

The unique identifier of a brand.

Responses

CodeDescriptionReference
200

Successful response.

brandResourcesList
400

Error encountered.

errorDetails

SDK Method

Accounts::getBrandResources

Definitions

brandResources

createdByUserInfouserInfo

createdDatestring

modifiedByUserInfouserInfo

modifiedDatestring

modifiedTemplates[array]

resourcesContentTypestring

resourcesContentUristring

brandResourcesList

resourcesContentTypes[brandResources]

errorDetails

This object describes errors that occur. It is only valid for responses, and ignored in requests.

errorCodestring

An error code associated with the error.

messagestring

A short error message.

userInfo

activationAccessCodestring

emailstring

errorDetailserrorDetails

loginStatusstring

sendActivationEmailstring

uristring

userIdstring

The user ID of the user being accessed. Generally this is the user ID of the authenticated user, but if the authenticated user is an Admin on the account, this may be another user the Admin user is accessing. Note: For GET /v2/accounts/{accountId}/envelopes user_id query parameter is not implemented and should not be used.

userNamestring

userStatusstring

Status of the user's account. One of:

  • ActivationRequired
  • ActivationSent
  • Active
  • Closed
  • Disabled

userTypestring

Examples

Generic JSON Response

Response
{
  "resourcesContentTypes": [
    {
      "resourcesContentType": "sample string 1",
      "modifiedTemplates": [
        "sample string 1"
      ],
      "createdDate": "sample string 2",
      "createdByUserInfo": {
        "userName": "sample string 1",
        "userId": "sample string 2",
        "email": "sample string 3",
        "userType": "sample string 4",
        "userStatus": "sample string 5",
        "uri": "sample string 6",
        "loginStatus": "sample string 7",
        "sendActivationEmail": "sample string 8",
        "activationAccessCode": "sample string 9",
        "errorDetails": {
          "errorCode": "sample string 1",
          "message": "sample string 2"
        }
      },
      "modifiedDate": "sample string 3",
      "modifiedByUserInfo": {},
      "resourcesContentUri": "sample string 4"
    }
  ]
}
Generic XML Response

Response
<brandResourcesList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.docusign.com/restapi">
  <resourcesContentTypes>
    <brandResources>
      <createdByUserInfo>
        <activationAccessCode>sample string 9</activationAccessCode>
        <email>sample string 3</email>
        <errorDetails>
          <errorCode>sample string 1</errorCode>
          <message>sample string 2</message>
        </errorDetails>
        <loginStatus>sample string 7</loginStatus>
        <sendActivationEmail>sample string 8</sendActivationEmail>
        <uri>sample string 6</uri>
        <userId>sample string 2</userId>
        <userName>sample string 1</userName>
        <userStatus>sample string 5</userStatus>
        <userType>sample string 4</userType>
      </createdByUserInfo>
      <createdDate>sample string 2</createdDate>
      <modifiedByUserInfo />
      <modifiedDate>sample string 3</modifiedDate>
      <modifiedTemplates>
        <string>sample string 1</string>
      </modifiedTemplates>
      <resourcesContentType>sample string 1</resourcesContentType>
      <resourcesContentUri>sample string 4</resourcesContentUri>
    </brandResources>
  </resourcesContentTypes>
</brandResourcesList> 
}} />