# General Translation Platform: ブランチ情報を取得
URL: https://generaltranslation.com/ja/docs/platform/openapi/reference/project/branch-info.mdx
---

title: ブランチ情報を取得
description: ブランチのメタデータと General Translation プロジェクトのブランチの状態を確認します。ブランチ情報の取得に関する API リファレンス。

method: POST
---

プロジェクトのデフォルトブランチと、名前を指定して照会したすべてのブランチを返します。ほかのファイル操作を行う前に、これを使ってブランチ名を ID に解決します。

## 概要 [#overview]

```http
POST https://api2.gtx.dev/v2/project/branches/info
```

**権限** `project:files:read` · **レート制限** デフォルト (200/分)

プロジェクトのブランチを取得します。ブランチを作成するには、[ブランチを作成](/docs/platform/openapi/reference/project/create-branch) を使用します。

## 仕組み [#how-it-works]

* デフォルトのブランチは常に返されます。プロジェクトに存在しない場合は `null` が返されます。
* `branchNames` は返される `branches` のリストを絞り込みます。これが空の場合、名前付きブランチは返されません。
* 各ブランチは `id` と `name` を含む形で返されます。

## リクエスト [#request]

### ヘッダー

| ヘッダー              | 説明                                     | 必須  |
| ----------------- | -------------------------------------- | --- |
| `x-gt-api-key`    | プロジェクトまたは Organization の API キー。       | はい  |
| `x-gt-project-id` | プロジェクト ID。Organization キーを使用する場合は必須です。 | いいえ |

### ボディ

**Content type** `application/json`

| フィールド         | 説明         | 型          | 任意 | デフォルト |
| ------------- | ---------- | ---------- | -- | ----- |
| `branchNames` | 参照するブランチ名。 | `string[]` | はい | `[]`  |

## レスポンス [#response]

**ステータス** `200 OK`

```json title="Response"
{
  "branches": [
    { "id": "br_...", "name": "feature-x" }
  ],
  "defaultBranch": { "id": "br_...", "name": "main" }
}
```

## エラー [#errors]

| 状態    | 原因                                       |
| ----- | ---------------------------------------- |
| `400` | 無効なリクエストボディです。                           |
| `401` | API キー がないか、無効です。                       |
| `403` | API キー に `project:files:read` 権限がありません。 |
| `429` | レート制限を超過しました。                            |

## 例 [#example]

```bash
curl -X POST https://api2.gtx.dev/v2/project/branches/info \
  -H "x-gt-api-key: gtx-api-..." \
  -H "Content-Type: application/json" \
  -d '{
    "branchNames": ["feature-x"]
  }'
```