> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.goodflag.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.goodflag.com/_mcp/server.

# Consulter un modèle de parapheur

GET https://workflow-manager/api/templates/{templateId}

Renvoie un modèle de parapheur existant.

Aucun. Autorisés : tout utilisateur du tenant.

Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/workflow-templates/retrieve-workflow-template

## Authentication

- `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer <token>`.

## Request

### Path parameters

- `templateId` (string, required) — L'identifiant du modèle de parapheur.

## Response

### 200

Consulter un modèle de parapheur

- `layoutSelectionMode` (enum, required) — Valeurs possibles : list, listOrNull, any ou anyOrNull.
  - Allowed values: `any`, `anyOrNull`, `list`, `listOrNull`
- `steps` (list of object, required) — Les étapes du modèle de parapheur.
  - `stepType` (enum, required) — Le type de l'étape : signature ou approval.
    - Allowed values: `approval`, `signature`
  - `recipientSelectionMode` (enum, required) — Valeurs possibles : list, any ou group.
    - Allowed values: `any`, `list`
  - `id` (string, required) — L'identifiant de l'étape.
  - `maxRecipients` (double, required) — Le nombre maximal de destinataires de l'étape.
  - `allowedConsentPages` (list of any, required) — La liste des pages de consentement utilisables dans l'étape.
  - `requiredRecipients` (double, required) — Le nombre de destinataires devant signer ou valider les documents pour que l'étape se termine.
  - `validityPeriod` (double, required) — La durée de validité de l'étape.
  - `invitePeriod` (double, required) — Le délai après lequel les invitations sont renvoyées.
  - `maxInvites` (double, required) — Le nombre maximal d'invitations envoyées aux destinataires. La valeur 0 signifie que le destinataire n'est jamais invité.
  - `sendDownloadLink` (boolean, required) — Indique si les signataires ou les validateurs reçoivent un lien de téléchargement des documents signés à la fin du parapheur.
  - `readonly` (boolean, required) — Indique si l'étape est en lecture seule.
  - `removable` (boolean, required) — Indique si l'étape est supprimable.
  - `allowComments` (boolean, required) — Indique si les destinataires de l'étape sont autorisés à consulter et créer des commentaires.
  - `hideAttachments` (boolean, required) — Indique si les pièces jointes sont affichées aux destinataires de l'étape.
  - `viewConfidentialAttachments` (boolean, required) — Indique si les pièces jointes confidentielles sont affichées aux destinataires de l'étape.
  - `hideWorkflowRecipients` (boolean, required) — Indique si les autres destinataires du parapheur sont visibles par les destinataires de cette étape.
  - `recipients` (list of object, optional) — La liste des destinataires appelés à signer ou valider les documents, lorsque recipientSelectionMode vaut list ou any.
    - `consentPageId` (string, required) — L'identifiant de la page de consentement à utiliser pour la requête.
    - `email` (string, required) — L'adresse email du destinataire.
    - `userId` (string, optional) — L'identifiant de l'utilisateur destinataire, lorsque le destinataire est un utilisateur.
    - `pictureResourceId` (string, optional) — L'identifiant de la ressource photo de l'utilisateur, lorsque le destinataire est un utilisateur.
    - `phoneNumber` (string, optional) — Le numéro de téléphone international du destinataire.
    - `comments` (string, optional) — Les commentaires associés au contact.
    - `firstName` (string, optional) — Le prénom du destinataire.
    - `lastName` (string, optional) — Le nom du destinataire.
    - `country` (string, optional) — Le pays de l'utilisateur.
    - `organizationId` (string, optional) — L'identifiant de l'organisation pour le compte de laquelle la signature est apposée.
    - `preferredLocale` (string, optional) — La locale préférée pour les emails de notification envoyés au destinataire.
  - `allowedGroups` (list of any, optional) — La liste des groupes de destinataires appelés à signer ou valider les documents, lorsque recipientSelectionMode vaut group.
- `documentSelectionMode` (enum, required) — Valeurs possibles : list ou any.
  - Allowed values: `list`, `any`
