> 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.

# Rechercher des documents de modèle

GET https://workflow-manager/api/templateDocuments

Recherche dans tous les documents de modèle de parapheur.

Aucun. Autorisés : tout utilisateur du tenant.

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

## Authentication

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

## Request

### Query parameters

- `text` (string, optional) — Le texte à rechercher.
- `items.id` (string, optional) — La ou les valeurs de filtre du champ id.
- `items.tenantId` (string, optional) — La ou les valeurs de filtre du champ tenantId.
- `items.templateId` (string, optional) — La ou les valeurs de filtre du champ templateId.
- `items.signatureProfileId` (string, optional) — La ou les valeurs de filtre du champ signatureProfileId.
- `items.confidentiality` (string, optional) — La ou les valeurs de filtre du champ confidentiality.
- `items.created` (string, optional) — La ou les valeurs de filtre du champ created.
- `items.updated` (string, optional) — La ou les valeurs de filtre du champ updated.
- `sortBy` (string, optional) — Le champ utilisé pour trier le résultat de la recherche.
- `sortOrder` (enum, optional) — L'ordre de tri du résultat de la recherche.
  - Allowed values: `ASC`, `DESC`
- `itemsPerPage` (integer, optional, default: 50) — Le nombre d'éléments par page à renvoyer.
- `pageIndex` (integer, optional, default: 0) — L'index de la page à renvoyer.

## Response

### 200

Une page d'entités TemplateDocument.

- `pageIndex` (integer, optional) — L'index de la page.
- `itemsPerPage` (integer, optional) — Le nombre d'éléments par page.
- `totalItems` (integer, optional) — Le nombre total d'éléments, toutes pages comprises.
- `items` (list of object, optional)
  - `created` (long, required) — La date de création de l'entité.
  - `displayedParts` (list of object, required) — Les parties du document affichées à l'utilisateur final.
    - `contentType` (string, required) — Le type de contenu de la partie affichée à l'utilisateur final.
    - `filename` (string, required) — Le nom de fichier de la partie affichée à l'utilisateur final.
    - `hash` (string, required) — L'empreinte cryptographique de la partie affichée à l'utilisateur final.
    - `size` (long, required) — La taille de la partie affichée à l'utilisateur final.
    - `isOriginal` (boolean, optional) — Indique si la partie affichée à l'utilisateur final est une partie originale ou modifiée.
    - `policyUri` (string, optional) — L'URL d'accès au PDF de la politique de signature de la partie affichée à l'utilisateur final.
    - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie.
  - `id` (string, required) — L'identifiant du document.
  - `parts` (list of object, required) — Les parties du document.
    - `contentType` (string, required) — Le type de contenu de la partie.
    - `filename` (string, required) — Le nom de fichier de la partie.
    - `hash` (string, required) — L'empreinte cryptographique de la partie.
    - `size` (long, required) — La taille de la partie.
    - `isOriginal` (boolean, optional) — Indique si la partie est une partie originale ou modifiée.
    - `policyUri` (string, optional) — L'URL d'accès au PDF de la politique de signature de la partie.
    - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie.
  - `readonly` (boolean, required) — Indique si le document est en lecture seule.
  - `removable` (boolean, required) — Indique si le document est supprimable.
  - `templateId` (string, required) — L'identifiant du modèle de parapheur auquel appartient le document.
  - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le document.
  - `updated` (long, required) — La date de dernière modification de l'entité.
  - `confidentiality` (boolean, optional) — Le statut de confidentialité des pièces jointes.
  - `orderIndex` (long, optional) — L'index d'ordre permet de personnaliser l'ordre d'affichage des documents.
  - `pdfSignatureFields` (list of object, optional) — Pour un document PDF, la liste des champs de signature que les signataires devront remplir.
    - `imageHeight` (double, optional) — La hauteur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini.
    - `imagePage` (long, optional) — La page du PDF où l'image de signature apparaît, à partir de 1. Une valeur négative compte depuis la dernière page. Ignoré si fieldId est défini.
    - `imageWidth` (double, optional) — La largeur (en pixels) de l'image de signature dans la page PDF. Ignoré si fieldId est défini.
    - `imageX` (double, optional) — La position (en pixels) de l'image de signature dans la page PDF (axe X). Ignoré si fieldId est défini.
    - `imageY` (double, optional) — La position (en pixels) de l'image de signature dans la page PDF (axe Y). Ignoré si fieldId est défini.
    - `fieldId` (string, optional) — L'identifiant du champ de signature existant dans le document PDF.
  - `signatureProfileId` (string, optional) — Le profil de signature utilisé pour signer le document. S'il est absent, le document est une pièce jointe.
  - `subOrderIndex` (long, optional) — L'index de sous-ordre permet de personnaliser l'ordre d'affichage des documents.

## Errors

### 400 Bad Request Error

InvalidFilterField : Un paramètre de filtre porte un nom de champ incorrect. ; InvalidFilterValue : Un paramètre de filtre porte une valeur incorrecte. ; InvalidSortByField : Le paramètre sortBy porte un nom de champ incorrect.

- `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.

### 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.

## Examples

**Response**

```json
{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "created": 1,
      "displayedParts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "id": "string",
      "parts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "readonly": true,
      "removable": true,
      "templateId": "string",
      "tenantId": "string",
      "updated": 1,
      "confidentiality": true,
      "orderIndex": 1,
      "pdfSignatureFields": [
        {
          "imageHeight": 1.1,
          "imagePage": 1,
          "imageWidth": 1.1,
          "imageX": 1.1,
          "imageY": 1.1,
          "fieldId": "string"
        }
      ],
      "signatureProfileId": "string",
      "subOrderIndex": 1
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://workflow-manager/api/templateDocuments"

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

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

print(response.json())
```

```javascript
const url = 'https://workflow-manager/api/templateDocuments';
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
package main

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

func main() {

	url := "https://workflow-manager/api/templateDocuments"

	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
require 'uri'
require 'net/http'

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

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
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

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

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

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

```swift
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/templateDocuments")! 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()
```