GitLab

GitLab Epics API

> [!warning] > The Epics REST API was [deprecated](https://gitlab.com/gitlab-org/gitlab/-/issues/460668) in GitLab 17.0 > and is planned for removal in v5 of the API. From GitLab 17.4 to 18.0, if > [the new look for epics](https://docs.gitlab.com/user/group/epics/#epics-as-work-items) is enabled, > or in GitLab 18.1 and later, use the Work Items API instead. For more information, see > [migrate epic APIs to work items](https://docs.gitlab.com/api/graphql/epic_work_items_api_migration_guide/). > This change is a breaking change. Use this API to manage [epics](https://docs.gitlab.com/user/group/epics/), the issues assigned to them, their child and [related epics](https://docs.gitlab.com/user/group/epics/linked_epics/), and [group epic boards](https://docs.gitlab.com/user/group/epics/epic_boards/). Every call to this API must be authenticated. If a user is not a member of a private group, a `GET` request on that group results in a `404` status code. Epics are available only in GitLab [Premium and Ultimate](https://about.gitlab.com/pricing/). If the Epics or Related Epics feature is not available, a `403` status code is returned.

GitHub OpenAPI

Operations 26

GET /api/v4/groups/{id}/epics/{epic_iid}/related_epics List all linked epics for an epic #
POST /api/v4/groups/{id}/epics/{epic_iid}/related_epics Create a related epic link #
DELETE /api/v4/groups/{id}/epics/{epic_iid}/related_epics/{related_epic_link_id} Delete a related epic link #
GET /api/v4/groups/{id}/epic_boards List all epic boards in a group #
GET /api/v4/groups/{id}/epic_boards/{board_id} Retrieve a group epic board #
GET /api/v4/groups/{id}/epic_boards/{board_id}/lists List all group epic board lists #
GET /api/v4/groups/{id}/epic_boards/{board_id}/lists/{list_id} Retrieve a group epic board list #
GET /api/v4/groups/{id}/epics List all group epics #
GET /api/v4/groups/{id}/-/epics List all group epics #
GET /api/v4/groups/{id}/epics/{epic_iid} Get details of an epic #
GET /api/v4/groups/{id}/-/epics/{epic_iid} Get details of an epic #
POST /api/v4/groups/{id}/(-/)epics Create a new epic #
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid} Update an epic #
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid} Destroy an epic #
GET /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics Get related epics #
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics Create and relate epic to a parent #
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} Relate epics #
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} Remove epics relation #
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid}/epics/{child_epic_id} Reorder child epics #
PUT /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id} Update a related epic link #
POST /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id} Add an issue to an epic #
DELETE /api/v4/groups/{id}/(-/)epics/{epic_iid}/issues/{epic_issue_id} Remove an issue from the epic #
GET /api/v4/groups/{id}/epics/{epic_iid}/issues List all issues for an epic #
GET /api/v4/groups/{id}/-/epics/{epic_iid}/issues List all issues for an epic #
POST /api/v4/groups/{id}/epics/{epic_iid}/todo Create a to-do item for an epic #

Documentation

📖
Documentation
https://docs.gitlab.com/api/openapi/
📖
Documentation
https://docs.gitlab.com/api/issues/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/
📖
Documentation
https://docs.gitlab.com/api/merge_requests/
📖
Documentation
https://docs.gitlab.com/api/pipelines/
📖
Documentation
https://docs.gitlab.com/api/jobs/
📖
Documentation
https://docs.gitlab.com/api/runners/
📖
Documentation
https://docs.gitlab.com/api/users/
📖
Documentation
https://docs.gitlab.com/api/repositories/
📖
Documentation
https://docs.gitlab.com/api/commits/
📖
Documentation
https://docs.gitlab.com/api/branches/
📖
Documentation
https://docs.gitlab.com/api/tags/
📖
Documentation
https://docs.gitlab.com/api/releases/
📖
Documentation
https://docs.gitlab.com/api/environments/
📖
Documentation
https://docs.gitlab.com/api/deployments/
📖
Documentation
https://docs.gitlab.com/api/pipeline_schedules/
📖
Documentation
https://docs.gitlab.com/api/labels/
📖
Documentation
https://docs.gitlab.com/api/milestones/
📖
Documentation
https://docs.gitlab.com/api/notes/
📖
Documentation
https://docs.gitlab.com/api/snippets/
📖
Documentation
https://docs.gitlab.com/api/packages/
📖
Documentation
https://docs.gitlab.com/api/container_registry/
📖
Documentation
https://docs.gitlab.com/api/vulnerabilities/
📖
Documentation
https://docs.gitlab.com/api/deploy_keys/
📖
Documentation
https://docs.gitlab.com/api/protected_branches/
📖
Documentation
https://docs.gitlab.com/api/wikis/
📖
Documentation
https://docs.gitlab.com/api/events/
📖
Documentation
https://docs.gitlab.com/api/search/
📖
Documentation
https://docs.gitlab.com/api/namespaces/
📖
Documentation
https://docs.gitlab.com/api/groups/
📖
Documentation
https://docs.gitlab.com/api/projects/
📖
Documentation
https://docs.gitlab.com/api/applications/
📖
Documentation
https://docs.gitlab.com/api/avatar/
📖
Documentation
https://docs.gitlab.com/api/broadcast_messages/
📖
Documentation
https://docs.gitlab.com/api/bulk_imports/
📖
Documentation
https://docs.gitlab.com/api/settings/
📖
Documentation
https://docs.gitlab.com/api/metadata/
📖
Documentation
https://docs.gitlab.com/api/version/
📖
Documentation
https://docs.gitlab.com/api/rest/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
RateLimits
https://docs.gitlab.com/security/rate_limits/
📖
Documentation
https://docs.gitlab.com/api/oauth2/
📖
Authentication
https://docs.gitlab.com/integration/oauth_provider/
📖
Documentation
https://docs.gitlab.com/user/project/integrations/webhooks.html
📖
APIReference
https://docs.gitlab.com/api/project_webhooks/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gitlab/openapi/gitlab-epics-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/gitlab/asyncapi/gitlab-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-application-settings-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-node-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-site-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-application-setting-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-post-api-v4-geo-status-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-projects-id-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-cluster-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-batched-background-migration-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-ci-variable-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-dictionary-table-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-plan-limit-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-appearance-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-avatar-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-imports-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-import-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-metadata-schema.json

Other Resources

🔗
SDKs
https://docs.gitlab.com/api/rest/third_party_clients/
🔗
Interactive Documentation
https://docs.gitlab.com/api/openapi/openapi_interactive/

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:gitlab-epics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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.

GitHub Google LinkedIn

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

OpenAPI Specification

gitlab-epics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab REST Epics API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:


# --- truncated at 32 KB (83 KB total) ---
# Full source: https://artifacts.apis.io/gitlab/openapi/gitlab-epics-api-openapi.yml