Passer au contenu principal
GET
@firma-dev/sdk

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.