# General Translation Platform: 获取分支信息
URL: https://generaltranslation.com/zh/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]

* 始终会返回默认分支；如果 Project 没有默认分支，则返回 `null`。
* `branchNames` 用于筛选返回的 `branches` 列表。为空时，不会返回任何具名分支。
* 每个分支都会以其 `id` 和 `name` 的形式返回。

## 请求 [#request]

### 请求头

| 请求头               | 描述               | 必填 |
| ----------------- | ---------------- | -- |
| `x-gt-api-key`    | 项目或组织 API 密钥。    | 是  |
| `x-gt-project-id` | 项目 ID。使用组织密钥时必填。 | 否  |

### 正文

**内容类型** `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 密钥或 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"]
  }'
```