> This page is for Workflow Manager (WM), version v1.22.
> For other versions, use one of these documentation indexes:
> - Latest (default): https://docs.goodflag.com/wm/latest/llms.txt
> - v1.22: https://docs.goodflag.com/wm/v-1-22/llms.txt

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

GET https://workflow-manager/admin/api/tenants

Recherche dans tous les tenants. Réservé aux administrateurs.

Administrateur de la plateforme (back-office Goodflag). Inaccessible aux utilisateurs du tenant.

Reference: https://docs.goodflag.com/wm/api-reference/documentation-api/token-administrateur/tenants/search-tenants

## Authentication

- `Authorization` header (basic auth, required) — Identifiants d'administration, requis pour les endpoints `/admin/api` et `/experimental/admin/api`.

## Request

### Query parameters

- `text` (string, optional) — Le texte à rechercher.
- `items.id` (string, optional) — La ou les valeurs de filtre du champ id.
- `items.domainName` (string, optional) — La ou les valeurs de filtre du champ domainName.
- `items.tenantStatus` (string, optional) — La ou les valeurs de filtre du champ tenantStatus.
- `items.organizationName` (string, optional) — La ou les valeurs de filtre du champ organizationName.
- `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.idpAllowEdition` (string, optional) — La ou les valeurs de filtre du champ idpAllowEdition.
- `items.apiActivation` (string, optional) — La ou les valeurs de filtre du champ apiActivation.
- `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.externalArchivingParameters.archiverId` (string, optional) — La ou les valeurs de filtre du champ externalArchivingParameters.archiverId.
- `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 Tenant.

- `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 Tenant, optional)

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

- `InvalidAdminCredentials` : Les identifiants d'administration sont incorrects.

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

## Types

### Tenant

