Skip to main content
GET
@firma-dev/sdk

Authorizations

Authorization
string
header
required

API key for authentication. Use your API key directly without any prefix (e.g., 'your-api-key'). Bearer prefix is optional but not required.

Path Parameters

workspace_id
string<uuid>
required

Response

Workspace settings retrieved successfully

workspace_id
string<uuid>
required
name
string

Workspace name

team_email
string<email>

Workspace contact email

timezone
string

Workspace timezone

language
enum<string>
default:en

Workspace language for email templates

Available options:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
signing_request_email_header
string

Custom email header text

signing_request_email_body
string

Custom HTML email body

show_credit_cost_in_editor
boolean
default:true

Whether to display credit cost in embedded template and signing request editors

require_otp_verification
boolean | null

Whether signers must verify their email via OTP before accessing documents. null = inherit from company setting, true = require OTP, false = do not require OTP

require_terms_acceptance
boolean | null

Whether signers must accept terms before signing. null inherits the company-level setting.

disable_guided_navigation
boolean | null

Disable automatic scrolling to the next required field during signing. Inherits from workspace or company if not set.

show_signature_frame
boolean | null

Whether to render a visual frame with Signature ID around signatures in completed PDFs. null = inherit from company setting (default enabled), true = show frame, false = hide frame

allow_presigning_download
boolean | null

Allow signers to download the original document before signing. null inherits the company-level setting.

show_partial_watermark
boolean | null

Show an IN PROGRESS watermark on partial PDF downloads when not all signers have completed. null inherits the company-level setting.

show_qr_code
boolean | null

Show a QR code on the signing page that lets signers continue on their phone. null inherits the company-level setting.

color_primary
string | null

Primary color override (#rrggbb hex). Null to inherit from company.

Example:

"#2563eb"

color_primary_fg
string | null

Primary foreground color override. Null to inherit.

Example:

"#ffffff"

color_background
string | null

Background color override. Null to inherit.

Example:

"#0f172a"

color_foreground
string | null

Foreground/text color override. Null to inherit.

Example:

"#ffffff"

color_card
string | null

Card background color override. Null to inherit.

Example:

"#22222a"

color_border
string | null

Border color override. Null to inherit.

Example:

"#3b3b3b"

color_accent
string | null

Editor chrome accent color. Null to inherit.

Example:

"#34eeff"

color_accent_fg
string | null

Foreground color on accent surfaces. Null to inherit.

Example:

"#000000"

color_canvas
string | null

Editor document-canvas surround color. Null to inherit.

Example:

"#0f1419"

color_muted
string | null

Muted surface color. Null to inherit.

Example:

"#22222a"

color_muted_fg
string | null

Muted text color. Null to inherit.

Example:

"#b8b8b8"

email_local_part
string | null

The local-part (before the @) of the sender email address. Null to inherit from company setting. Only applies when a verified custom domain is configured.

Required string length: 1 - 64
Pattern: ^[a-z0-9]([a-z0-9._-]*[a-z0-9])?$
Example:

"signatures"

signing_button_label_overrides
object | null

Per-language custom button labels for the signing view. Keys are language codes (en, de, etc.); values are objects mapping translation keys to custom text. Null to use defaults.