List all group epics

GET

/api/v4/groups/{id}/-/epics

Lists all epics for a specified group and its subgroups. Responses are paginated and return 20 results by default.

Authorizations

http
oauth2

Parameters

Path Parameters

required

string

The ID of a group

Query Parameters

order_by

string

default: created_at nullable

Allowed values: created_at updated_at title

Return epics ordered by created_at, updated_at or title fields.

sort

string

default: desc nullable

Allowed values: asc desc

Return epics sorted in asc or desc order.

search

string

nullable

Search epics for text present in the title or description

Example

title search term

state

string

default: all nullable

Allowed values: opened closed all

Return opened, closed, or all epics

author_id

integer

nullable

Return epics which are authored by the user with the given ID

Example

author_username

string

nullable

Return epics which are authored by the given username

Example

root

labels

Array<string>

nullable

Comma-separated list of label names

Example

?labels=bug,reproduced

with_labels_details

boolean

nullable

Return titles of labels and other details

created_after

string format: date-time

nullable

Return epics created after the specified time

Example

2019-03-15T08:00:00Z

created_before

string format: date-time

nullable

Return epics created before the specified time

Example

2019-03-15T08:00:00Z

updated_after

string format: date-time

nullable

Return epics updated after the specified time

Example

2019-03-15T08:00:00Z

updated_before

string format: date-time

nullable

Return epics updated before the specified time

Example

2019-03-15T08:00:00Z

include_ancestor_groups

boolean

nullable

Include epics from ancestor groups

include_descendant_groups

boolean

default: true nullable

Include epics from descendant groups

my_reaction_emoji

string

nullable

Return epics reacted by the authenticated user by the given emoji

Example

slight_frown

confidential

boolean

nullable

Return epics with given confidentiality

page

integer

default: 1 nullable

Current page number

Example

per_page

integer

default: 20 nullable

Number of items per page

Example

not

Object that contains filters

object

not[labels]

Array<string>

nullable

Comma-separated list of label names

Example

[
  "bug",
  "reproduced"
]

not[author_id]

integer

nullable

Return epics which are not authored by the user with the given ID

Example

not[author_username]

string

nullable

Return epics which are not authored by the given username

Example

root

Responses

200

application/json

object

integer format: int64

work_item_id

integer

iid

integer

color

string

text_color

string

group_id

integer format: int64

parent_id

integer format: int64

parent_iid

integer

imported

boolean

imported_from

string

title

string

description

string

confidential

boolean

author

object

integer format: int64

username

string

public_email

string

name

string

state

string

locked

boolean

avatar_url

string

avatar_path

string

custom_attributes

Array<object>

object

key

string

value

string

web_url

string

start_date

string format: date-time

start_date_is_fixed

boolean

start_date_fixed

string format: date-time

start_date_from_inherited_source

string format: date-time

start_date_from_milestones

string format: date-time

end_date

string format: date-time

due_date

string format: date-time

due_date_is_fixed

boolean

due_date_fixed

string format: date-time

due_date_from_inherited_source

string format: date-time

due_date_from_milestones

string format: date-time

state

string

web_edit_url

string

web_url

string

references

Array<object>

object

reference

string

created_at

string format: date-time

updated_at

string format: date-time

closed_at

string format: date-time

labels

Array<string>

upvotes

integer

downvotes

integer

subscribed

boolean

_links

object

Example

{
  "id": 123,
  "work_item_id": 123,
  "iid": 123,
  "color": "#1068bf",
  "text_color": "#1068bf",
  "group_id": 17,
  "parent_id": 12,
  "parent_iid": 19,
  "imported": false,
  "imported_from": "github",
  "title": "My Epic",
  "description": "Epic description",
  "confidential": false,
  "author": {
    "id": 1,
    "username": "admin",
    "public_email": "john@example.com",
    "name": "Administrator",
    "state": "active",
    "avatar_url": "https://gravatar.com/avatar/1",
    "avatar_path": "/user/avatar/28/The-Big-Lebowski-400-400.png",
    "custom_attributes": [
      {
        "key": "foo",
        "value": "bar"
      }
    ],
    "web_url": "https://gitlab.example.com/root"
  },
  "start_date": "2022-01-31T15:10:45.080Z",
  "start_date_is_fixed": true,
  "start_date_fixed": "2022-01-31T15:10:45.080Z",
  "start_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
  "start_date_from_milestones": "2022-01-31T15:10:45.080Z",
  "end_date": "2022-01-31T15:10:45.080Z",
  "due_date": "2022-01-31T15:10:45.080Z",
  "due_date_is_fixed": true,
  "due_date_fixed": "2022-01-31T15:10:45.080Z",
  "due_date_from_inherited_source": "2022-01-31T15:10:45.080Z",
  "due_date_from_milestones": "2022-01-31T15:10:45.080Z",
  "state": "opened",
  "web_edit_url": "http://gitlab.example.com/groups/test/-/epics/4/edit",
  "web_url": "http://gitlab.example.com/groups/test/-/epics/4",
  "reference": "&1",
  "created_at": "2022-01-31T15:10:45.080Z",
  "updated_at": "2022-01-31T15:10:45.080Z",
  "closed_at": "2022-01-31T15:10:45.080Z",
  "upvotes": 4,
  "downvotes": 3,
  "subscribed": true
}

400

Bad Request

403

Forbidden

404

Not found

422

Unprocessable entity