Custom Tabs

Gets custom tab information

GET
/v2.1/accounts/{accountId}/tab_definitions/{customTabId}

Retrieves information about the requested custom tab on the specified account.

Authorization

OAuth2
AuthorizationBearer <token>

OAuth 2.0 access token obtained via Authorization Code Grant or JWT Grant.

In: header

Path Parameters

accountId*string

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

customTabId*string

The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.

Response Body

application/json

application/json

curl -X GET "https://example.com/v2.1/accounts/string/tab_definitions/string"
{  "anchor": "string",  "anchorCaseSensitive": "string",  "anchorHorizontalAlignment": "string",  "anchorIgnoreIfNotPresent": "string",  "anchorMatchWholeWord": "string",  "anchorUnits": "string",  "anchorXOffset": "string",  "anchorYOffset": "string",  "bold": "string",  "collaborative": "string",  "concealValueOnDocument": "string",  "createdByDisplayName": "string",  "createdByUserId": "string",  "customTabId": "string",  "disableAutoSize": "string",  "editable": "string",  "font": "string",  "fontColor": "string",  "fontSize": "string",  "height": "string",  "includedInEmail": "string",  "initialValue": "string",  "italic": "string",  "items": [    "string"  ],  "lastModified": "string",  "lastModifiedByDisplayName": "string",  "lastModifiedByUserId": "string",  "localePolicy": {    "addressFormat": "string",    "calendarType": "string",    "cultureName": "string",    "currencyCode": "string",    "currencyNegativeFormat": "string",    "currencyPositiveFormat": "string",    "customDateFormat": "string",    "customTimeFormat": "string",    "dateFormat": "string",    "initialFormat": "string",    "nameFormat": "string",    "timeFormat": "string",    "timeZone": "string",    "useLongCurrencyFormat": "string"  },  "locked": "string",  "maximumLength": "string",  "maxNumericalValue": "string",  "mergeField": {    "allowSenderToEdit": "string",    "configurationType": "string",    "path": "string",    "pathExtended": [      {        "name": "string",        "type": "string",        "typeName": "string"      }    ],    "row": "string",    "writeBack": "string"  },  "minNumericalValue": "string",  "name": "string",  "numericalValue": "string",  "paymentItemCode": "string",  "paymentItemDescription": "string",  "paymentItemName": "string",  "requireAll": "string",  "required": "string",  "requireInitialOnSharedChange": "string",  "scaleValue": "string",  "selected": "string",  "shared": "string",  "signatureProviderId": "string",  "stampType": "string",  "tabLabel": "string",  "type": "string",  "underline": "string",  "validationMessage": "string",  "validationPattern": "string",  "validationType": "string",  "width": "string"}