Docs
View as Markdown

gitlab.merge_request

stable Standard

One merge request of a GitLab.com project.

GET /v1/gitlab/merge_request

What you get#

One GitLab record in Onekey's unified shape, in data. If the record does not exist you get a 404 not_found and are not charged.

Also works with: URL lookup (gitlab.com/{project+}/-/merge_requests/{iid}). Any batch can include it.

What it costs#

  • Standard · 1 credit 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#

NameTypeRequiredDefaultWhat it isConstraints
projectstringyes(required)Project path (group/project) or numeric idmax 200 chars; must match [A-Za-z0-9_][A-Za-z0-9_.-]*(?:/[A-Za-z0-9_][A-Za-z0-9_.-]*)*; trimmed, lowercased
iidstringyes(required)Merge request iidmax 9 chars; must match \d{1,9}; trimmed

Request#

curl "https://api.onekey.dev/v1/gitlab/merge_request?project=gitlab-org%2Fgitlab&iid=1" \
  -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": {
    "content": {
      "id": "1",
      "title": "Enhance the LDAP group synchronization",
      "text": "The response of our company's LDAP for a group looks like this:\n```\ndn: <dn-of-the-selected-group>\ncn: <name-of-the-selected-group>\nsubmember: uid=<username-of-a-submember>\nmember: uid=<username-of-a-member>\n```\nSo the current implementation of the LDAP group synchronization in GitLab can't find any registered user in such a group. This merge request will fix this.\n\nThis is a \"copy\" of this merge request https://gitlab.com/subscribers/gitlab-ee/merge_requests/27 that was in the wrong repository.",
      "url": "https://gitlab.com/gitlab-org/gitlab/-/merge_requests/1",
      "createdAt": "2015-05-21T10:06:50Z",
      "updatedAt": "2026-09-24T13:16:10Z",
      "state": "merged"
    },
    "author": {
      "username": "1and1_ebusiness",
      "displayName": "Thilo Ognibeni"
    },
    "engagement": {
      "comments": 27,
      "likes": 2
    },
    "ext": {
      "labels": [
        "Enterprise Edition",
        "security",
        "type::maintenance"
      ],
      "mergedAt": null,
      "sourceBranch": "master"
    }
  },
  "metadata": {
    "platform": "gitlab",
    "endpoint": "merge_request",
    "cached": false,
    "stale": false,
    "age_s": 0,
    "fetched_at": "2026-01-01T12:00:00+00:00",
    "credits_charged": 1,
    "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 pathOnekey fieldTransform
iidcontent.idtoString
titlecontent.title-
descriptioncontent.text-
web_urlcontent.urlsafeUrl
created_atcontent.createdAttoIsoDate
updated_atcontent.updatedAttoIsoDate
statecontent.state-
author.usernameauthor.username-
author.nameauthor.displayName-
user_notes_countengagement.commentstoNumber
upvotesengagement.likestoNumber
labelsext.labels-
merged_atext.mergedAttoIsoDate
source_branchext.sourceBranch-

Caching and freshness#

  • Fresh for about 1 hour. Repeat calls in that window are served from cache and are free.
  • Between 1 hour and 1 day 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 3 days more (marked stale).
  • A "not found" is remembered for 5 minutes and is free.
  • The cache is shared across all customers, which is what keeps repeat calls cheap.

What can go wrong#

StatusCodeWhat to do
401unauthorizedCheck the x-api-key header.
402insufficient_creditsAdd credits; your balance must cover the price.
404not_foundThat record does not exist. Free; do not retry.
422invalid_paramsFix the parameters using the table above. Free.
429rate_limitedWait Retry-After seconds, then retry.
502upstream_errorThe source failed. Refunded; retry with backoff.

See Errors for the full list and retry guidance.

Status: stable (verified against the live source).