Signlift

Branding Profiles

Les chartes graphiques applicables au parcours de signature.

GET /api/v1/branding_profiles

Liste les profils de marque de votre organisation — les valeurs acceptées par branding_profile_id à la création d'une demande de signature.

Sans cet endpoint, ces identifiants n'étaient découvrables que depuis le dashboard. Il sert surtout à alimenter un sélecteur côté intégration, ou à valider un identifiant avant de l'envoyer.

Portée

Contrairement aux documents et aux demandes de signature, les profils ne sont pas cloisonnés par environnement : ce sont des réglages d'organisation, et les mêmes profils répondent sur une clé sandbox comme sur une clé production.

La collection est triée par name et paginée comme les autres (voir Collections paginées). Elle n'accepte pas de filtre.

Exemple

curl https://app.signlift.eu/api/v1/branding_profiles \
  -H "X-Api-Key: $SIGNLIFT_API_KEY"

Réponse 200

{
  "data": [
    {
      "id": 7,
      "name": "Contrats commerciaux",
      "background_color": "#f3eee5",
      "text_color": "#173039",
      "accent_color": "#e89669"
    }
  ],
  "pagination": { "page": 1, "limit": 20, "count": 1, "pages": 1 }
}

Les trois couleurs sont des hexadécimaux, appliqués au parcours du signataire : background_color en fond, text_color pour le texte, accent_color sur les éléments d'action.

Le même objet est renvoyé dans le champ branding_profile de toute signature_request qui en utilise un — voir Signature Requests.

On this page