GitLab CI/CD invitations API

Operations about invitations

Operations 8

POST /api/v4/groups/{id}/invitations Invite non-members by email address to a group or project. #
GET /api/v4/groups/{id}/invitations Get a list of group or project invitations viewable by the authenticated user #
PUT /api/v4/groups/{id}/invitations/{email} #
DELETE /api/v4/groups/{id}/invitations/{email} #
POST /api/v4/projects/{id}/invitations Invite non-members by email address to a group or project. #
GET /api/v4/projects/{id}/invitations Get a list of group or project invitations viewable by the authenticated user #
PUT /api/v4/projects/{id}/invitations/{email} #
DELETE /api/v4/projects/{id}/invitations/{email} #

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-ci-invitations-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

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.

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

OpenAPI Specification

gitlab-ci-invitations-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: GitLab access_requests Invitations API
  version: v4
  description: Operations related to access requests
servers:
- url: https://gitlab.com
tags:
- name: invitations
  description: Operations about invitations
paths:
  /api/v4/groups/{id}/invitations:
    post:
      summary: Invite non-members by email address to a group or project.
      description: This feature was introduced in GitLab 13.6
      parameters:
      - in: path
        name: id
        description: The group ID
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Invite non-members by email address to a group or project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: postApiV4GroupsIdInvitations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4GroupsIdInvitations'
        required: true
    get:
      summary: Get a list of group or project invitations viewable by the authenticated user
      description: This feature was introduced in GitLab 13.6
      parameters:
      - in: path
        name: id
        description: The group ID
        required: true
        schema:
          type: string
      - in: query
        name: page
        description: Current page number
        required: false
        example: 1
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        description: Number of items per page
        required: false
        example: 20
        schema:
          type: integer
          format: int32
          default: 20
      - in: query
        name: query
        description: A query string to search for members
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Get a list of group or project invitations viewable by the authenticated user
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: getApiV4GroupsIdInvitations
  /api/v4/groups/{id}/invitations/{email}:
    put:
      description: Updates a group or project invitation.
      parameters:
      - in: path
        name: id
        description: The group ID
        required: true
        schema:
          type: string
      - in: path
        name: email
        description: The email address of the invitation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updates a group or project invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: putApiV4GroupsIdInvitationsEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4GroupsIdInvitationsEmail'
        required: true
    delete:
      description: Removes an invitation from a group or project.
      parameters:
      - in: path
        name: id
        description: The group ID
        required: true
        schema:
          type: string
      - in: path
        name: email
        description: The email address of the invitation
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Removes an invitation from a group or project.
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Could not delete invitation
      tags:
      - invitations
      operationId: deleteApiV4GroupsIdInvitationsEmail
  /api/v4/projects/{id}/invitations:
    post:
      summary: Invite non-members by email address to a group or project.
      description: This feature was introduced in GitLab 13.6
      parameters:
      - in: path
        name: id
        description: The project ID
        required: true
        schema:
          type: string
      responses:
        '201':
          description: Invite non-members by email address to a group or project.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: postApiV4ProjectsIdInvitations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4ProjectsIdInvitations'
        required: true
    get:
      summary: Get a list of group or project invitations viewable by the authenticated user
      description: This feature was introduced in GitLab 13.6
      parameters:
      - in: path
        name: id
        description: The project ID
        required: true
        schema:
          type: string
      - in: query
        name: page
        description: Current page number
        required: false
        example: 1
        schema:
          type: integer
          format: int32
          default: 1
      - in: query
        name: per_page
        description: Number of items per page
        required: false
        example: 20
        schema:
          type: integer
          format: int32
          default: 20
      - in: query
        name: query
        description: A query string to search for members
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Get a list of group or project invitations viewable by the authenticated user
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: getApiV4ProjectsIdInvitations
  /api/v4/projects/{id}/invitations/{email}:
    put:
      description: Updates a group or project invitation.
      parameters:
      - in: path
        name: id
        description: The project ID
        required: true
        schema:
          type: string
      - in: path
        name: email
        description: The email address of the invitation
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Updates a group or project invitation.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/API_Entities_Invitation'
      tags:
      - invitations
      operationId: putApiV4ProjectsIdInvitationsEmail
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/putApiV4ProjectsIdInvitationsEmail'
        required: true
    delete:
      description: Removes an invitation from a group or project.
      parameters:
      - in: path
        name: id
        description: The project ID
        required: true
        schema:
          type: string
      - in: path
        name: email
        description: The email address of the invitation
        required: true
        schema:
          type: string
      responses:
        '204':
          description: Removes an invitation from a group or project.
        '403':
          description: Forbidden
        '404':
          description: Not found
        '409':
          description: Could not delete invitation
      tags:
      - invitations
      operationId: deleteApiV4ProjectsIdInvitationsEmail
