--- title: "Get general brand resource" method: GET path: "/v2/brands/{brand_id}/resources/general" --- # Get general brand resource `GET /v2/brands/{brand_id}/resources/general` ## Request - Base URL: `https://api.signnow.com` - URL: `https://api.signnow.com/v2/brands/{brand_id}/resources/general` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) This endpoint allows API users to retrieve the general resource of a brand. ## Response `200` Successful response. - object - `data` object: General resource of the brand. - `icons` object: Icons object that contains attributes for all icons in the resource. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `texts` object: Text object that contains attributes for texts in the resource. - `color` string: Text color in the HEX color code. - `header` object: Header object. Contains attributes for headers. - `background` string: Background color in HEX color code. - `buttons` object: Button object that contains `primary`, `secondary`, `default`, and `dropdown` button attributes. - `default` object: Default button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `primary` object: Primary button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `dropdown` object: Dropdown button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `secondary` object: Secondary button object. - `color` string: Text color in HEX color code. - `border` string: Border color in HEX color code. - `background` string: Background color in HEX color code. - `hover-color` string: Text color in HEX color code when the button is hovered over. - `active-color` string: Text color in HEX color code when the button is active. - `hover-border` string: Border color in HEX color code when the button is hovered over. - `active-border` string: Border color in HEX color code when the button is active. - `hover-background` string: Background color in HEX color code when the button is hovered over. - `active-background` string: Background color in HEX color code when the button is active. - `hyperlink` object: Hyperlink colors for default, hover, and active (clicked) states. Available for embedded sending and embedded editor. - `color` string: Default color of the hyperlink text in HEX color code. - `hover-color` string: Color of the hyperlink text when hovered in HEX color code. - `active-color` string: Color of the hyperlink text when clicked in HEX color code. - `help-center` object: Configuration of the help center menu option. - `visibility` boolean: Whether the button with a link to signNow help center should be visible or not. - `consent-text` object: Consent text that appears when a signer opens the document. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Custom consent text in English that can be updated. Placeholder {sender_email} is available. - `es` string: Custom consent text in Spanish that can be updated. Placeholder {sender_email} is available. - `fr` string: Custom consent text in French that can be updated. Placeholder {sender_email} is available. - `main-background` string: Main background color in HEX color code. - `welcome-message` object: Welcome message that appears when a signer opens the document. - `body-text` object: Welcome message text. Localized in English (`en`), Spanish (`es`), and French (`fr`). - `en` string: Text in English. - `es` string: Text in Spanish. - `fr` string: Text in French. - `visibility` boolean: Whether a welcome message should appear or not. - `header-text` object: Text displayed in the welcome message header. 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. ## 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)