--- title: "Get editor brand resource" method: GET path: "/v2/brands/{brand_id}/resources/editor" --- # Get editor brand resource `GET /v2/brands/{brand_id}/resources/editor` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/brands/{brand_id}/resources/editor` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows API users to retrieve the editor resource of a brand. ## Response `200` Successful response. - object - `data` object: Editor resource of the brand. - `fields` object: Settings of the fields panel on the left sidebar. Available for embedded sending, embedded editor, and FreeForm invite. - `date` object: Configuration of the date field in the fields panel. - `visibility` boolean: `true` if the date field is shown in the fields panel. - `text` object: Configuration of the text field in the fields panel. - `visibility` boolean: `true` if the text field is shown in the fields panel. - `email` object: Configuration of the email field in the fields panel. - `visibility` boolean: `true` if the email field is shown in the fields panel. - `stamp` object: Configuration of the stamp field in the fields panel. - `visibility` boolean: `true` if the stamp field is shown in the fields panel. - `formula` object: Configuration of the formula field in the fields panel. - `visibility` boolean: `true` if the formula field is shown in the fields panel. - `checkbox` object: Configuration of the checkbox field in the fields panel. - `visibility` boolean: `true` if the checkbox field is shown in the fields panel. - `dropdown` object: Configuration of the dropdown field in the fields panel. - `visibility` boolean: `true` if the dropdown field is shown in the fields panel. - `fullname` object: Configuration of the fullname field in the fields panel. - `visibility` boolean: `true` if the full name field is shown in the fields panel. - `initials` object: Configuration of the initials field in the fields panel. - `visibility` boolean: `true` if the initials field is shown in the fields panel. - `hyperlink` object: Configuration of the hyperlink field in the fields panel. - `visibility` boolean: `true` if the hyperlink field is shown in the fields panel. - `signature` object: Configuration of the signature field in the fields panel. - `visibility` boolean: `true` if the signature field is shown in the fields panel. - `attachment` object: Configuration of the attachment field in the fields panel. - `visibility` boolean: `true` if the attachment field is shown in the fields panel. - `radiobutton` object: Configuration of the radiobutton field in the fields panel. - `visibility` boolean: `true` if the radio button field is shown in the fields panel. - `sidebar` object: Configuration of the sidebar in the editor. - `background` string: Background color for a signing session sidebar in HEX color code. - `visibility` boolean: Whether the sidebar should be visible or not. - `toolbar` object: Configuration of the toolbar in the header. Available for embedded sending and embedded editor. - `background` string: Background color of the toolbar in HEX color code. - `visibility` boolean: Whether to show the toolbar in the header. - `settings` object: Settings object that contains attributes for the **More Actions** dropdown button. - `visibility` boolean: `true` if the **More Actions** button is shown. - `auth-page` object: Text on the authentication page for invites protected by a password, a phone call, or an SMS. - `check-pin` object: Text prompting the signer to enter the password. - `phone` object: Text for phone/SMS-protected invites. - `body-text` object: Text displayed for phone/SMS-protected invites. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `password` object: Text for password-protected invites. - `body-text` object: Text displayed for password-protected invites. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `header-text` object: Header text displayed to the signer on the authentication page. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Header text in English. - `es` string: Header text in Spanish. - `fr` string: Header text in French. - `request-pin` object: Text with instructions for obtaining a password via voice call or SMS. Displayed only for phone/SMS-protected invites. - `body-text` object: Text displayed to the signer with instructions for obtaining a password. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `navigation` object: Navigation object that contains attributes for the navigation elements. - `visibility` boolean: Whether to show or hide the navigation elements. - `sender-info` object: Sender contact details shown to the signer, and their visibility. - `visibility` boolean: Whether the **Contact Sender** option on the **More Actions** menu should be visible or not. - `contact-name` string: The name of the sender that should appear if a signer clicks **Contact Sender**. - `contact-email` string: The email of the sender that should appear if a signer clicks **Contact Sender**. - `close-button` object: Object that defines the visibility and text for the closing options. - `title` object: Text for the closing options in the signing session, embedded sending, and embedded editor modes. - `editor` object: Text of the **Save and Close** button in the editor. Available for the embedded editor and embedded sending modes. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Button title in English. - `es` string: Button title in Spanish. - `fr` string: Button title in French. - `signing` object: Text of the **Save Progress and Finish Later** option during the signing session. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English for signing session. - `es` string: Text in Spanish for signing session. - `fr` string: Text in French for signing session. - `visibility` boolean: Whether the **Close** button (in the header in view mode) or **Save progress and Finish Later** option (in the **More Actions** menu during the signing session) should be visible. - `progress-bar` object: Progress bar object that contains attributes for the progress bar elements. - `default-color` string: Default color of the progress bar. - `completed-color` string: Progress bar color when the signer has completed or partially completed the invite to sign. - `support-chat` object: Configuration of the support chat in the editor. - `visibility` boolean: Whether the support chat icon should be visible or not. - `accessibility` object: Accessibility object that contains attributes for the accessibility button. - `color` string: Text color of the button in HEX color code. - `border` string: Border color of the button in HEX color code. - `enabled` boolean: Whether to enable or disable the accessibility mode. By default accessibility is off. - `background` string: Background color of the button in HEX color code. - `visibility` boolean: Whether to show or hide the accessibility option in the **More Actions** menu. - `hover-color` string: Text color of the button in HEX color code when the accessibility button is hovered over. - `active-color` string: Text color of the button in HEX color code when accessibility is on. - `hover-border` string: Border button color in HEX color code when the accessibility button is hovered over. - `active-border` string: Border button color in HEX color code when accessibility is on. - `hover-background` string: Background button color in HEX color code when the accessibility button is hovered over. - `active-background` string: Background button color in HEX color code when accessibility is on. - `complete-page` object: Page that opens after a document is signed or declined. - `decline` object: Text that appears on the page after a signer confirms declining a document. - `body-text` object: Body text of the page shown after a signer declines a document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `header-text` object: Header of the page shown after a signer declines a document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Header text in English. - `es` string: Header text in Spanish. - `fr` string: Header text in French. - `success` object: Text that appears on the page after a signer completes a document. - `body-text` object: Body text of the page shown after a signer completes a document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `header-text` object: Header of the page shown after a signer completes a document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Header text in English. - `es` string: Header text in Spanish. - `fr` string: Header text in French. - `registration` object: Configuration of the registration option on the completion page. - `visibility` boolean: Whether the registration button on the completion page should be visible or not for new users. - `button-download` object: Configuration of the download button on the completion page. - `visibility` boolean: Whether the button to download a document on the completion page should be visible or not. - `button-to-signnow` object: Configuration of the button that takes the signer to SignNow from the completion page. - `visibility` boolean: Whether the button with a link to signNow on the completion page should be visible or not. - `document-name` object: Configuration of the document name. Available for embedded signing, embedded sending (in the editor), embedded editor, FreeForm invite, and embedded view. - `visibility` boolean: Whether to show the document name in the header. - `editing-tools` object: Configuration of the left-side editing tools panel. Available for embedded sending, embedded editor, and FreeForm invite. - `background` string: Background color of the editing tools panel in HEX color code. - `decline-button` object: Configuration of the decline option available to the recipient. - `visibility` boolean: Whether the **Decline** option should be visible in the **More Actions** menu. - `default-fields` object: Configuration of the **Default fields** tab. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Default fields tab in the left sidebar. When set to `false`, the Custom fields tab becomes the only tab and the Default / Custom fields tab switcher disappears. The default value is `true`. - `field-settings` object: Configuration of the **Element settings** in the right sidebar, where users customize field settings. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Element settings button on the right side of the header. The default value is `true`. - `page-dimension` object: Default zoom level of document pages in the editor. - `percent` integer: The dimension of the signing session page when it is opened in percents. - `preview-button` object: Configuration of the **Open Preview** button in the toolbar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Open Preview button in the toolbar. - `complete-footer` object: Footer shown to the signer after all required fields are completed. - `visibility` boolean: Whether the footer about completion of all the required fields should be visible or not. - `custom-text` object: Text of the footer shown after all required fields are completed. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Footer text in English. - `es` string: Footer text in Spanish. - `fr` string: Footer text in French. - `continue-button` object: Configuration of the **Continue** button. Available for embedded sending. - `visibility` boolean: Whether to show the Continue button in the header. - `download-button` object: Configuration of the download option for the recipient. - `visibility` boolean: Defines the visibility of the **Download** and **History** buttons during the signing session and **Download**, **Download With History** and **Document History** buttons in view mode. - `request-payment` object: Configuration of the request payment option in the editor. Available for embedded sending and embedded editor. - `visibility` boolean: `true` if the payment request option is shown. - `signing-settings` object: Settings configured for the signing experience. - `guide-signers-only-through-required-fields` boolean: Whether to guide signers through required fields only. `true` - the **Go Through Required Fields** checkbox is checked in **More Actions**; the signer will be guided only through required fields; `false` – the **Go Through Required Fields** checkbox is not checked in **More Actions**; the signer will be guided through all fields. - `auto-apply-signatures-and-initials-to-document-fields` boolean: Whether to offer a signer to automatically apply signature and initials to all corresponding empty fields in a document after filling out the first field. `true` – the signer will be prompted to automatically fill all empty signature and initials fields after completing the first one; `false` – the signer will need to fill each signature and initials field individually; no prompt will be shown. - `manage-recipients` object: Configuration of the **Manage Recipients** link. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Manage Recipients link. - `step-progress-bar` object: Configuration of the steps progress bar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the steps progress bar in the header. - `thumbnails-button` object: Configuration of the **Thumbnails** button in the toolbar. Available for embedded sending and embedded editor. - `visibility` boolean: Whether to show the Thumbnails button in the toolbar. - `decline-invite-text` object: Message in the pop-up that appears when a signer clicks the **Decline** button. The signer needs to confirm declining the document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Decline confirmation message in English. - `es` string: Decline confirmation message in Spanish. - `fr` string: Decline confirmation message in French. ## Other responses - `400`: * Wrong, expired, or missing token. - `403`: * Request with a valid bearer token from another user logged in. * The user is authorized with a token from an app they don’t own. - `404`: * Brand with this `brand_id` doesn't exist. * Resource doesn't exist. --- [API](https://skmtc.dev/signnow/apis/signnow-api.md) - [All operations](https://skmtc.dev/signnow/apis/signnow-api/llms.txt) - [OpenAPI document](https://skmtc.dev/signnow/apis/signnow-api/revisions/1c9c30a6142b?raw)