Skip to main content
GET
/
workspace
/
{workspace_id}
/
settings
Get workspace settings
curl --request GET \
  --url https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings \
  --header 'Authorization: <api-key>'
{
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "team_email": "jsmith@example.com",
  "timezone": "<string>",
  "language": "en",
  "signing_request_email_header": "<string>",
  "signing_request_email_body": "<string>",
  "show_credit_cost_in_editor": true,
  "require_otp_verification": true,
  "require_terms_acceptance": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "color_primary": "#2563eb",
  "color_primary_fg": "#ffffff",
  "color_background": "#0f172a",
  "color_foreground": "#ffffff",
  "color_card": "#22222a",
  "color_border": "#3b3b3b",
  "color_accent": "#34eeff",
  "color_accent_fg": "#000000",
  "color_canvas": "#0f1419",
  "color_muted": "#22222a",
  "color_muted_fg": "#b8b8b8",
  "email_local_part": "signatures",
  "show_partial_watermark": true,
  "allow_presigning_download": true,
  "show_qr_code": true,
  "signing_button_label_overrides": {
    "en": {
      "common.finish": "Confirm",
      "signing.decline.confirm": "I Refuse"
    },
    "de": {
      "common.finish": "Bestätigen"
    }
  }
}

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>
​
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

​
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"

​
show_partial_watermark
boolean | null

Show an IN PROGRESS watermark on partial PDF downloads when not all signers have completed. Inherits from company settings when null.

​
allow_presigning_download
boolean | null

Allow signers to download the original document before signing. Inherits from company settings when null.

​
show_qr_code
boolean | null

Show a QR code on the signing page that allows signers to continue on their phone. Inherits from company settings when null.

​
signing_button_label_overrides
object

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. Set to null to use defaults.

Example:
{
  "en": {
    "common.finish": "Confirm",
    "signing.decline.confirm": "I Refuse"
  },
  "de": { "common.finish": "Bestätigen" }
}