gitlab.branches

stable Advanced

Branches of a GitLab.com project.

GET /v1/gitlab/branches

What you get#

A list of GitLab results in Onekey's unified shape, in data (an array). An empty array is a normal, successful answer and is charged like any other; a source that reports "nothing found" as an error returns a free 404 not_found instead.

What it costs#

Advanced · 5 credits for a fresh fetch, charged only when it succeeds.
Free when served from cache (0.2 credit for a cached response over 100 KB).
Free if the request is invalid (never charged) or the source fails or reports not found (refunded).

Parameters#

Name	Type	Required	Default	What it is	Constraints
`project`	string	yes	(required)	Project path (group/project) or numeric id	max 200 chars; must match `[A-Za-z0-9_][A-Za-z0-9_.-](?:/[A-Za-z0-9_][A-Za-z0-9_.-])*`; trimmed, lowercased

Request#

curl "https://api.onekey.dev/v1/gitlab/branches?project=gitlab-org%2Fgitlab" \
  -H "x-api-key: YOUR_API_KEY"

Try it

Add your key to run this call right here. No key? Get one free. The key stays in this tab.

Recorded response#

A real GitLab response, recorded and returned in Onekey's shape. Fields the platform does not provide are null.

json

{
  "success": true,
  "data": [
    {
      "entity": {
        "name": "#1404-scawood-duomerge-links",
        "updatedAt": "2025-09-02T17:52:43Z",
        "url": "https://gitlab.com/gitlab-org/gitlab/-/tree/%231404-scawood-duomerge-links"
      },
      "ext": {
        "commit": "1f23260d6e25274aa012107fe003d4ba0c65e116",
        "isDefault": false,
        "protected": true
      }
    },
    {
      "entity": {
        "name": "#17126-saved-views-backend-poc",
        "updatedAt": "2025-11-17T03:44:44Z",
        "url": "https://gitlab.com/gitlab-org/gitlab/-/tree/%2317126-saved-views-backend-poc"
      },
      "ext": {
        "commit": "c4b259215634320c14839308d01ae473d3f208ec",
        "isDefault": false,
        "protected": true
      }
    }
  ],
  "metadata": {
    "platform": "gitlab",
    "endpoint": "branches",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 5,
    "request_id": "7f3a9c2e5b1d4c8fa2e6d0b9c4f18e37"
  },
  "error": null
}

Field mapping#

How this endpoint's source fields become Onekey's unified schema. Fields the source lacks come back as null.

Source path	Onekey field	Transform
`name`	`entity.name`	-
`commit.id`	`ext.commit`	-
`commit.created_at`	`entity.updatedAt`	`toIsoDate`
`web_url`	`entity.url`	`safeUrl`
`default`	`ext.isDefault`	`toBoolean`
`protected`	`ext.protected`	`toBoolean`

Caching and freshness#

Fresh for about 2 minutes. Repeat calls in that window are served from cache and are free.
Between 2 minutes and 15 minutes the cached copy is still served instantly and marked stale: true while Onekey refreshes it in the background.
If the source is down when a refresh is needed, the last copy can be served for up to 1 hour more (marked stale).
A "not found" is remembered for 1 minute and is free.
The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

Status	Code	What to do
401	`unauthorized`	Check the `x-api-key` header.
402	`insufficient_credits`	Add credits; your balance must cover the price.
404	`not_found`	Unknown endpoint path.
422	`invalid_params`	Fix the parameters using the table above. Free.
429	`rate_limited`	Wait `Retry-After` seconds, then retry.
502	`upstream_error`	The source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).