- `activateExternalArchive` (boolean, required) — Indique si les fichiers de preuve sont versés dans un système d'archivage externe lors de l'archivage du parapheur.
- `allowCommentsInSteps` (boolean, required) — Indique si l'autorisation des commentaires est gérée par le gestionnaire du parapheur.
- `allowConsolidation` (boolean, required) — Indique si la consolidation du parapheur est activée.
- `allowExternalArchive` (boolean, required) — Indique si le tenant est autorisé à verser dans un système d'archivage externe.
- `allowWatchers` (boolean, required) — Indique si l'autorisation des observateurs est gérée par le gestionnaire du parapheur.
- `allowedTenantStatus` (list of string, required) — Les statuts vers lesquels le tenant est autorisé à basculer.
- `attachmentExtensions` (list of string, required) — Les extensions de fichier autorisées pour les pièces jointes des parapheurs.
- `certificateEvidenceLanguage` (string, required) — La langue du certificat de preuve.
- `createUserOnLogin` (boolean, required) — Indique si les utilisateurs sont créés automatiquement à la première connexion.
- `created` (long, required) — La date de création de l'entité.
- `darkColor` (string, required) — La couleur sombre du portail.
- `defaultAllowComments` (boolean, required) — La valeur par défaut de l'autorisation des commentaires dans les étapes.
- `defaultCountry` (string, required) — Le pays par défaut des nouveaux utilisateurs, lorsque le fournisseur d'identité ne le fournit pas. Sans valeur spécifiée, le pays par défaut est FR.
- `defaultGroupId` (string, required) — L'identifiant du groupe par défaut du tenant.
- `domainName` (string, required) — Le nom de domaine du tenant.
- `downloadLinkTokenValidityDays` (long, required, default: 3650) — Durée de validité du jeton de lien de téléchargement, en jours.
- `forceFlattenPdf` (boolean, required) — Indique si les champs de signature existants sont aplatis lors de l'envoi des PDF.
- `id` (string, required) — L'identifiant du tenant.
- `idpBaseUrl` (string, required) — URL de base du fournisseur d'identité OpenID Connect.
- `idpClientId` (string, required) — Identifiant client (client ID) du fournisseur d'identité OpenID Connect.
- `idpClientSecret` (string, required) — Secret client du fournisseur d'identité OpenID Connect.
- `idpScope` (string, required) — Scope du fournisseur d'identité OpenID Connect.
- `idpType` (string, required) — Type de fournisseur d'identité.
- `lockDocumentsAfterFirstValidation` (boolean, required) — Indique si les documents sont verrouillés après la première validation.
- `sendEmailOnUserCreation` (boolean, required) — Indique si un email d'activation est envoyé lorsqu'un utilisateur est créé automatiquement à sa première connexion.
- `sendOnboardingEmailOnFirstLogin` (boolean, required) — Indique si un email d'accueil (onboarding) est envoyé lorsqu'un utilisateur se connecte pour la première fois.
- `loginTokenTtl` (long, required) — La durée de validité du jeton de connexion au portail, en millisecondes.
- `maxAttachments` (long, required, default: 10) — Le nombre maximal de pièces jointes autorisé par le portail.
- `maxDocumentSize` (long, required, default: 10485760) — La taille maximale de document autorisée par le portail, en octets. Au-delà de 104857600 octets, une option payante est nécessaire.
- `maxDocuments` (long, required, default: 200) — Le nombre maximal de documents à signer autorisé par le portail.
- `primaryColor` (string, required) — La couleur principale du portail.
- `secondaryColor` (string, required) — La couleur secondaire du portail.
- `smtpSenderName` (string, required) — Le nom d'expéditeur des emails de notification.
- `technicalContactUrl` (string, required) — L'URL du contact technique affichée dans le portail.
- `updated` (long, required) — La date de dernière modification de l'entité.
- `allowSignatureOnHigherSignatureLevel` (boolean, optional) — Autorise la signature d'un document qui porte déjà une signature de niveau supérieur. Par exemple, permet de cosigner en LT un document portant une signature LTA.
- `allowSingleSignerMode` (boolean, optional) — Indique si le mode signataire unique est autorisé pour les parapheurs de ce tenant.
- `allowSupportingDocumentsRequest` (boolean, optional) — Indique si les pièces justificatives sont autorisées.
- `consentVersion` (string, optional)
- `createUserOnLoginGroupId` (string, optional) — Identifiant du groupe sélectionné lorsque l'option de création de l'utilisateur à la première connexion est activée.
- `idpAllowEdition` (boolean, optional) — Indique si le mode de personnalisation du fournisseur d'identité est activé pour ce tenant. Réservé aux administrateurs.
- `apiActivation` (boolean, optional) — Active l'API. Réservé aux administrateurs.
- `logoResourceId` (string, optional) — L'identifiant de la ressource image du logo.
- `requireSupportingDocuments` (boolean, optional) — Indique si les pièces justificatives sont requises pour les parapheurs de ce tenant.
- `tenantStatus` (string, optional) — Le statut du tenant.
- `visual` (TenantVisual, optional)
- `organizationName` (string, optional) — Le nom de l'organisation du tenant.
- `externalArchivingParameters` (TenantExternalArchivingParameters, optional) — Paramètres d'archivage externe du parapheur archivé.
- `jobOperation` (string, optional) — L'opération de tâche en cours d'exécution.

### TenantVisual

- `allowVisual` (boolean, optional) — Indique si l'ajout d'un visuel attestant de la signature sur les pages du document est autorisé.
- `text` (string, optional) — Le visuel, sous forme de texte. Il doit contenir \{\{workflowId}}.

### TenantExternalArchivingParameters

Paramètres d'archivage externe du parapheur archivé.

- `archiverId` (string, optional) — Identifiant de la configuration d'archiveur externe.
- `filesToArchive` (list of enum, optional) — Fichiers ciblés par l'archivage. Valeurs possibles : evidenceFiles, signedDocuments.
  - Allowed values: `evidenceFiles`, `signedDocuments`
