Epics API (deprecated) | GitLab Docs
/ Epics API (deprecated) Tier : Premium, Ultimate Offering : GitLab.com, GitLab Self-Managed, GitLab Dedicated The Epics REST API was deprecated 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 is enabled, and in GitLab 18.1 and later, use the Work Items API instead. For more information, see migrate epic APIs to work items . This change is a breaking change.
Every API call to epics 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. If epics feature is not available a 403 status code is returned. Legacy Epic IDs and WorkItem IDs The legacy Epic ID is not the same as the WorkItem ID. Only the iid matches. However, to retrieve the corresponding WorkItem ID for an epic, the response includes a work_item_id .
This ID can be used for the WorkItem GraphQL API, e.g. the work_item_id would be the Global ID gid://gitlab/WorkItem/123 on the WorkItem GraphQL API. Epic issues API The epic issues API allows you to interact with issues associated with an epic. Milestone dates integration Because start date and due date can be dynamically sourced from related issue milestones, additional fields are shown when the user has edit permission.
These include two boolean fields start_date_is_fixed and due_date_is_fixed , and four date fields start_date_fixed , start_date_from_inherited_source , due_date_fixed , and due_date_from_inherited_source . end_date has been deprecated in favor of due_date . start_date_from_milestones has been deprecated in favor of start_date_from_inherited_source due_date_from_milestones has been deprecated in favor of due_date_from_inherited_source List all group epics Lists all epics for a specified group and its subgroups.
Responses are paginated and return 20 results by default. references.relative is relative to the group that the epic is being requested from. When an epic is fetched from its origin group, the relative format is the same as the short format. When an epic is requested across groups, the relative format is expected to be the same as the full format. GET /groups/:id/epics GET /groups/:id/epics?author_id=5 GET /groups/:id/epics?labels=bug,reproduced GET /groups/:id/epics?state=opened Attribute Type Required Description id integer or string yes The ID or URL-encoded path of the group author_id integer no Return epics created by the given user id author_username string no Return epics created by the user with the given username . labels string no Return epics matching a comma-separated list of label names.
Label names from the epic group or a parent group can be used with_labels_details boolean no If true , response returns more details for each label in labels field: :name , :color , :description , :description_html , :text_color . Default is false . order_by string no Return epics ordered by created_at , updated_at , or title fields. Default is created_at sort string no Return epics sorted in asc or desc order. Default is desc search string no Search epics against their title and description state string no Search epics against their state , possible filters: opened , closed , and all , default: all created_after datetime no Return epics created on or after the given time.
Expected in ISO 8601 format ( 2019-03-15T08:00:00Z ) created_before datetime no Return epics created on or before the given time. Expected in ISO 8601 format ( 2019-03-15T08:00:00Z ) updated_after datetime no Return epics updated on or after the given time. Expected in ISO 8601 format ( 2019-03-15T08:00:00Z ) updated_before datetime no Return epics updated on or before the given time. Expected in ISO 8601 format ( 2019-03-15T08:00:00Z ) include_ancestor_groups boolean no Include epics from the requested group’s ancestors.
Default is false include_descendant_groups boolean no Include epics from the requested group’s descendants. Default is true my_reaction_emoji string no Return epics reacted by the authenticated user by the given emoji. None returns epics not given a reaction. Any returns epics given at least one reaction. not Hash no Return epics that do not match the parameters supplied. Accepts: author_id , author_username and labels . shell curl --request GET \ --header "PRIVATE-TOKEN: <your_access_token>" \ --url "https://gitlab.example.com/api/v4/groups/1/epics" Example response: json [ { "id" : 29 , "work_item_id" : 1032 , "iid" : 4 , "group_id" : 7 , "parent_id" : 23 , "parent_iid" : 3 , "title" : "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est." , "description" : "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum." , "state" : "opened" , "confidential" : "false" , "web_url" : "http://gitlab.example.com/groups/test/-/epics/4" , "reference" : "&4" , "references" : { "short" : "&4" , "relative" : "&4" , "full" : "test&4" }, "author" : { "id" : 10 , "name" : "Lu Mayer" , "username" : "kam" , "state" : "active" , "avatar_url" : "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon" , "web_url" : "http://gitlab.example.com/kam" }, "start_date" : null , "start_date_is_fixed" : false , "start_date_fixed" : null , "start_date_from_milestones" : null , //deprecated in favor of start_date_from_inherited_source "start_date_from_inherited_source" : null , "end_date" : "2018-07-31" , //deprecated in favor of due_date "due_date" : "2018-07-31" , "due_date_is_fixed" : false , "due_date_fixed" : null , "due_date_from_milestones" : "2018-07-31" , //deprecated in favor of start_date_from_inherited_source "due_date_from_inherited_source" : "2018-07-31" , "created_at" : "2018-07-17T13:36:22.770Z" , "updated_at" : "2018-07-18T12:22:05.239Z" , "closed_at" : "2018-08-18T12:22:05.239Z" , "labels" : [], "upvotes" : 4 , "downvotes" : 0 , "color" : "#1068bf" , "_links" :{ "self" : "http://gitlab.example.com/api/v4/groups/7/epics/4" , "epic_issues" : "http://gitlab.example.com/api/v4/groups/7/epics/4/issues" , "group" : "http://gitlab.example.com/api/v4/groups/7" , "parent" : "http://gitlab.example.com/api/v4/groups/7/epics/3" } }, { "id" : 50 , "work_item_id" : 1035 , "iid" : 35 , "group_id" : 17 , "parent_id" : 19 , "parent_iid" : 1 , "title" : "Accusamus iste et ullam ratione voluptatem omnis debitis dolor est." , "description" : "Molestias dolorem eos vitae expedita impedit necessitatibus quo voluptatum." , "state" : "opened" , "web_url" : "http://gitlab.example.com/groups/test/sample/-/epics/35" , "reference" : "&4" , "references" : { "short" : "&4" , "relative" : "sample&4" , "full" : "test/sample&4" }, "author" : { "id" : 10 , "name" : "Lu Mayer" , "username" : "kam" , "state" : "active" , "avatar_url" : "http://www.gravatar.com/avatar/018729e129a6f31c80a6327a30196823?s=80&d=identicon" , "web_url" : "http://gitlab.example.com/kam" }, "start_date" : null , "start_date_is_fixed" : false , "start_date_fixed" : null , "start_date_from_milestones" : null , //deprecated in favor of start_date_from_inherited_source "start_date_from_inherited_source" : null , "end_date" : "2018-07-31" , //deprecated in favor of due_date "due_date" : "2018-07-31" , "due_date_is_fixed" : false , "due_date_fixed" : null , "due_date_from_milestones" : "2018-07-31" , //deprecated in favor of start_date_from_inherited_source "due_date_from_inherited_source" : "2018-07-31" , "created_at" : "2018-07-17T13:36:22.770Z" , "updated_at" : "2018-07-18T12:22:05.239Z" , "closed_at" : "2018-08-18T12:22:05.239Z" , "imported" : false , "imported_from" : "none" , "labels" : [], "upvotes" : 4 , "downvotes" : 0 , "color" : "#1068bf" , "_links" :{ "self" : "http://gitlab.example.com/api/v4/groups/17/epics/35" , "epic_issues" : "http://gitlab.example.com/api/v4/groups/17/epics/35/issues" , "group" : "http://gitlab.example.com/api/v4/groups/17" , "parent" : "http://gitlab.example.com/api/v4/groups/17/epics/1" } } ] Retrieve an epic Retrieves a specified epic for a group.
GET /groups/:id/epics/:epic_iid Attri
The rest of this page is on the live site.