- `coManagerSelectionMode` (enum, required) — Valeurs possibles : none, list, any ou anyOrNull.
  - Allowed values: `any`, `anyOrNull`, `list`, `none`
- `allowConsolidation` (boolean, required) — Indique si la consolidation du parapheur est activée.
- `allowManagerAddStep` (boolean, required) — Indique si le gestionnaire peut ajouter de nouvelles étapes.
- `allowedLayouts` (list of string, required) — La liste des dispositions de parapheur utilisables dans le parapheur.
- `allowedSignatureProfiles` (list of string, required) — La liste des profils de signature autorisés pour signer les documents.
- `coManagerCanEditCoManager` (boolean, required) — Indique si les événements du cogestionnaire sont modifiables par un cogestionnaire.
- `coManagerNotifiedEvents` (list of string, required) — Les types d'événements pour lesquels le cogestionnaire reçoit des notifications.
- `coManagerNotifiedEventsReadonly` (boolean, required) — Indique si les événements notifiés au cogestionnaire sont en lecture seule.
- `coManagerUsersModifiable` (boolean, required) — Indique si les événements notifiés au cogestionnaire sont modifiables.
- `created` (long, required) — La date de création de l'entité.
- `id` (string, required) — L'identifiant du modèle de parapheur.
- `isDisabled` (boolean, required) — Indique si le modèle de parapheur est désactivé.
- `maxAttachments` (long, required, default: 10) — Le nombre maximal de pièces jointes.
- `maxDocuments` (long, required, default: 200) — Le nombre maximal de documents à signer.
- `maxWatchers` (long, required) — Le nombre maximal d'observateurs.
- `name` (string, required) — Le nom du modèle de parapheur.
- `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels le propriétaire reçoit des notifications.
- `notifiedEventsReadonly` (boolean, required) — Indique si les événements notifiés sont en lecture seule.
- `tenantId` (string, required) — L'identifiant du tenant auquel appartient le modèle de parapheur.
- `updated` (long, required) — La date de dernière modification de l'entité.
- `watchers` (list of object, required) — La liste des observateurs du parapheur.
  - `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels l'observateur reçoit des notifications.
  - `readonly` (boolean, required) — Indique si l'observateur est en lecture seule.
  - `removable` (boolean, required) — Indique si l'observateur est supprimable.
  - `email` (string, optional) — L'adresse email de l'observateur, lorsqu'il n'est pas un utilisateur.
  - `userId` (string, optional) — L'identifiant de l'utilisateur, lorsque l'observateur est un utilisateur.
