Returns details about the brand set for a workspace | Docusign

{
  "colors": [
    {
      "name": "headerBackground",
      "value": "ffffff"
    },
    {
      "name": "headerText",
      "value": "ffffff"
    },
    {
      "name": "buttonPrimaryBackground",
      "value": "ffffff"
    },
    {
      "name": "buttonPrimaryText",
      "value": "ffffff"
    }
  ],
  "brand_languages": [
    "ar",
    "bg",
    "cs",
    "da",
    "de",
    "el",
    "en",
    "en_GB",
    "es",
    "es_MX",
    "et",
    "fa",
    "fi",
    "fr",
    "fr_CA",
    "he",
    "hi",
    "hr",
    "hu",
    "id",
    "it",
    "ja",
    "ko",
    "lt",
    "lv",
    "ms",
    "nl",
    "no",
    "pl",
    "pt",
    "pt_BR",
    "ro",
    "ru",
    "sk",
    "sl",
    "sr",
    "sv",
    "th",
    "tr",
    "uk",
    "vi",
    "zh_CN",
    "zh_TW",
    "hy"
  ],
  "brand_id": "21d17b0c-59bc-4879-9643-92d68bd9f8f6",
  "brand_name": "Test brand name",
  "brand_company": null,
  "logos": {
    "primary": "/brand/21d17b0c-59bc-4879-9643-92d68bd9f8f6/logos/primary",
    "secondary": "/brand/21d17b0c-59bc-4879-9643-92d68bd9f8f6/logos/secondary",
    "email": "/brand/21d17b0c-59bc-4879-9643-92d68bd9f8f6/logos/email"
  },
  "default_brand_language": null,
  "is_sending_default": false,
  "is_signing_default": false,
  "primary_logo_id": null,
  "secondary_logo_id": null,
  "email_logo_id": null
}

Note: This endpoint is in beta.

This operation retrieves details about a specific workspace. It returns the brand details such as its unique identifier (ID), name, and metadata such as brand colors and logos.

Authentication

AuthorizationBearer

JWT Bearer token from Docusign authorization server

Path parameters

accountIdstringRequiredformat: "uuid"

The ID of the account

workspaceIdstringRequiredformat: "uuid"

The ID of the workspace

Response

Workspace successfully retrieved

colorslist of objects or null

brand_languageslist of strings or null

brand_idstring or nullOptional

brand_namestring or nullOptional

brand_companystring or nullOptional

logosobjectOptional

default_brand_languagestring or nullOptional

is_sending_defaultbooleanOptional

is_signing_defaultbooleanOptional

primary_logo_idstring or nullOptional

secondary_logo_idstring or nullOptional

email_logo_idstring or nullOptional

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error