GitLab

GitLab Notification settings API

Use this API to retrieve and update [notification settings](https://docs.gitlab.com/user/profile/notifications/) globally for your account, or for an individual group or project, which overrides the global setting.

GitHub OpenAPI

Operations 6

GET /api/v4/notification_settings Retrieve global notification settings #
PUT /api/v4/notification_settings Update global notification settings #
GET /api/v4/groups/{id}/notification_settings Retrieve notification settings for a group #
PUT /api/v4/groups/{id}/notification_settings Update notification settings for a group #
GET /api/v4/projects/{id}/notification_settings Retrieve notification settings for a project #
PUT /api/v4/projects/{id}/notification_settings Update notification settings for a project #

Documentation

📖
Documentation
https://docs.gitlab.com/api/openapi/
📖
Documentation
https://docs.gitlab.com/api/issues/
📖
Authentication
https://docs.gitlab.com/api/rest/authentication/
📖
Documentation
https://docs.gitlab.com/api/merge_requests/
📖
Documentation
https://docs.gitlab.com/api/pipelines/
📖
Documentation
https://docs.gitlab.com/api/jobs/
📖
Documentation
https://docs.gitlab.com/api/runners/
📖
Documentation
https://docs.gitlab.com/api/users/
📖
Documentation
https://docs.gitlab.com/api/repositories/
📖
Documentation
https://docs.gitlab.com/api/commits/
📖
Documentation
https://docs.gitlab.com/api/branches/
📖
Documentation
https://docs.gitlab.com/api/tags/
📖
Documentation
https://docs.gitlab.com/api/releases/
📖
Documentation
https://docs.gitlab.com/api/environments/
📖
Documentation
https://docs.gitlab.com/api/deployments/
📖
Documentation
https://docs.gitlab.com/api/pipeline_schedules/
📖
Documentation
https://docs.gitlab.com/api/labels/
📖
Documentation
https://docs.gitlab.com/api/milestones/
📖
Documentation
https://docs.gitlab.com/api/notes/
📖
Documentation
https://docs.gitlab.com/api/snippets/
📖
Documentation
https://docs.gitlab.com/api/packages/
📖
Documentation
https://docs.gitlab.com/api/container_registry/
📖
Documentation
https://docs.gitlab.com/api/vulnerabilities/
📖
Documentation
https://docs.gitlab.com/api/deploy_keys/
📖
Documentation
https://docs.gitlab.com/api/protected_branches/
📖
Documentation
https://docs.gitlab.com/api/wikis/
📖
Documentation
https://docs.gitlab.com/api/events/
📖
Documentation
https://docs.gitlab.com/api/search/
📖
Documentation
https://docs.gitlab.com/api/namespaces/
📖
Documentation
https://docs.gitlab.com/api/groups/
📖
Documentation
https://docs.gitlab.com/api/projects/
📖
Documentation
https://docs.gitlab.com/api/applications/
📖
Documentation
https://docs.gitlab.com/api/avatar/
📖
Documentation
https://docs.gitlab.com/api/broadcast_messages/
📖
Documentation
https://docs.gitlab.com/api/bulk_imports/
📖
Documentation
https://docs.gitlab.com/api/settings/
📖
Documentation
https://docs.gitlab.com/api/metadata/
📖
Documentation
https://docs.gitlab.com/api/version/
📖
Documentation
https://docs.gitlab.com/api/rest/
📖
APIReference
https://docs.gitlab.com/api/api_resources/
📖
RateLimits
https://docs.gitlab.com/security/rate_limits/
📖
Documentation
https://docs.gitlab.com/api/oauth2/
📖
Authentication
https://docs.gitlab.com/integration/oauth_provider/
📖
Documentation
https://docs.gitlab.com/user/project/integrations/webhooks.html
📖
APIReference
https://docs.gitlab.com/api/project_webhooks/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/gitlab/openapi/gitlab-notification-settings-api-openapi.yml
⚙
AsyncAPI
https://artifacts.apis.io/gitlab/asyncapi/gitlab-webhooks-asyncapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-application-settings-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-node-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-geo-site-status-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-apientities-application-setting-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-post-api-v4-geo-status-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-put-api-v4-projects-id-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-cluster-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-batched-background-migration-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-ci-variable-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-dictionary-table-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-plan-limit-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-appearance-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-avatar-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-imports-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-bulk-import-schema.json
📊
JSONSchema
https://artifacts.apis.io/gitlab/json-schema/gitlab-api-entities-metadata-schema.json

Other Resources

🔗
SDKs
https://docs.gitlab.com/api/rest/third_party_clients/
🔗
Interactive Documentation
https://docs.gitlab.com/api/openapi/openapi_interactive/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/gitlab:gitlab-notification-settings-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

gitlab-notification-settings-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: GitLab REST Notification settings API
  description: GitLab REST API used to interact with a GitLab installation.
  termsOfService: https://handbook.gitlab.com/handbook/legal/api-terms/
  version: '19.6'
  license:
    name: CC BY-SA 4.0
    url: https://gitlab.com/gitlab-org/gitlab/-/blob/master/LICENSE
    x-gitlab-description: The license applies to the OpenAPI specification document itself. For terms governing use of the GitLab API, see the termsOfService field.
servers:
- url: https://{hostname}
  description: GitLab REST API
  variables:
    hostname:
      default: gitlab.com
      description: Your GitLab instance hostname
security:
- http: []
- oauth2: []
- apiKey: []
tags:
- name: Notification settings
  description: 'Use this API to retrieve and update notification settings

    globally for your account, or for an individual group or project, which overrides the global setting.'
  x-displayName: Notification settings
  externalDocs:
    url: https://docs.gitlab.com/api/notification_settings/
paths:
  /api/v4/notification_settings:
    get:
      operationId: getApiV4NotificationSettings
      summary: Retrieve global notification settings
      description: Retrieves the global notification level and email address.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGlobalNotificationSetting'
        '401':
          description: Unauthorized
    put:
      operationId: putApiV4NotificationSettings
      summary: Update global notification settings
      description: Updates notification settings and email address.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesGlobalNotificationSetting'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4NotificationSettingsRequest'
  /api/v4/groups/{id}/notification_settings:
    get:
      operationId: getApiV4GroupsIdNotificationSettings
      summary: Retrieve notification settings for a group
      description: Retrieves the notification level for a specified group.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesNotificationSetting'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
    put:
      operationId: putApiV4GroupsIdNotificationSettings
      summary: Update notification settings for a group
      description: Updates the notification settings for a specified group.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesNotificationSetting'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdNotificationSettingsRequest'
  /api/v4/projects/{id}/notification_settings:
    get:
      operationId: getApiV4ProjectsIdNotificationSettings
      summary: Retrieve notification settings for a project
      description: Retrieves the notification level for a specified project.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesNotificationSetting'
        '401':
          description: Unauthorized
        '404':
          description: Not Found
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
    put:
      operationId: putApiV4ProjectsIdNotificationSettings
      summary: Update notification settings for a project
      description: Updates the notification settings for a specified project.
      tags:
      - Notification settings
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesNotificationSetting'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not Found
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdNotificationSettingsRequest'
components:
  schemas:
    putApiV4ProjectsIdNotificationSettingsRequest:
      type: object
      properties:
        level:
          type:
          - string
          - 'null'
          description: The project notification level
        new_release:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_note:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        issue_due:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        push_to_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        change_reviewer_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        moved_project:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_when_pipeline_succeeds:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        approver:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
    putApiV4GroupsIdNotificationSettingsRequest:
      type: object
      properties:
        level:
          type:
          - string
          - 'null'
          description: The group notification level
        new_release:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_note:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        issue_due:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        push_to_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        change_reviewer_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        moved_project:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_when_pipeline_succeeds:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_epic:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
    APIEntitiesNotificationSetting:
      type: object
      properties:
        level:
          type: string
        events:
          type: string
    APIEntitiesGlobalNotificationSetting:
      type: object
      properties:
        level:
          type: string
        events:
          type: string
        notification_email:
          type: string
    putApiV4NotificationSettingsRequest:
      type: object
      properties:
        level:
          type:
          - string
          - 'null'
          description: Global notification level.
        notification_email:
          type:
          - string
          - 'null'
          description: Email address where notifications are sent.
        new_release:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_note:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_issue:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        issue_due:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        push_to_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reopen_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        close_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        reassign_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        change_reviewer_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_merge_request:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        moved_project:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        merge_when_pipeline_succeeds:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        new_epic:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_failed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_success_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        service_account_fixed_pipeline:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
        approver:
          type:
          - boolean
          - 'null'
          description: Enable/disable this notification
  securitySchemes:
    http:
      type: http
      scheme: bearer
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://gitlab.com/oauth/authorize
          tokenUrl: https://gitlab.com/oauth/token
          refreshUrl: https://gitlab.com/oauth/token
          scopes:
            api: Grants complete read/write access to the API, including all groups and projects, the container registry, the dependency proxy, and the package registry.
            read_api: Grants read access to the API, including all groups and projects, the container registry, and the package registry.
            read_user: Grants read-only access to your profile through the /user API endpoint, which includes username, public email, and full name. Also grants access to read-only API endpoints under /users.
            create_runner: Grants create access to the runners.
            manage_runner: Grants access to manage the runners.
            k8s_proxy: Grants permission to perform Kubernetes API calls using the agent for Kubernetes.
            self_rotate: Grants permission for token to rotate itself.
            mcp: Grants read-write access to remote Model Context Protocol (MCP) server for tools execution.
            mcp_orbit: Grants access to the Orbit Knowledge Graph MCP server for graph queries and schema retrieval.
    apiKey:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header