- `allowedCoManagerGroups` (list of any, optional) — La liste des groupes dont les membres peuvent être désignés cogestionnaires du parapheur.
- `allowedCoManagerUsers` (list of any, optional) — La liste des cogestionnaires pouvant être désignés sur le parapheur.
- `description` (string, optional) — La description du modèle de parapheur.
- `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution.

## Errors

### 403 Forbidden Error

AuthenticatedUserDisabled : L'utilisateur authentifié est désactivé. ; MissingBearerToken : Un jeton Bearer est requis. ; TenantInactive : Le tenant est inactif et n'autorise aucune opération. ; UserGroupDisabled : Le groupe de l'utilisateur spécifié est désactivé. ; UserNotAllowed : L'utilisateur authentifié n'est pas autorisé à effectuer cette opération.

- `status` (integer, required) — Le code de statut HTTP.
- `error` (string, required) — Le message de statut HTTP.
- `message` (string, required) — Le message d'erreur.
- `code` (string, required) — Le code d'erreur.

### 404 Not Found Error

WorkflowTemplateNotFound : Le modèle de parapheur spécifié est introuvable.

- `status` (integer, required) — Le code de statut HTTP.
- `error` (string, required) — Le message de statut HTTP.
- `message` (string, required) — Le message d'erreur.
- `code` (string, required) — Le code d'erreur.

## Examples

**Response**

```json
{
  "layoutSelectionMode": "list",
  "steps": [
    {
      "stepType": "signature",
      "recipientSelectionMode": "list",
      "id": "stp_QKkU85549V9UteCjChPWhHn7",
      "maxRecipients": 1,
      "allowedConsentPages": [],
      "requiredRecipients": 1,
      "validityPeriod": 8553600000,
      "invitePeriod": 86400000,
      "maxInvites": 5,
      "sendDownloadLink": true,
      "readonly": false,
      "removable": true,
      "allowComments": true,
      "hideAttachments": false,
      "viewConfidentialAttachments": true,
      "hideWorkflowRecipients": false,
      "recipients": [
        {
          "consentPageId": "cop_AfGTsGSh1mmatSUL5AWFo2Do",
          "email": "keeley.brown2482@my-company.com",
          "userId": "usr_KG8yTeqRa1kskaSp7Y7GRPAB",
          "pictureResourceId": "res_4Z7qYs9LrDsZ5v293CLMGJYb",
          "phoneNumber": "+33 6 12 34 56 78",
          "comments": "Aliquam et numquam voluptatem enim est illo.",
          "firstName": "Kent",
          "lastName": "Barton",
          "country": "FR",
          "organizationId": "org_i3niMbz4WCYkMgYe9y7KnHgv",
          "preferredLocale": "fr"
        }
      ],
      "allowedGroups": []
    }
  ],
  "documentSelectionMode": "any",
  "coManagerSelectionMode": "none",
  "allowConsolidation": true,
  "allowManagerAddStep": true,
  "allowedLayouts": [
    "lay_JSyVFZirokNH1UhNQLtjGGME"
  ],
  "allowedSignatureProfiles": [
    "sip_Gqm6QHpCFxuaqqk88gsKNBvk"
  ],
  "coManagerCanEditCoManager": false,
  "coManagerNotifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "coManagerNotifiedEventsReadonly": false,
  "coManagerUsersModifiable": true,
  "created": 1782821288845,
  "id": "wtm_QELjCwLJmgvCzNEUy7JH1yAa",
  "isDisabled": false,
  "maxAttachments": 5,
  "maxDocuments": 10,
  "maxWatchers": 6,
  "name": "Awesome Rubber Bench",
  "notifiedEvents": [
    "recipientRefused",
    "recipientFinished",
    "workflowStopped",
    "workflowFinished"
  ],
  "notifiedEventsReadonly": false,
  "tenantId": "ten_Hm5gqY6oKADYdg9cjhsVbQDH",
  "updated": 1782821288845,
  "watchers": [
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": true,
      "removable": false,
      "email": "mickey.wiegand1449@my-company.com"
    },
    {
      "notifiedEvents": [
        "recipientRefused",
        "recipientFinished",
        "workflowStarted",
        "workflowStopped",
        "workflowFinished",
        "workflowFinishedDownloadLink",
        "workflowFinishedDownloadLinkNoAttachment"
      ],
      "readonly": false,
      "removable": true,
      "userId": "usr_3EDGspNESZNdTC8wQFY6zigh"
    }
  ],
  "allowedCoManagerGroups": [],
  "allowedCoManagerUsers": [],
  "description": "Apt. 480, 9814 Impasse Monsieur-le-Prince, 55936 Aix-en-Provence"
}
```

**SDK Code**

```python Requête réussie.
import requests

url = "https://workflow-manager/api/templates/templateId"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript Requête réussie.
const url = 'https://workflow-manager/api/templates/templateId';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Requête réussie.
package main

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

func main() {

	url := "https://workflow-manager/api/templates/templateId"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Requête réussie.
require 'uri'
require 'net/http'

url = URI("https://workflow-manager/api/templates/templateId")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java Requête réussie.
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://workflow-manager/api/templates/templateId")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Requête réussie.
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://workflow-manager/api/templates/templateId', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Requête réussie.
using RestSharp;

var client = new RestClient("https://workflow-manager/api/templates/templateId");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Requête réussie.
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/templates/templateId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```