# General Translation Platform: Get branch information
URL: https://generaltranslation.com/en-US/docs/platform/openapi/reference/project/branch-info.mdx
---

title: "Get branch information"
description: "Return the Project's default branch and any branches requested by name. API reference for Get branch information."
method: POST
full: true
_openapi:
  method: POST
  route: /v2/project/branches/info
  toc: []
  structuredData:
    headings: []
    contents:
      - content: >
          Return the Project's default branch and any branches requested by
          name.
---



## `POST https://api.gtx.dev/v2/project/branches/info`

Return the Project's default branch and any branches requested by name.

Authentication: send an API key as a bearer token in the `Authorization: Bearer <key>` header.

### Parameters

- `gt-api-version` (header, "2025-01-01.v0" | "2025-11-03.v1" | "2026-02-18.v1" | "2026-03-06.v1", optional): API version. Defaults to the earliest supported version. Latest is `2026-03-06.v1`.
- `gt-project-id` (header, string, optional): Target project ID. Required when authenticating with an organization API key.

### Request body

Body (`application/json`, object):
- `branchNames` (string[]) Default: `[]`.

### Responses

**200**: Branch information.
Response body (`application/json`, object):
- `branches` (object[])
  - `id` (string)
  - `name` (string)
- `defaultBranch` (object | null): The default branch, or null if none is set.
  - `id` (string)
  - `name` (string)

**400**: The request was invalid.
Response body (`application/json`, object):
- `error` (string): Human-readable error message.

**401**: Missing or invalid API key.
Response body (`application/json`, object):
- `error` (string): Human-readable error message.

**403**: The API key lacks the required permission, or the action is not allowed on the current plan.
Response body (`application/json`, object):
- `error` (string): Human-readable error message.

The complete OpenAPI 3.1 spec is available at https://generaltranslation.com/openapi.yaml.