> 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 parapheurs GET https://workflow-manager/api/workflows Recherche dans tous les parapheurs. `workflowViewer` OU `workflowManager` Également autorisés sans rôle : les membres d'un groupe autorisé, les utilisateurs du parapheur, le propriétaire. Également acceptés : jeton d'invitation. Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-portail/workflows/search-workflows ## Authentication - `Authorization` header (bearer token, required) — Authentification Bearer par jeton utilisateur ou jeton d'accès : `Authorization: Bearer `. ## 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.templateId` (string, optional) — La ou les valeurs de filtre du champ templateId. - `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.email` (string, optional) — La ou les valeurs de filtre du champ email. - `items.firstName` (string, optional) — La ou les valeurs de filtre du champ firstName. - `items.lastName` (string, optional) — La ou les valeurs de filtre du champ lastName. - `items.userHash` (string, optional) — La ou les valeurs de filtre du champ userHash. - `items.name` (string, optional) — La ou les valeurs de filtre du champ name. - `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.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.currentRecipientEmails` (string, optional) — La ou les valeurs de filtre du champ currentRecipientEmails. - `items.currentRecipientUsers` (string, optional) — La ou les valeurs de filtre du champ currentRecipientUsers. - `items.recipients.email` (string, optional) — La ou les valeurs de filtre du champ recipients.email. - `items.recipients.userId` (string, optional) — La ou les valeurs de filtre du champ recipients.userId. - `items.recipients.subject` (string, optional) — La ou les valeurs de filtre du champ recipients.subject. - `items.recipients.firstName` (string, optional) — La ou les valeurs de filtre du champ recipients.firstName. - `items.recipients.lastName` (string, optional) — La ou les valeurs de filtre du champ recipients.lastName. - `items.recipients.country` (string, optional) — La ou les valeurs de filtre du champ recipients.country. - `items.recipients.organizationId` (string, optional) — La ou les valeurs de filtre du champ recipients.organizationId. - `items.workflowStatus` (enum, optional) — La ou les valeurs de filtre du champ workflowStatus. - Allowed values: `draft`, `started`, `stopped`, `finished`, `archived` - `items.jobOperation` (string, optional) — La ou les valeurs de filtre du champ jobOperation. - `items.jobErrorCode` (string, optional) — La ou les valeurs de filtre du champ jobErrorCode. - `items.nextClean` (string, optional) — La ou les valeurs de filtre du champ nextClean. - `items.nextProcess` (string, optional) — La ou les valeurs de filtre du champ nextProcess. - `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. - `items.started` (string, optional) — La ou les valeurs de filtre du champ started. - `items.externalArchiveStatus` (string, optional) — La ou les valeurs de filtre du champ externalArchiveStatus. - `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 Workflow. - `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) - `workflowMode` (enum, required) — Le mode du parapheur. - Allowed values: `FULL`, `SINGLE_SIGNER` - `steps` (list of object, required) — Les étapes du parapheur. - `stepType` (enum, required) — Le type de l'étape : signature ou approval. - Allowed values: `approval`, `signature` - `id` (string, required) — L'identifiant de l'étape. - `recipients` (list of object, required) — La liste des destinataires appelés à signer ou valider les documents. - `consentPageId` (string, required) — L'identifiant de la page de consentement à utiliser pour la requête. - `email` (string, required) — L'adresse email du destinataire. - `firstName` (string, required) — Le prénom du destinataire. - `lastName` (string, required) — Le nom du destinataire. - `country` (string, required) — Le pays de l'utilisateur. - `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. - `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. - `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. - `isStarted` (boolean, required) — Indique si l'étape est démarrée. - `isFinished` (boolean, required) — Indique si l'étape est démarrée. - `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. - `logs` (list of any, required) — Les journaux de l'étape. - `requireSupportingDocuments` (boolean, optional) — Indique si le dépôt de pièces justificatives est requis pour cette étape. - `supportingDocumentsList` (string, optional) — La liste des pièces justificatives que le signataire doit fournir (5 au maximum). Requis uniquement si requireSupportingDocuments vaut true. - `supportingDocumentIds` (list of any, optional) — La liste des identifiants des pièces justificatives liées à cette étape. - `supportingDocuments` (list of any, optional) — La liste des pièces justificatives liées à cette étape. - `disableMandatoryViewing` (boolean, optional) — Indique si la consultation obligatoire des documents est désactivée pour cette étape. - `faceToFaceSignature` (boolean, optional) — Indique si l'étape utilise le mode de signature en face-à-face. - `created` (long, required) — La date de création de l'entité. - `currentRecipientEmails` (list of any, required) — La liste des adresses email des destinataires actuellement invités à signer ou valider. - `currentRecipientUsers` (list of any, required) — La liste des utilisateurs destinataires actuellement invités à signer ou valider. - `email` (string, required) — L'adresse email de l'utilisateur propriétaire du parapheur. - `firstName` (string, required) — Le prénom de l'utilisateur propriétaire du parapheur. - `groupId` (string, required) — L'identifiant du groupe auquel appartient le parapheur. - `id` (string, required) — L'identifiant du parapheur. - `lastName` (string, required) — Le nom de l'utilisateur propriétaire du parapheur. - `logs` (list of any, required) — Les journaux du parapheur. - `name` (string, required) — Le nom du parapheur. - `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels le propriétaire reçoit des notifications. - `pictureResourceId` (string, required) — L'identifiant de la ressource photo de l'utilisateur propriétaire du parapheur. - `progress` (long, required) — L'avancement du parapheur. - `tenantId` (string, required) — L'identifiant du tenant auquel appartient le parapheur. - `updated` (long, required) — La date de dernière modification de l'entité. - `userId` (string, required) — L'identifiant de l'utilisateur auquel appartient le parapheur. - `viewAuthorizedGroups` (list of string, required) — La liste des identifiants de groupes dont les membres peuvent consulter ce parapheur. - `viewAuthorizedUsers` (list of string, required) — La liste des identifiants d'utilisateurs autorisés à consulter ce parapheur. - `watchers` (list of object, required) — La liste des utilisateurs autorisés à voir le parapheur et notifiés de ses événements. - `notifiedEvents` (list of string, required) — Les types d'événements pour lesquels l'observateur reçoit des notifications. - `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. - `workflowStatus` (enum, required) — Le statut du parapheur. - Allowed values: `draft`, `started`, `stopped`, `finished`, `archived` - `allowConsolidation` (boolean, optional) — Indique si la consolidation du parapheur est activée. - `allowedCoManagerUsers` (list of any, optional) — La liste des cogestionnaires pouvant être désignés sur le parapheur. - `coManagerNotifiedEvents` (list of any, optional) — Les types d'événements pour lesquels le cogestionnaire reçoit des notifications. - `description` (string, optional) — La description du parapheur. - `layoutId` (string, optional) — La disposition utilisée pour les champs de métadonnées. - `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. - `started` (double, optional) — La date du premier démarrage du parapheur. - `stopped` (double, optional) — La date d'arrêt du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `finished` (double, optional) — La date d'achèvement du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `closed` (double, optional) — La date de clôture du parapheur. (Renseignée uniquement lorsque workflowMode = SINGLE_SIGNER) - `templateId` (string, optional) — L'identifiant du modèle de parapheur. - `dynamicFields` (list of object, optional) — Liste des champs dynamiques. - `id` (string, required) — Identifiant du champ dynamique. - `type` (enum, required) — Type du champ dynamique. Valeurs possibles : TEXT. - Allowed values: `TEXT` - `name` (string, required) — Nom du champ dynamique. - `order` (integer, required) — Ordre du champ dynamique. - `description` (string, optional) — Description du champ dynamique. - `value` (string, optional) — Value of the dynamic field. - `instances` (list of object, optional) — Instances des champs dynamiques. - `id` (string, required) — Identifiants des instances du champ dynamique. - `documentId` (string, required) — Identifiant du document auquel les instances du champ dynamique s'appliquent. - `documentPage` (integer, required) — Page du document à laquelle les instances du champ dynamique s'appliquent. - `posX` (integer, required) — Position sur l'axe X appliquée aux instances du champ dynamique. - `posY` (integer, required) — Position sur l'axe Y appliquée aux instances du champ dynamique. - `font` (string, required) — Police appliquée aux instances du champ dynamique. - `color` (string, required) — Couleur appliquée aux instances du champ dynamique. - `size` (integer, required) — Taille de police appliquée aux instances du champ dynamique. - `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution. ## 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": [ { "workflowMode": "FULL", "steps": [ { "stepType": "approval", "id": "string", "recipients": [ { "consentPageId": "string", "email": "string", "firstName": "string", "lastName": "string", "country": "string", "userId": "string", "pictureResourceId": "string", "phoneNumber": "string", "comments": "string", "organizationId": "string", "preferredLocale": "string" } ], "requiredRecipients": 1.1, "validityPeriod": 4320000000, "invitePeriod": 1340000000, "maxInvites": 1.1, "sendDownloadLink": true, "isStarted": true, "isFinished": true, "allowComments": true, "hideAttachments": true, "viewConfidentialAttachments": true, "hideWorkflowRecipients": true, "logs": [ null ], "requireSupportingDocuments": true, "supportingDocumentsList": "string", "supportingDocumentIds": [ null ], "supportingDocuments": [ null ], "disableMandatoryViewing": true, "faceToFaceSignature": true } ], "created": 1, "currentRecipientEmails": [ null ], "currentRecipientUsers": [ null ], "email": "string", "firstName": "string", "groupId": "string", "id": "string", "lastName": "string", "logs": [ null ], "name": "string", "notifiedEvents": [ "string" ], "pictureResourceId": "string", "progress": 1, "tenantId": "string", "updated": 1, "userId": "string", "viewAuthorizedGroups": [ "string" ], "viewAuthorizedUsers": [ "string" ], "watchers": [ { "notifiedEvents": [ "string" ], "email": "string", "userId": "string" } ], "workflowStatus": "draft", "allowConsolidation": true, "allowedCoManagerUsers": [ null ], "coManagerNotifiedEvents": [ null ], "description": "string", "layoutId": "string", "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", "started": 1.1, "stopped": 1.1, "finished": 1.1, "closed": 1.1, "templateId": "string", "dynamicFields": [ { "id": "string", "type": "TEXT", "name": "string", "order": 1, "description": "string", "value": "string", "instances": [ { "id": "string", "documentId": "string", "documentPage": 1, "posX": 1, "posY": 1, "font": "string", "color": "string", "size": 1 } ] } ], "jobOperation": "string" } ] } ``` **SDK Code** ```python import requests url = "https://workflow-manager/api/workflows" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://workflow-manager/api/workflows'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; 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/workflows" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") 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/workflows") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://workflow-manager/api/workflows") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://workflow-manager/api/workflows', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://workflow-manager/api/workflows"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://workflow-manager/api/workflows")! 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() ```