Resource events

Use this API to retrieve the events that track changes to issues, merge requests, and epics:

Label events record who added or removed a label, and when.
Iteration events record iteration changes for issues.
Milestone events record milestone changes for issues and merge requests.
State events record state changes for issues, merge requests, and epics.
Weight events record weight changes for issues.

State events do not track the initial state (created or opened) of a resource. For a resource that was never closed or reopened, an empty list is returned.

List all project issue label events

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_label_events

Lists all label events for a specified issue.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer or string	The IID of the issue
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceLabelEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an issue label event

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_label_events/{event_id}

Retrieves a label event for a specified project issue.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`event_id` Path, required	String	The ID of a resource label event
`eventable_id` Path, required	Integer or string	The IID of the issue

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceLabelEvent
`400`	Bad Request	—
`404`	Not Found	—

List all project issue milestone events

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_events

Lists all milestone events for a specified issue.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`eventable_id` Path, required	Integer or string	The ID of the eventable
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceMilestoneEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an issue milestone event

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_milestone_events/{event_id}

Retrieves a specified milestone event for a project issue.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`event_id` Path, required	String	The ID of a resource milestone event
`eventable_id` Path, required	Integer or string	The ID of the eventable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceMilestoneEvent
`400`	Bad Request	—
`404`	Not found	—

List all project issue state events

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_state_events

Lists all state events for a specified issue.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer	The IID of the issue
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceStateEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an issue state event

GET /api/v4/projects/{id}/issues/{eventable_id}/resource_state_events/{event_id}

Retrieves a state event for a specified project issue.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer	The IID of the issue
`event_id` Path, required	Integer	The ID of a resource state event

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceStateEvent
`400`	Bad Request	—
`404`	Not Found	—

List all project merge request label events

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_label_events

Lists all label events for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer or string	The IID of the merge request
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceLabelEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a merge request label event

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_label_events/{event_id}

Retrieves a label event for a specified project merge request.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`event_id` Path, required	String	The ID of a resource label event
`eventable_id` Path, required	Integer or string	The IID of the merge request

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceLabelEvent
`400`	Bad Request	—
`404`	Not Found	—

List all project merge request milestone events

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_events

Lists all milestone events for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`eventable_id` Path, required	Integer or string	The ID of the eventable
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceMilestoneEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a merge request milestone event

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_milestone_events/{event_id}

Retrieves a specified milestone event for a project merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`event_id` Path, required	String	The ID of a resource milestone event
`eventable_id` Path, required	Integer or string	The ID of the eventable

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceMilestoneEvent
`400`	Bad Request	—
`404`	Not found	—

List all project merge request state events

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_state_events

Lists all state events for a specified merge request.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer	The IID of the merge request
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceStateEvent
`400`	Bad Request	—
`404`	Not Found	—

Retrieve a merge request state event

GET /api/v4/projects/{id}/merge_requests/{eventable_id}/resource_state_events/{event_id}

Retrieves a state event for a specified project merge request.

Parameters

Name	Type	Description
`id` Path, required	String	The ID of a project
`eventable_id` Path, required	Integer	The IID of the merge request
`event_id` Path, required	Integer	The ID of a resource state event

Responses

Code	Description	Schema
`200`	OK	APIEntitiesResourceStateEvent
`400`	Bad Request	—
`404`	Not Found	—

Schemas

Objects returned by the operations above and objects nested in their request bodies.

APIEntitiesCustomAttribute

Property	Type	Description
`key`	String	Example: `foo`
`value`	String	Example: `bar`

APIEntitiesLabelBasic

Property	Type	Description
`archived`	Boolean	Example: `false`
`color`	String	Example: `#FF0000`
`description`	String	Example: `Bug reported by user`
`description_html`	String	Example: `<p>Bug reported by user</p>`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `bug`
`text_color`	String	Example: `#FFFFFF`

APIEntitiesMilestone

Property	Type	Description
`created_at`	String	—
`description`	String	—
`due_date`	String	—
`expired`	Boolean	—
`group_id`	String	—
`id`	Integer (int64)	—
`iid`	Integer (int64)	—
`project_id`	Integer (int64)	—
`start_date`	String	—
`state`	String	—
`title`	String	—
`updated_at`	String	—
`web_url`	String	—

APIEntitiesResourceLabelEvent

Property	Type	Description
`action`	String	Example: `add`
`created_at`	String (date-time)	Example: `2018-08-20T13:38:20.077Z`
`id`	Integer (int64)	Example: `142`
`label`	APIEntitiesLabelBasic	—
`resource_id`	Integer (int64)	Example: `253`
`resource_type`	String	Example: `Issue`
`user`	APIEntitiesUserBasic	—

APIEntitiesResourceMilestoneEvent

Property	Type	Description
`action`	String	Example: `add`
`created_at`	String (date-time)	Example: `2018-08-20T13:38:20.077Z`
`id`	Integer (int64)	Example: `142`
`milestone`	APIEntitiesMilestone	—
`resource_id`	Integer (int64)	Example: `253`
`resource_type`	String	Example: `Issue`
`state`	String	Example: `active`
`user`	APIEntitiesUserBasic	—

APIEntitiesResourceStateEvent

Property	Type	Description
`created_at`	String (date-time)	Example: `2018-08-20T13:38:20.077Z`
`id`	Integer (int64)	Example: `142`
`resource_id`	Integer (int64)	Example: `253`
`resource_type`	String	Example: `Issue`
`source_commit`	String	Example: `7b09ce7e6f80347baf0316c8c94cdba9a0a7e91d`
`source_merge_request_id`	Integer (int64)	Example: `45`
`state`	String	Example: `opened`
`user`	APIEntitiesUserBasic	—

APIEntitiesUserBasic

Property	Type	Description
`avatar_path`	String	Example: `/user/avatar/28/The-Big-Lebowski-400-400.png`
`avatar_url`	String	Example: `https://gravatar.com/avatar/1`
`custom_attributes`	Array of APIEntitiesCustomAttribute	—
`id`	Integer (int64)	Example: `1`
`locked`	Boolean	—
`name`	String	Example: `Administrator`
`public_email`	String	Example: `john@example.com`
`state`	String	Example: `active`
`username`	String	Example: `admin`
`web_url`	String	Example: `https://gitlab.example.com/root`

List all project issue label events

Retrieve an issue label event

List all project issue milestone events

Retrieve an issue milestone event

List all project issue state events

Retrieve an issue state event

List all project merge request label events

Retrieve a merge request label event

List all project merge request milestone events

Retrieve a merge request milestone event

List all project merge request state events

Retrieve a merge request state event

Schemas

APIEntitiesCustomAttribute

APIEntitiesLabelBasic

APIEntitiesMilestone

APIEntitiesResourceLabelEvent

APIEntitiesResourceMilestoneEvent

APIEntitiesResourceStateEvent

APIEntitiesUserBasic

Request trial access

Thank you

Error

Request callback

Thank you

Something went wrong

Book your sessions

Thank you

Error

Request demo

Thank you

Error

Get the PCI SSC Compliance Report

Thank you

Error