components:
  schemas:
    putApiV4GroupsIdInvitationsEmail:
      type: object
      properties:
        access_level:
          type: integer
          format: int32
          description: 'A valid access level (defaults: `30`, developer access level)'
          enum:
          - 10
          - 15
          - 20
          - 30
          - 40
          - 50
        expires_at:
          type: string
          format: date-time
          description: Date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)
        member_role_id:
          type: integer
          format: int32
          description: The ID of a member role for the invited user
      description: Updates a group or project invitation.
    API_Entities_Invitation:
      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
      required:
      - access_level
      - created_at
      - expires_at
      - invite_email
      - invite_token
      - created_by_name
      description: API_Entities_Invitation model
    putApiV4ProjectsIdInvitationsEmail:
      type: object
      properties:
        access_level:
          type: integer
          format: int32
          description: 'A valid access level (defaults: `30`, developer access level)'
          enum:
          - 10
          - 15
          - 20
          - 30
          - 40
          - 50
        expires_at:
          type: string
          format: date-time
          description: Date string in ISO 8601 format (`YYYY-MM-DDTHH:MM:SSZ`)
        member_role_id:
          type: integer
          format: int32
          description: The ID of a member role for the invited user
      description: Updates a group or project invitation.
    postApiV4ProjectsIdInvitations:
      type: object
      properties:
        access_level:
          type: integer
          format: int32
          description: 'A valid access level (defaults: `30`, developer access level)'
          enum:
          - 10
          - 15
          - 20
          - 30
          - 40
          - 50
          - 5
        email:
          type: array
          description: The email address to invite, or multiple emails separated by comma
          items:
            type: string
        user_id:
          type: array
          description: The user ID of the new member or multiple IDs separated by commas.
          items:
            type: string
        expires_at:
          type: string
          format: date-time
          description: Date string in the format YEAR-MONTH-DAY
        invite_source:
          type: string
          description: Source that triggered the member creation process
          default: invitations-api
        member_role_id:
          type: integer
          format: int32
          description: The ID of a member role for the invited user
      required:
      - access_level
      description: Invite non-members by email address to a group or project.
    postApiV4GroupsIdInvitations:
      type: object
      properties:
        access_level:
          type: integer
          format: int32
          description: 'A valid access level (defaults: `30`, developer access level)'
          enum:
          - 10
          - 15
          - 20
          - 30
          - 40
          - 50
          - 5
        email:
          type: array
          description: The email address to invite, or multiple emails separated by comma
          items:
            type: string
        user_id:
          type: array
          description: The user ID of the new member or multiple IDs separated by commas.
          items:
            type: string
        expires_at:
          type: string
          format: date-time
          description: Date string in the format YEAR-MONTH-DAY
        invite_source:
          type: string
          description: Source that triggered the member creation process
          default: invitations-api
        member_role_id:
          type: integer
          format: int32
          description: The ID of a member role for the invited user
      required:
      - access_level
      description: Invite non-members by email address to a group or project.
  securitySchemes:
    access_token_header:
      type: apiKey
      name: PRIVATE-TOKEN
      in: header
    access_token_query:
      type: apiKey
      name: private_token
      in: query