# General Translation Platform: getProjectData
URL: https://generaltranslation.com/fr/docs/platform/core/reference/gt-class-methods/translation/get-project-data.mdx
---

title: getProjectData
description: Lit les métadonnées au niveau du projet et la configuration de traduction. Référence de l’API pour getProjectData.

---

Récupère des informations sur un projet de traduction dans General Translation, notamment son nom, l’organisation, le paramètre régional par défaut et les paramètres régionaux cibles actuellement configurés. Utilisez cette fonction pour examiner ou valider la configuration du projet.

## Vue d’ensemble [#overview]

Appelez `getProjectData` avec un ID de projet. Cette fonction renvoie des métadonnées de projet en lecture seule ainsi que la configuration du paramètre régional.

```typescript
const gt = new GT({ projectId: 'your-project-id', apiKey: 'your-api-key' });

const projectData = await gt.getProjectData('project-123');
console.log(`Project: ${projectData.name}`);
console.log(`Default locale: ${projectData.defaultLocale}`);
console.log(`Target locales: ${projectData.currentLocales.join(', ')}`);
```

Signature :

```typescript
getProjectData(
  projectId: string,
  options?: { timeout?: number }
): Promise<ProjectData>
```

*Remarque : `getProjectData` nécessite une `apiKey` (ou `devApiKey`) ainsi que `projectId` dans l’instance GT, et le Projet doit être accessible avec cette clé API.*

## Fonctionnement [#how-it-works]

* **Lecture seule.** La méthode donne un accès en lecture seule aux informations du projet — utilisez le Dashboard pour modifier les paramètres du projet.
* **Configuration des paramètres régionaux.** La réponse inclut la configuration du paramètre régional source (`defaultLocale`) ainsi que celle des paramètres régionaux cibles (`currentLocales`).
* **Validation.** Utilisez-la pour valider la configuration du projet avant de lancer les workflows de traduction.

## Paramètres [#parameters]

| Paramètre                  | Description                                 | Type                   | Facultatif | Par défaut |
| -------------------------- | ------------------------------------------- | ---------------------- | ---------- | ---------- |
| [`projectId`](#project-id) | L’identifiant unique du projet à récupérer. | `string`               | Non        | —          |
| [`options`](#options)      | Configuration de la requête.                | `{ timeout?: number }` | Oui        | —          |

### `projectId` [#project-id]

**Type** `string` · **Obligatoire**

L’identifiant unique du projet à récupérer. Le projet doit être accessible avec la clé API fournie.

### `options` [#options]

**Type** `{ timeout?: number }` · **Facultatif**

| Champ     | Description                                         | Type     | Facultatif |
| --------- | --------------------------------------------------- | -------- | ---------- |
| `timeout` | Délai d’expiration de la requête, en millisecondes. | `number` | Oui        |

## Retour [#returns]

**Type** `Promise<ProjectData>`

Renvoie un objet `ProjectData` décrivant le projet :

```typescript
type ProjectData = {
  id: string;
  name: string;
  orgId: string;
  defaultLocale: string;
  currentLocales: string[];
};
```

| Propriété        | Description                                           | Type       |
| ---------------- | ----------------------------------------------------- | ---------- |
| `id`             | Identifiant unique du projet.                         | `string`   |
| `name`           | Nom du projet lisible par l’humain.                   | `string`   |
| `orgId`          | Identifiant de l’organisation propriétaire du projet. | `string`   |
| `defaultLocale`  | Paramètre régional source par défaut du projet.       | `string`   |
| `currentLocales` | Paramètres régionaux cibles actuellement configurés.  | `string[]` |

## Exemples [#examples]

```typescript title="index.ts"
import { GT } from 'generaltranslation';

const gt = new GT({
  projectId: 'your-project-id',
  apiKey: 'your-api-key',
});

async function getProjectInfo(projectId: string) {
  try {
    const project = await gt.getProjectData(projectId);

    console.log('=== Project Information ===');
    console.log(`ID: ${project.id}`);
    console.log(`Name: ${project.name}`);
    console.log(`Organization: ${project.orgId}`);
    console.log(`Default Locale: ${project.defaultLocale}`);
    console.log(`Target Locales: ${project.currentLocales.join(', ')}`);

    return project;
  } catch (error) {
    console.error(`Failed to retrieve project ${projectId}:`, error);
    throw error;
  }
}

const projectInfo = await getProjectInfo('my-project-123');
```

## Notes [#notes]

* La méthode fournit un accès en lecture seule aux informations du projet — utilisez le Dashboard pour modifier les paramètres du projet.
* Cette méthode nécessite un ID de projet valide ; le projet doit être accessible avec la clé API fournie.
* Les données du projet incluent à la fois les configurations du paramètre régional source et des paramètres régionaux cibles.
* Le tableau `currentLocales` représente tous les paramètres régionaux cibles configurés pour le projet.
* Utilisez cette méthode pour vérifier la configuration du projet avant de démarrer les workflows de traduction.