# General Translation Platform: Get branch info
URL: https://generaltranslation.com/en-GB/docs/platform/openapi/reference/project/branch-info.mdx
---
title: Get branch info
description: Inspect branch metadata and General Translation Project branch state. API reference for Get branch information.

method: POST
---

Returns the Project's default branch and any branches you query by name. Use it to resolve branch names to IDs before other file operations.

## Overview [#overview]

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

**Permission** `project:files:read` · **Rate limit** Default (200/min)

Retrieve branches for a Project. To create a branch, use [Create a branch](/docs/platform/openapi/reference/project/create-branch).

## How it works [#how-it-works]

* The default branch is always returned, or `null` if the Project has none.
* `branchNames` filters the returned `branches` list. When it is empty, no named branches are returned.
* Each branch is returned with its `id` and `name`.

## Request [#request]

### Headers

| Header            | Description                                          | Required |
| ----------------- | ---------------------------------------------------- | -------- |
| `x-gt-api-key`    | Project or organisation API key.                     | Yes      |
| `x-gt-project-id` | Project ID. Required when using an organisation key. | No       |

### Body

**Content type** `application/json`

| Field         | Description              | Type       | Optional | Default |
| ------------- | ------------------------ | ---------- | -------- | ------- |
| `branchNames` | Branch names to look up. | `string[]` | Yes      | `[]`    |

## Response [#response]

**Status** `200 OK`

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

## Errors [#errors]

| Status | Cause                               |
| ------ | ----------------------------------- |
| `400`  | Invalid request body.               |
| `401`  | Missing or invalid API key.         |
| `403`  | API key lacks `project:files:read`. |
| `429`  | Rate limit exceeded.                |

## Example [#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"]
  }'
```