- `metadata` (list of TenantExternalArchivingParametersMetadataItems, optional) — Métadonnée à associer au parapheur archivé.

### TenantExternalArchivingParametersMetadataItems

- `name` (string, optional) — Nom de la métadonnée à associer au parapheur archivé.
- `value` (string, optional) — Metadata value to associate with the archived workflow. Values available are: \{\{workflowName}}, \{\{workflowId}}, \{\{archivedAt}} (date + time in ISO 8601 format)

## Examples

**Response**

```json
{
  "pageIndex": 1,
  "itemsPerPage": 1,
  "totalItems": 1,
  "items": [
    {
      "activateExternalArchive": true,
      "allowCommentsInSteps": true,
      "allowConsolidation": true,
      "allowExternalArchive": true,
      "allowWatchers": true,
      "allowedTenantStatus": [
        "string"
      ],
      "attachmentExtensions": [
        "string"
      ],
      "certificateEvidenceLanguage": "string",
      "createUserOnLogin": true,
      "created": 1,
      "darkColor": "string",
      "defaultAllowComments": true,
      "defaultCountry": "string",
      "defaultGroupId": "string",
      "domainName": "string",
      "downloadLinkTokenValidityDays": 3650,
      "forceFlattenPdf": true,
      "id": "string",
      "idpBaseUrl": "string",
      "idpClientId": "string",
      "idpClientSecret": "string",
      "idpScope": "string",
      "idpType": "string",
      "lockDocumentsAfterFirstValidation": true,
      "sendEmailOnUserCreation": true,
      "sendOnboardingEmailOnFirstLogin": true,
      "loginTokenTtl": 1,
      "maxAttachments": 10,
      "maxDocumentSize": 10485760,
      "maxDocuments": 200,
      "primaryColor": "string",
      "secondaryColor": "string",
      "smtpSenderName": "string",
      "technicalContactUrl": "string",
      "updated": 1,
      "allowSignatureOnHigherSignatureLevel": true,
      "allowSingleSignerMode": true,
      "allowSupportingDocumentsRequest": true,
      "consentVersion": "string",
      "createUserOnLoginGroupId": "string",
      "idpAllowEdition": true,
      "apiActivation": true,
      "logoResourceId": "string",
      "requireSupportingDocuments": true,
      "tenantStatus": "string",
      "visual": {
        "allowVisual": true,
        "text": "string"
      },
      "organizationName": "string",
      "externalArchivingParameters": {
        "archiverId": "string",
        "filesToArchive": [
          "evidenceFiles"
        ],
        "metadata": [
          {
            "name": "string",
            "value": "string"
          }
        ]
      },
      "jobOperation": "string"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://workflow-manager/admin/api/tenants"

response = requests.get(url, auth=("<username>", "<password>"))

print(response.json())
```

```javascript
const url = 'https://workflow-manager/admin/api/tenants';
const credentials = btoa("<username>:<password>");

const options = {method: 'GET', headers: {Authorization: `Basic ${credentials}`}};

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/admin/api/tenants"

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

	req.SetBasicAuth("<username>", "<password>")

	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/admin/api/tenants")

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

request = Net::HTTP::Get.new(url)
request.basic_auth("<username>", "<password>")

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/admin/api/tenants")
  .basicAuth("<username>", "<password>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://workflow-manager/admin/api/tenants', [
  'headers' => [
  ],
    'auth' => ['<username>', '<password>'],
]);

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

```csharp
using RestSharp;
using RestSharp.Authenticators;

var client = new RestClient("https://workflow-manager/admin/api/tenants");
client.Authenticator = new HttpBasicAuthenticator("<username>", "<password>");
var request = new RestRequest(Method.GET);

IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let credentials = Data("<username>:<password>".utf8).base64EncodedString()

let headers = ["Authorization": "Basic \(credentials)"]

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