GitLab CI/CD users API

Operations about users

Operations 2

GET /api/v4/user_counts Return the user specific counts #
POST /api/v4/user/runners Create a runner owned by currently authenticated user #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/gitlab-ci-users-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-ci-users-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: GitLab access_requests Users API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: users
  description: Operations about users
paths:
  /api/v4/user_counts:
    get:
      summary: Return the user specific counts
      description: Assigned open issues, assigned MRs and pending todos count
      responses:
        '200':
          description: Return the user specific counts
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_UserCounts'
      tags:
      - users
      operationId: getApiV4UserCounts
  /api/v4/user/runners:
    post:
      summary: Create a runner owned by currently authenticated user
      description: Create a new runner
      responses:
        '201':
          description: Create a runner owned by currently authenticated user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Ci_RunnerRegistrationDetails'
        '400':
          description: Bad Request
        '403':
          description: Forbidden
      tags:
      - users
      operationId: postApiV4UserRunners
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4UserRunners'
        required: true
components:
  schemas:
    API_Entities_Ci_RunnerRegistrationDetails:
      type: object
      properties:
        id:
          type: string
        token:
          type: string
        token_expires_at:
          type: string
      required:
      - id
      - token
      - token_expires_at
      description: API_Entities_Ci_RunnerRegistrationDetails model
    API_Entities_UserCounts:
      type: object
      properties:
        merge_requests:
          type: integer
          format: int32
          example: 10
        assigned_issues:
          type: integer
          format: int32
          example: 10
        assigned_merge_requests:
          type: integer
          format: int32
          example: 10
        review_requested_merge_requests:
          type: integer
          format: int32
          example: 10
        todos:
          type: integer
          format: int32
          example: 10
      required:
      - merge_requests
      - assigned_issues
      - assigned_merge_requests
      - review_requested_merge_requests
      - todos
      description: API_Entities_UserCounts model
    postApiV4UserRunners:
      type: object
      properties:
        runner_type:
          type: string
          description: Specifies the scope of the runner
          enum:
          - instance_type
          - group_type
          - project_type
        group_id:
          type: integer
          format: int32
          description: The ID of the group that the runner is created in
          example: 1
        project_id:
          type: integer
          format: int32
          description: The ID of the project that the runner is created in
          example: 1
        description:
          type: string
          description: Description of the runner
        maintenance_note:
          type: string
          description: Free-form maintenance notes for the runner (1024 characters)
        paused:
          type: boolean
          description: Specifies if the runner should ignore new jobs (defaults to false)
        locked:
          type: boolean
          description: Specifies if the runner should be locked for the current project (defaults to false)
        access_level:
          type: string
          description: The access level of the runner
          enum:
          - not_protected
          - ref_protected
        run_untagged:
          type: boolean
          description: Specifies if the runner should handle untagged jobs  (defaults to true)
        tag_list:
          type: array
          description: A list of runner tags
          items:
            type: string
        maximum_timeout:
          type: integer
          format: int32
          description: Maximum timeout that limits the amount of time (in seconds) that runners can run jobs
        token_expires_at:
          type: string
          format: date-time
          description: The expiration time for the runner authentication token (ISO 8601 format). Must be between 5 minutes and 15 days in the future, and cannot exceed instance/group/project limits.
        token_rotation_deadline:
          type: string
          format: date-time
          description: The deadline for token rotation (ISO 8601 format). Must be specified with token_expires_at and be <= token_expires_at.
      required:
      - runner_type
      - group_id
      - project_id
      description: Create a runner owned by currently authenticated user
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query