Documentation
Documentation
https://docs.gitlab.com/api/
APIReference
https://docs.gitlab.com/api/api_resources/
Authentication
https://docs.gitlab.com/api/rest/authentication/
swagger: '2.0'
info:
title: GitLab access_requests award_emoji API
version: v4
description: Operations related to access requests
host: gitlab.com
produces:
- application/json
tags:
- name: award_emoji
description: Operations about award_emoji
paths:
/api/v4/groups/{id}/epics/{epic_iid}/award_emoji:
get:
summary: List an awardable's emoji reactions for groups
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the group
type: string
required: true
- in: path
name: epic_iid
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
type: integer
format: int32
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
responses:
'200':
description: List an awardable's emoji reactions for groups
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4GroupsIdEpicsEpicIidAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
- name: postApiV4GroupsIdEpicsEpicIidAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4GroupsIdEpicsEpicIidAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4GroupsIdEpicsEpicIidAwardEmoji
/api/v4/groups/{id}/epics/{epic_iid}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4GroupsIdEpicsEpicIidAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4GroupsIdEpicsEpicIidAwardEmojiAwardId
/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji:
get:
summary: List an awardable's emoji reactions for groups
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: List an awardable's emoji reactions for groups
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
- name: postApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmoji
/api/v4/groups/{id}/epics/{epic_iid}/notes/{note_id}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: epic_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4GroupsIdEpicsEpicIidNotesNoteIdAwardEmojiAwardId
/api/v4/projects/{id}/issues/{issue_iid}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project
type: string
required: true
- in: path
name: issue_iid
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
type: integer
format: int32
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdIssuesIssueIidAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
- name: postApiV4ProjectsIdIssuesIssueIidAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdIssuesIssueIidAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4ProjectsIdIssuesIssueIidAwardEmoji
/api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdIssuesIssueIidAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4ProjectsIdIssuesIssueIidAwardEmojiAwardId
/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
- name: postApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmoji
/api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: issue_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4ProjectsIdIssuesIssueIidNotesNoteIdAwardEmojiAwardId
/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project
type: string
required: true
- in: path
name: merge_request_iid
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
type: integer
format: int32
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
- name: postApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmoji
/api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4ProjectsIdMergeRequestsMergeRequestIidAwardEmojiAwardId
/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
- name: postApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmoji
/api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: merge_request_iid
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4ProjectsIdMergeRequestsMergeRequestIidNotesNoteIdAwardEmojiAwardId
/api/v4/projects/{id}/snippets/{snippet_id}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: id
description: The ID or URL-encoded path of the project
type: string
required: true
- in: path
name: snippet_id
description: ID (`iid` for merge requests/issues/epics, `id` for snippets) of an awardable.
type: integer
format: int32
required: true
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdSnippetsSnippetIdAwardEmoji
post:
summary: Add a new emoji reaction
description: Add an emoji reaction on the specified awardable. This feature was introduced in 8.9
produces:
- application/json
consumes:
- application/json
parameters:
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: snippet_id
type: integer
format: int32
required: true
- name: postApiV4ProjectsIdSnippetsSnippetIdAwardEmoji
in: body
required: true
schema:
$ref: '#/definitions/postApiV4ProjectsIdSnippetsSnippetIdAwardEmoji'
responses:
'201':
description: Add a new emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'400':
description: Bad Request
'404':
description: Not Found
tags:
- award_emoji
operationId: postApiV4ProjectsIdSnippetsSnippetIdAwardEmoji
/api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}:
get:
summary: Get a single emoji reaction
description: Get a single emoji reaction from an issue, snippet, or merge request. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of the emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: snippet_id
type: integer
format: int32
required: true
responses:
'200':
description: Get a single emoji reaction
schema:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
description: Not Found
tags:
- award_emoji
operationId: getApiV4ProjectsIdSnippetsSnippetIdAwardEmojiAwardId
delete:
summary: Delete an emoji reaction
description: Only an administrator or the author of the reaction can delete an emoji reaction. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: path
name: award_id
description: ID of an emoji reaction.
type: integer
format: int32
required: true
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: snippet_id
type: integer
format: int32
required: true
responses:
'204':
description: Delete an emoji reaction
'401':
description: Unauthorized
'404':
description: Not Found
tags:
- award_emoji
operationId: deleteApiV4ProjectsIdSnippetsSnippetIdAwardEmojiAwardId
/api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji:
get:
summary: List an awardable's emoji reactions for projects
description: Get a list of all emoji reactions for a specified awardable. This feature was introduced in 8.9
produces:
- application/json
parameters:
- in: query
name: page
description: Current page number
type: integer
format: int32
default: 1
required: false
example: 1
- in: query
name: per_page
description: Number of items per page
type: integer
format: int32
default: 20
required: false
example: 20
- in: path
name: id
type: integer
format: int32
required: true
- in: path
name: snippet_id
type: integer
format: int32
required: true
- in: path
name: note_id
type: integer
format: int32
required: true
responses:
'200':
description: List an awardable's emoji reactions for projects
schema:
type: array
items:
$ref: '#/definitions/API_Entities_AwardEmoji'
'404':
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/gitlab-ci/refs/heads/main/openapi/gitlab-ci-award-emoji-api-openapi.yml