> 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

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

Recherche dans tous les documents de parapheur.

`workflowViewer` OU `workflowManager`

Également autorisés sans rôle : les membres d'un groupe autorisé, les utilisateurs du parapheur, le propriétaire.

Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/workflow-documents/search-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.layoutId` (string, optional) — La ou les valeurs de filtre du champ layoutId.
- `items.groupId` (string, optional) — La ou les valeurs de filtre du champ groupId.
- `items.userId` (string, optional) — La ou les valeurs de filtre du champ userId.
- `items.workflowId` (string, optional) — La ou les valeurs de filtre du champ workflowId.
- `items.workflowHash` (string, optional) — La ou les valeurs de filtre du champ workflowHash.
- `items.workflowName` (string, optional) — La ou les valeurs de filtre du champ workflowName.
- `items.data1` (string, optional) — La ou les valeurs de filtre du champ data1.
- `items.data2` (string, optional) — La ou les valeurs de filtre du champ data2.
- `items.data3` (string, optional) — La ou les valeurs de filtre du champ data3.
- `items.data4` (string, optional) — La ou les valeurs de filtre du champ data4.
- `items.data5` (string, optional) — La ou les valeurs de filtre du champ data5.
- `items.data6` (string, optional) — La ou les valeurs de filtre du champ data6.
- `items.data7` (string, optional) — La ou les valeurs de filtre du champ data7.
- `items.data8` (string, optional) — La ou les valeurs de filtre du champ data8.
- `items.data9` (string, optional) — La ou les valeurs de filtre du champ data9.
- `items.data10` (string, optional) — La ou les valeurs de filtre du champ data10.
- `items.data11` (string, optional) — La ou les valeurs de filtre du champ data11.
- `items.data12` (string, optional) — La ou les valeurs de filtre du champ data12.
- `items.data13` (string, optional) — La ou les valeurs de filtre du champ data13.
- `items.data14` (string, optional) — La ou les valeurs de filtre du champ data14.
- `items.data15` (string, optional) — La ou les valeurs de filtre du champ data15.
- `items.data16` (string, optional) — La ou les valeurs de filtre du champ data16.
- `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.viewAuthorizedGroups` (string, optional) — La ou les valeurs de filtre du champ viewAuthorizedGroups.
- `items.viewAuthorizedUsers` (string, optional) — La ou les valeurs de filtre du champ viewAuthorizedUsers.
- `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 Document.

- `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. Sans valeur spécifiée, l'URL de la politique de signature par défaut est appliquée.
    - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie.
  - `groupId` (string, required) — L'identifiant du groupe auquel appartient le document.
  - `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. Sans valeur spécifiée, l'URL de la politique de signature par défaut est appliquée.
    - `visualIdentification` (string, optional) — L'identification visuelle appliquée à la partie.
  - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le document.
  - `updated` (long, required) — La date de dernière modification de l'entité.
  - `userId` (string, required) — L'identifiant de l'utilisateur auquel appartient le document.
  - `viewAuthorizedGroups` (list of string, required) — La liste des identifiants de groupes dont les membres peuvent consulter le parapheur auquel appartient le document.
  - `viewAuthorizedUsers` (list of string, required) — La liste des identifiants d'utilisateurs autorisés à consulter le parapheur auquel appartient le document.
  - `workflowId` (string, required) — L'identifiant du parapheur auquel appartient le document.
  - `workflowName` (string, required) — Le nom du parapheur auquel appartient le document.
  - `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 dans les dossiers.
  - `data1` (string, optional) — La valeur du champ de métadonnée data1.
  - `data2` (string, optional) — La valeur du champ de métadonnée data2.
  - `data3` (string, optional) — La valeur du champ de métadonnée data3.
  - `data4` (string, optional) — La valeur du champ de métadonnée data4.
  - `data5` (string, optional) — La valeur du champ de métadonnée data5.
  - `data6` (string, optional) — La valeur du champ de métadonnée data6.
  - `data7` (string, optional) — La valeur du champ de métadonnée data7.
  - `data8` (string, optional) — La valeur du champ de métadonnée data8.
  - `data9` (string, optional) — La valeur du champ de métadonnée data9.
  - `data10` (string, optional) — La valeur du champ de métadonnée data10.
  - `data11` (string, optional) — La valeur du champ de métadonnée data11.
  - `data12` (string, optional) — La valeur du champ de métadonnée data12.
  - `data13` (string, optional) — La valeur du champ de métadonnée data13.
  - `data14` (string, optional) — La valeur du champ de métadonnée data14.
  - `data15` (string, optional) — La valeur du champ de métadonnée data15.
  - `data16` (string, optional) — La valeur du champ de métadonnée data16.

## 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"
        }
      ],
      "groupId": "string",
      "id": "string",
      "parts": [
        {
          "contentType": "string",
          "filename": "string",
          "hash": "string",
          "size": 1,
          "isOriginal": true,
          "policyUri": "string",
          "visualIdentification": "string"
        }
      ],
      "tenantId": "string",
      "updated": 1,
      "userId": "string",
      "viewAuthorizedGroups": [
        "string"
      ],
      "viewAuthorizedUsers": [
        "string"
      ],
      "workflowId": "string",
      "workflowName": "string",
      "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,
      "data1": "string",
      "data2": "string",
      "data3": "string",
      "data4": "string",
      "data5": "string",
      "data6": "string",
      "data7": "string",
      "data8": "string",
      "data9": "string",
      "data10": "string",
      "data11": "string",
      "data12": "string",
      "data13": "string",
      "data14": "string",
      "data15": "string",
      "data16": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

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

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

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

print(response.json())
```

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

	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/documents")

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/documents")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

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

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

```csharp
using RestSharp;

var client = new RestClient("https://workflow-manager/api/documents");
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/documents")! 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()
```