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>'
import requests

url = "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings"

headers = {"Authorization": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: '<api-key>'}};

fetch('https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")
  .header("Authorization", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.firma.dev/functions/v1/signing-request-api/workspace/{workspace_id}/settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "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,
  "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",
  "email_local_part": "signatures"
}
{
  "error": "Unauthorized",
  "message": "Invalid API key"
}
{
  "error": "Not Found",
  "message": "The requested resource was not found"
}
{
  "error": "Rate Limit Exceeded",
  "message": "Too many requests. Please wait before retrying.",
  "details": {
    "retry_after": 45
  }
}

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

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

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