GitLab Organizations API

openapi: 3.2.0
info:
  title: GitLab REST Organizations 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: Organizations
  description: Use this API to interact with GitLab organizations. For more information, see organizations.
  x-displayName: Organizations
  externalDocs:
    url: https://docs.gitlab.com/api/organizations/
paths:
  /api/v4/internal/org_mover/maintenance_state:
    get:
      operationId: getApiV4InternalOrgMoverMaintenanceState
      summary: Report an organization's current lifecycle state
      description: Returns the organization's current maintenance lifecycle state.
      tags:
      - Organizations
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: organization_id
        required: true
        description: The ID of the organization
        schema:
          type:
          - integer
          - 'null'
        in: query
  /api/v4/internal/org_mover/maintenance_readiness:
    get:
      operationId: getApiV4InternalOrgMoverMaintenanceReadiness
      summary: Report cutover readiness for an organization
      description: Reports whether an organization is drained and safe to enter maintenance, and what is blocking it when not.
      tags:
      - Organizations
      responses:
        '200':
          description: OK
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '400':
          description: Bad Request
      parameters:
      - name: organization_id
        required: true
        description: The ID of the organization
        schema:
          type:
          - integer
          - 'null'
        in: query
  /api/v4/internal/org_mover/start_maintenance:
    post:
      operationId: postApiV4InternalOrgMoverStartMaintenance
      summary: Start maintenance on an organization (active -> maintenance_initialization)
      description: Begins the maintenance transition for an organization.
      tags:
      - Organizations
      responses:
        '204':
          description: No Content
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4InternalOrgMoverStartMaintenanceRequest'
  /api/v4/internal/org_mover/confirm_maintenance:
    post:
      operationId: postApiV4InternalOrgMoverConfirmMaintenance
      summary: Confirm maintenance on an organization (maintenance_initialization ->…
      description: Completes the maintenance transition once the organization is drained.
      tags:
      - Organizations
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '409':
          description: Conflict
        '422':
          description: Unprocessable entity
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4InternalOrgMoverConfirmMaintenanceRequest'
  /api/v4/internal/org_mover/cancel_maintenance:
    post:
      operationId: postApiV4InternalOrgMoverCancelMaintenance
      summary: Cancel maintenance on an organization (maintenance_initialization -> active)
      description: Aborts maintenance initialization before the organization reaches the maintenance state, returning it to active.
      tags:
      - Organizations
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4InternalOrgMoverCancelMaintenanceRequest'
  /api/v4/internal/org_mover/exit_maintenance:
    post:
      operationId: postApiV4InternalOrgMoverExitMaintenance
      summary: Exit maintenance on an organization (maintenance -> active)
      description: Returns an organization from maintenance to active.
      tags:
      - Organizations
      responses:
        '204':
          description: No Content
        '401':
          description: Unauthorized
        '404':
          description: Not found
        '422':
          description: Unprocessable entity
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/postApiV4InternalOrgMoverExitMaintenanceRequest'
  /api/v4/organizations:
    post:
      operationId: postApiV4Organizations
      summary: Create an organization
      description: Creates an organization. This feature was introduced in GitLab 17.5. This feature is behind the `allow_organization_creation` feature flag. In GitLab 18.3, the feature flag changed to `organization_switching`. In GitLab 19.4, the feature flag changed to `org_stage_experimental`.
      tags:
      - Organizations
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesOrganizationsOrganization'
        '400':
          description: Bad Request
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/postApiV4OrganizationsRequest'
      x-gitlab-lifecycle: experiment
  /api/v4/organizations/{id}:
    delete:
      operationId: deleteApiV4OrganizationsId
      summary: Soft-delete an organization
      description: This feature was introduced in GitLab 19.2.
      tags:
      - Organizations
      responses:
        '202':
          description: Accepted
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: ID of the organization.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
  /api/v4/organizations/{id}/restore:
    post:
      operationId: postApiV4OrganizationsIdRestore
      summary: Restore a soft-deleted organization
      description: Restores a soft-deleted organization. This feature was introduced in GitLab 19.6.
      tags:
      - Organizations
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/APIEntitiesOrganizationsOrganization'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
        '403':
          description: Forbidden
        '404':
          description: Not found
      parameters:
      - name: id
        required: true
        description: The ID of the organization.
        schema:
          type: integer
        in: path
      x-gitlab-lifecycle: experiment
components:
  schemas:
    postApiV4InternalOrgMoverExitMaintenanceRequest:
      type: object
      properties:
        organization_id:
          type:
          - integer
          - 'null'
          description: The ID of the organization
      required:
      - organization_id
    postApiV4InternalOrgMoverCancelMaintenanceRequest:
      type: object
      properties:
        organization_id:
          type:
          - integer
          - 'null'
          description: The ID of the organization
      required:
      - organization_id
    postApiV4InternalOrgMoverConfirmMaintenanceRequest:
      type: object
      properties:
        organization_id:
          type:
          - integer
          - 'null'
          description: The ID of the organization
      required:
      - organization_id
    postApiV4OrganizationsRequest:
      type: object
      properties:
        name:
          type:
          - string
          - 'null'
          description: The name of the organization
        path:
          type:
          - string
          - 'null'
          description: The path of the organization
        description:
          type:
          - string
          - 'null'
          description: The description of the organization
        visibility:
          type:
          - string
          - 'null'
          enum:
          - private
          - public
          - null
          description: The visibility level of the organization
        avatar:
          type:
          - string
          - 'null'
          format: binary
          description: The avatar image for the organization
      required:
      - name
      - path
    APIEntitiesOrganizationsOrganization:
      type: object
      properties:
        id:
          type: integer
          format: int64
          example: 1
        uuid:
          type: string
          example: 0192f8c2-1a2b-7cde-89ab-0123456789ab
        name:
          type: string
          example: GitLab
        path:
          type: string
          example: gitlab
        description:
          type: string
          example: My description
        visibility:
          type: string
          example: public
        created_at:
          type: string
          format: date-time
          example: '2022-02-24T20:22:30.097Z'
        updated_at:
          type: string
          format: date-time
          example: '2022-02-24T20:22:30.097Z'
        web_url:
          type: string
          example: https://example.com/o/gitlab/-/overview
        avatar_url:
          type: string
          example: https://example.com/uploads/-/system/organizations/organization_detail/avatar/1/avatar.png
    postApiV4InternalOrgMoverStartMaintenanceRequest:
      type: object
      properties:
        organization_id:
          type:
          - integer
          - 'null'
          description: The ID of the organization
        maintenance_reason:
          type: string
          enum:
          - migration
          - isolation
          - incident
          - billing
          - legal
          description: The reason for entering maintenance
          minLength: 1
      required:
      - organization_id
      - maintenance_reason
  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