GitLab Invitations API

openapi: 3.2.0
info:
  title: GitLab REST Invitations 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: Invitations
  description: Use this API to manage invitations and add users to a group or project.
  x-displayName: Invitations
  externalDocs:
    url: https://docs.gitlab.com/api/invitations/
paths:
  /api/v4/groups/{id}/invitations:
    post:
      operationId: postApiV4GroupsIdInvitations
      summary: Add a member to a group
      description: Adds a member to a group. You can specify a user ID or invite a user by email.
      tags:
      - Invitations
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdInvitationsRequest'
    get:
      operationId: getApiV4GroupsIdInvitations
      summary: List all pending invitations for a group
      description: Lists all pending invitations for a specified group viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters `page` and `per_page` to restrict the list of members.
      tags:
      - Invitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: query
        required: false
        description: Return only invitations sent to this email address. Must match exactly. If omitted, returns all invitations.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/groups/{id}/invitations/{email}:
    put:
      operationId: putApiV4GroupsIdInvitationsEmail
      summary: Update an invitation to a group
      description: Updates a pending invitation to a group.
      tags:
      - Invitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      - name: email
        required: true
        description: Email address the invitation was previously sent to.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdInvitationsEmailRequest'
    delete:
      operationId: deleteApiV4GroupsIdInvitationsEmail
      summary: Delete an invitation to a group
      description: Deletes a pending invitation to a specified email address for a group.
      tags:
      - Invitations
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Could not delete invitation
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the group.
        schema:
          type: string
        in: path
      - name: email
        required: true
        description: Email address the invitation was previously sent to.
        schema:
          type: string
        in: path
  /api/v4/projects/{id}/invitations:
    post:
      operationId: postApiV4ProjectsIdInvitations
      summary: Add a member to a project
      description: Adds a member to a project. You can specify a user ID or invite a user by email.
      tags:
      - Invitations
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdInvitationsRequest'
    get:
      operationId: getApiV4ProjectsIdInvitations
      summary: List all pending invitations for a project
      description: Lists all pending invitations for a specified project viewable by the authenticated user. Returns invitations to direct members only, and not through inherited ancestor groups. This function takes pagination parameters `page` and `per_page` to restrict the list of members.
      tags:
      - Invitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      - name: page
        required: false
        description: Page number of results to retrieve.
        schema:
          type: integer
          default: 1
        in: query
        example: 1
      - name: per_page
        required: false
        description: Number of items to list per page.
        schema:
          type: integer
          default: 20
        in: query
        example: 20
      - name: query
        required: false
        description: Return only invitations sent to this email address. Must match exactly. If omitted, returns all invitations.
        schema:
          type:
          - string
          - 'null'
        in: query
  /api/v4/projects/{id}/invitations/{email}:
    put:
      operationId: putApiV4ProjectsIdInvitationsEmail
      summary: Update an invitation to a project
      description: Updates a pending invitation to a project.
      tags:
      - Invitations
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesInvitation'
        '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
      - name: email
        required: true
        description: Email address the invitation was previously sent to.
        schema:
          type: string
        in: path
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdInvitationsEmailRequest'
    delete:
      operationId: deleteApiV4ProjectsIdInvitationsEmail
      summary: Delete an invitation to a project
      description: Deletes a pending invitation to a specified email address for a project.
      tags:
      - Invitations
      responses:
        '204':
          description: No Content
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Could not delete invitation
        '400':
          description: Bad Request
      parameters:
      - name: id
        required: true
        description: ID or URL-encoded path of the project.
        schema:
          type: string
        in: path
      - name: email
        required: true
        description: Email address the invitation was previously sent to.
        schema:
          type: string
        in: path
components:
  schemas:
    postApiV4GroupsIdInvitationsRequest:
      type: object
      properties:
        access_level:
          type: integer
          enum:
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          - 50
          - 5
          description: Access level to grant to the invited user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
        email:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Email address of the member to invite, or multiple email addresses separated by commas. Required if `user_id` is not provided.
        user_id:
          type:
          - array
          - 'null'
          items:
            type: string
          description: ID of the user to invite, or multiple IDs separated by commas. Required if `email` is not provided.
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Date when the invitation expires.
        invite_source:
          type: string
          description: Source of the invitation that starts the member creation process.
          default: invitations-api
        member_role_id:
          type:
          - integer
          - 'null'
          description: ID of a member role to assign to the invited user. Ultimate only.
      required:
      - access_level
    putApiV4GroupsIdInvitationsEmailRequest:
      type: object
      properties:
        access_level:
          type:
          - integer
          - 'null'
          enum:
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          - 50
          - null
          description: Access level to grant to the invited user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Date when the invitation expires.
        member_role_id:
          type:
          - integer
          - 'null'
          description: ID of a member role to assign to the invited user. Ultimate only.
    postApiV4ProjectsIdInvitationsRequest:
      type: object
      properties:
        access_level:
          type: integer
          enum:
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          - 50
          - 5
          description: Access level to grant to the invited user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
        email:
          type:
          - array
          - 'null'
          items:
            type: string
          description: Email address of the member to invite, or multiple email addresses separated by commas. Required if `user_id` is not provided.
        user_id:
          type:
          - array
          - 'null'
          items:
            type: string
          description: ID of the user to invite, or multiple IDs separated by commas. Required if `email` is not provided.
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Date when the invitation expires.
        invite_source:
          type: string
          description: Source of the invitation that starts the member creation process.
          default: invitations-api
        member_role_id:
          type:
          - integer
          - 'null'
          description: ID of a member role to assign to the invited user. Ultimate only.
      required:
      - access_level
    APIEntitiesInvitation:
      type: object
      properties:
        access_level:
          type: string
        created_at:
          type: string
        expires_at:
          type: string
        invite_email:
          type: string
        invite_token:
          type: string
        user_name:
          type: string
        created_by_name:
          type: string
    putApiV4ProjectsIdInvitationsEmailRequest:
      type: object
      properties:
        access_level:
          type:
          - integer
          - 'null'
          enum:
          - 10
          - 15
          - 20
          - 25
          - 30
          - 40
          - 50
          - null
          description: Access level to grant to the invited user. For a list of values, see [roles](https://docs.gitlab.com/user/permissions/#default-roles).
        expires_at:
          type:
          - string
          - 'null'
          format: date-time
          description: Date when the invitation expires.
        member_role_id:
          type:
          - integer
          - 'null'
          description: ID of a member role to assign to the invited user. Ultimate only.
  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