Passer au contenu principal
GET
/
workspace
/
{workspace_id}
/
settings
@firma-dev/sdk
import { FirmaClient } from "@firma-dev/sdk";

const firma = new FirmaClient({ apiKey: "YOUR_API_KEY" });

const response = await firma.workspaceSettings.getWorkspaceSettings({
    workspace_id: "workspace_id"
});
console.log(response);
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,
  "require_terms_acceptance": true,
  "disable_guided_navigation": true,
  "show_signature_frame": true,
  "allow_presigning_download": true,
  "show_partial_watermark": true,
  "show_qr_code": 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",
  "signing_button_label_overrides": {}
}
{
"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
}
}

Autorisations

Authorization
string
header
requis

Clé API pour l'authentification. Utilisez votre clé API directement sans préfixe (par exemple, 'your-api-key'). Le préfixe Bearer est optionnel mais pas obligatoire.

Paramètres de chemin

workspace_id
string<uuid>
requis

Réponse

Paramètres de l'espace de travail récupérés avec succès

workspace_id
string<uuid>
requis
name
string

Nom de l'espace de travail

team_email
string<email>

Email de contact de l'espace de travail

timezone
string

Fuseau horaire de l'espace de travail

language
enum<string>
défaut:en

Langue de l'espace de travail pour les modèles d'email

Options disponibles:
en,
es,
it,
pt,
fr,
de,
el,
ru,
pl
signing_request_email_header
string

Texte d'en-tête d'email personnalisé

signing_request_email_body
string

Corps d'email HTML personnalisé

show_credit_cost_in_editor
boolean
défaut:true

Indique s'il faut afficher le coût en crédits dans les éditeurs intégrés de modèles et de demandes de signature

require_otp_verification
boolean | null

Indique si les signataires doivent vérifier leur email via OTP avant d'accéder aux documents. null = hériter du paramètre de l'entreprise, true = exiger l'OTP, false = ne pas exiger l'OTP

require_terms_acceptance
boolean | null

Indique si les signataires doivent accepter les conditions avant de signer. null hérite du paramètre au niveau de l'entreprise.

disable_guided_navigation
boolean | null

Désactiver le défilement automatique vers le prochain champ obligatoire pendant la signature. Hérite de l'espace de travail ou de l'entreprise si non défini.

show_signature_frame
boolean | null

Indique s'il faut afficher un cadre visuel avec l'ID de Signature autour des signatures dans les PDF finalisés. null = hériter du paramètre de l'entreprise (activé par défaut), true = afficher le cadre, false = masquer le cadre

allow_presigning_download
boolean | null

Autoriser les signataires à télécharger le document original avant de signer. null hérite du paramètre au niveau de l'entreprise.

show_partial_watermark
boolean | null

Afficher un filigrane EN COURS sur les téléchargements de PDF partiels lorsque tous les signataires n'ont pas terminé. null hérite du paramètre au niveau de l'entreprise.

show_qr_code
boolean | null

Afficher un QR code sur la page de signature permettant aux signataires de continuer sur leur téléphone. null hérite du paramètre au niveau de l'entreprise.

color_primary
string | null

Couleur primaire personnalisée (hex #rrggbb). Null pour hériter de l'entreprise.

Exemple:

"#2563eb"

color_primary_fg
string | null

Couleur de premier plan primaire personnalisée. Null pour hériter.

Exemple:

"#ffffff"

color_background
string | null

Couleur d'arrière-plan personnalisée. Null pour hériter.

Exemple:

"#0f172a"

color_foreground
string | null

Couleur de premier plan/texte personnalisée. Null pour hériter.

Exemple:

"#ffffff"

color_card
string | null

Couleur d'arrière-plan des cartes personnalisée. Null pour hériter.

Exemple:

"#22222a"

color_border
string | null

Couleur de bordure personnalisée. Null pour hériter.

Exemple:

"#3b3b3b"

color_accent
string | null

Couleur d'accent de l'interface de l'éditeur. Null pour hériter.

Exemple:

"#34eeff"

color_accent_fg
string | null

Couleur de premier plan sur les surfaces d'accent. Null pour hériter.

Exemple:

"#000000"

color_canvas
string | null

Couleur de l'entourage du canevas de document dans l'éditeur. Null pour hériter.

Exemple:

"#0f1419"

color_muted
string | null

Couleur de surface atténuée. Null pour hériter.

Exemple:

"#22222a"

color_muted_fg
string | null

Couleur de texte atténuée. Null pour hériter.

Exemple:

"#b8b8b8"

email_local_part
string | null

La partie locale (avant le @) de l'adresse email de l'expéditeur. Null pour hériter du paramètre de l'entreprise. S'applique uniquement quand un domaine personnalisé vérifié est configuré.

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

"signatures"

signing_button_label_overrides
object | null

Libellés de boutons personnalisés par langue pour la vue de signature. Les clés sont des codes de langue (en, de, etc.) ; les valeurs sont des objets associant des clés de traduction à un texte personnalisé. Null pour utiliser les valeurs par défaut.