gitlab.issue

stable Standard

One issue of a GitLab.com project.

GET /v1/gitlab/issue

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+}/-/issues/{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#

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
`iid`	string	yes	(required)	Issue iid	max 9 chars; must match `\d{1,9}`; trimmed

Request#

curl "https://api.onekey.dev/v1/gitlab/issue?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": "500 error on MR approvers edit page",
      "text": "Observed on gitlab.com.\n\n```\nworker2 production.log: Completed 500 Internal Server Error in 287ms (ActiveRecord: 11.7ms)\nworker2 production.log: \nworker2 production.log: ActionView::Template::Error (undefined method `name' for nil:NilClass):\nworker2 production.log:     54:         %ul.well-list\nworker2 production.log:     55:           - @project.approvers.each do |approver|\nworker2 production.log:     56:             %li\nworker2 production.log:     57:               = link_to approver.user.name, approver.user\nworker2 production.log:     58:               .pull-right\nworker2 production.log:     59:                 = link_to namespace_project_approver_path(@project.namespace, @project, approver), data: { confirm: \"Are you sure you want to remove approver #{approver.user.name}\"}, method: :delete, class: \"btn-xs btn btn-remove\", title: 'Remove approver' do\nworker2 production.log:     60:                   = icon(\"sign-out\")\nworker2 production.log:   app/views/projects/_merge_request_settings.html.haml:57:in `block in _app_views_projects__merge_request_settings_html_haml___545752523034962009_57962180'\n```\n\nI checked the Rails console, this project has a number of approvers but the user ID of the last one is 0.\n\ncc @sytses @vsizov",
      "url": "https://gitlab.com/gitlab-org/gitlab/-/work_items/1",
      "createdAt": "2015-07-30T14:27:48Z",
      "updatedAt": "2026-09-17T06:37:54Z",
      "state": "closed"
    },
    "author": {
      "username": "jacobvosmaer",
      "displayName": "Jacob Vosmaer"
    },
    "engagement": {
      "comments": 35,
      "likes": 1
    },
    "ext": {
      "labels": [
        "Enterprise Edition",
        "backend"
      ]
    }
  },
  "metadata": {
    "platform": "gitlab",
    "endpoint": "issue",
    "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 path	Onekey field	Transform
`iid`	`content.id`	`toString`
`title`	`content.title`	-
`description`	`content.text`	-
`web_url`	`content.url`	`safeUrl`
`created_at`	`content.createdAt`	`toIsoDate`
`updated_at`	`content.updatedAt`	`toIsoDate`
`state`	`content.state`	-
`author.username`	`author.username`	-
`author.name`	`author.displayName`	-
`user_notes_count`	`engagement.comments`	`toNumber`
`upvotes`	`engagement.likes`	`toNumber`
`labels`	`ext.labels`	-

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#

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`	That record does not exist. Free; do not retry.
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).