Award emoji

Use this API to manage emoji reactions.

GitLab objects that accept emoji reactions are called awardables. You can react with emoji on the following resources:

List all emoji reactions for an issue

GET /api/v4/projects/{id}/issues/{issue_iid}/award_emoji

Lists all emoji reactions for a specified issue. This endpoint can be accessed without authentication if the issue is publicly accessible.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`issue_iid` Path, required	Integer	ID (`iid` for merge requests/issues, `id` for snippets) of an awardable
`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	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Add an emoji reaction to an issue

POST /api/v4/projects/{id}/issues/{issue_iid}/award_emoji

Adds an emoji reaction to an issue.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from an issue

GET /api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id}

Retrieves a specified emoji reaction from an issue. This endpoint can be accessed without authentication if the issue is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable

Responses

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

Delete an emoji reaction from an issue

DELETE /api/v4/projects/{id}/issues/{issue_iid}/award_emoji/{award_id}

Deletes a specified emoji reaction from an issue. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

List all emoji reactions for an issue comment

GET /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji

Lists all emoji reactions for a specified comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`note_id` Path, required	Integer	The ID of a note
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable

Responses

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

Add an emoji reaction to an issue comment

POST /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji

Adds an emoji reaction to a comment on an issue.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from an issue comment

GET /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id}

Retrieves a specified emoji reaction from a comment on an issue. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Responses

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

Delete an emoji reaction from an issue comment

DELETE /api/v4/projects/{id}/issues/{issue_iid}/notes/{note_id}/award_emoji/{award_id}

Deletes a specified emoji reaction from a comment on an issue. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`issue_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

List all emoji reactions for a merge request

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji

Lists all emoji reactions for a specified merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`merge_request_iid` Path, required	Integer	ID (`iid` for merge requests/issues, `id` for snippets) of an awardable
`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	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Add an emoji reaction to a merge request

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji

Adds an emoji reaction to a merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from a merge request

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id}

Retrieves a specified emoji reaction from a merge request. This endpoint can be accessed without authentication if the merge request is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

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

Delete an emoji reaction from a merge request

DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/award_emoji/{award_id}

Deletes a specified emoji reaction from a merge request. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

List all emoji reactions for a merge request comment

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji

Lists all emoji reactions for a specified comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`note_id` Path, required	Integer	The ID of a note
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable

Responses

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

Add an emoji reaction to a merge request comment

POST /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji

Adds an emoji reaction to a comment on a merge request.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from a merge request comment

GET /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id}

Retrieves a specified emoji reaction from a comment on a merge request. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Responses

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

Delete an emoji reaction from a merge request comment

DELETE /api/v4/projects/{id}/merge_requests/{merge_request_iid}/notes/{note_id}/award_emoji/{award_id}

Deletes a specified emoji reaction from a comment on a merge request. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`merge_request_iid` Path, required	Integer	The internal ID of an issuable
`note_id` Path, required	Integer	The ID of a note

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

List all emoji reactions for a snippet

GET /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji

Lists all emoji reactions for a specified snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project
`snippet_id` Path, required	Integer	ID (`iid` for merge requests/issues, `id` for snippets) of an awardable
`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	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Add an emoji reaction to a snippet

POST /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji

Adds an emoji reaction to a snippet.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from a snippet

GET /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}

Retrieves a specified emoji reaction from a snippet. This endpoint can be accessed without authentication if the snippet is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet

Responses

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

Delete an emoji reaction from a snippet

DELETE /api/v4/projects/{id}/snippets/{snippet_id}/award_emoji/{award_id}

Deletes a specified emoji reaction from a snippet. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

List all emoji reactions for a snippet comment

GET /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji

Lists all emoji reactions for a specified comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`note_id` Path, required	Integer	The ID of a note
`page` Query	Integer	Current page number Default: `1` Example: `1`
`per_page` Query	Integer	Number of items per page Default: `20` Example: `20`
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet

Responses

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

Add an emoji reaction to a snippet comment

POST /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji

Adds an emoji reaction to a comment on a snippet.

Parameters

Name	Type	Description
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet
`note_id` Path, required	Integer	The ID of a note

Request body (application/json)

Property	Type	Description
`name` Required	String	Name of the emoji without colons

Responses

Code	Description	Schema
`201`	Created	APIEntitiesAwardEmoji
`400`	Bad Request	—
`404`	Not Found	—

Retrieve an emoji reaction from a snippet comment

GET /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id}

Retrieves a specified emoji reaction from a comment on a snippet. This endpoint can be accessed without authentication if the comment is publicly accessible.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of the emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet
`note_id` Path, required	Integer	The ID of a note

Responses

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

Delete an emoji reaction from a snippet comment

DELETE /api/v4/projects/{id}/snippets/{snippet_id}/notes/{note_id}/award_emoji/{award_id}

Deletes a specified emoji reaction from a comment on a snippet. Only an administrator or the user who added the reaction can delete it.

Parameters

Name	Type	Description
`award_id` Path, required	Integer	ID of an emoji reaction
`id` Path, required	String or integer	The ID or URL-encoded path of the project Example: `11`
`snippet_id` Path, required	Integer	The ID of a project snippet
`note_id` Path, required	Integer	The ID of a note

Responses

Code	Description	Schema
`204`	No Content	—
`400`	Bad Request	—
`401`	Unauthorized	—
`404`	Not Found	—

Schemas

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

APIEntitiesAwardEmoji

Property	Type	Description
`awardable_id`	Integer (int64)	Example: `42`
`awardable_type`	String	Example: `Issue`
`created_at`	String (date-time)	Example: `2019-01-10T13:39:08Z`
`id`	Integer (int64)	Example: `1`
`name`	String	Example: `lizard`
`updated_at`	String (date-time)	Example: `2020-06-28T10:52:04Z`
`url`	String	Example: `https://example.com/emojis/example.gif`
`user`	APIEntitiesUserBasic	—

APIEntitiesCustomAttribute

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

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 emoji reactions for an issue

Add an emoji reaction to an issue

Retrieve an emoji reaction from an issue

Delete an emoji reaction from an issue

List all emoji reactions for an issue comment

Add an emoji reaction to an issue comment

Retrieve an emoji reaction from an issue comment

Delete an emoji reaction from an issue comment

List all emoji reactions for a merge request

Add an emoji reaction to a merge request

Retrieve an emoji reaction from a merge request

Delete an emoji reaction from a merge request

List all emoji reactions for a merge request comment

Add an emoji reaction to a merge request comment

Retrieve an emoji reaction from a merge request comment

Delete an emoji reaction from a merge request comment

List all emoji reactions for a snippet

Add an emoji reaction to a snippet

Retrieve an emoji reaction from a snippet

Delete an emoji reaction from a snippet

List all emoji reactions for a snippet comment

Add an emoji reaction to a snippet comment

Retrieve an emoji reaction from a snippet comment

Delete an emoji reaction from a snippet comment

Schemas

APIEntitiesAwardEmoji

APIEntitiesCustomAttribute

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