Label Studio subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk API

openapi: 3.1.0
info:
  title: API Reference subpackage_actions subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk API
  version: 1.0.0
servers:
- url: http://localhost:8000
tags:
- name: subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk
paths:
  /api/workspaces/{id}/memberships/bulk/:
    post:
      operationId: post
      summary: ✨ Bulk assign workspace members
      description: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nAssign workspace members in bulk."
      tags:
      - subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaces_members_bulk_post_Response_200'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkspaceMemberBulkAssignRequest'
    delete:
      operationId: delete
      summary: ✨ Bulk unassign workspace members
      description: "<Card href=\"https://humansignal.com/goenterprise\">\n        <img style=\"pointer-events: none; margin-left: 0px; margin-right: 0px;\" src=\"https://docs.humansignal.com/images/badge.svg\" alt=\"Label Studio Enterprise badge\"/>\n        <p style=\"margin-top: 10px; font-size: 14px;\">\n            This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise)\n        </p>\n    </Card>\nUnassign workspace members in bulk. Pass selector fields via query parameters (`all`, `included`, `excluded`) and optional paginated-list filters (`search`, `ids`). For backward compatibility, a JSON body with bulk fields is still accepted."
      tags:
      - subpackage_workspaces.subpackage_workspaces/members.subpackage_workspaces/members/bulk
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
      - name: all
        in: query
        description: Apply unassignment to all currently matched workspace members.
        required: false
        schema:
          type: boolean
      - name: excluded
        in: query
        description: Comma-separated list of user IDs to keep assigned when `all=true`.
        required: false
        schema:
          type: string
      - name: ids
        in: query
        description: Comma-separated list of user IDs to filter matched members.
        required: false
        schema:
          type: string
      - name: included
        in: query
        description: Comma-separated list of user IDs to unassign when `all=false`.
        required: false
        schema:
          type: string
      - name: search
        in: query
        description: Search term for filtering matched members by name or email.
        required: false
        schema:
          type: string
      - name: Authorization
        in: header
        description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workspaces_members_bulk_delete_Response_200'
components:
  schemas:
    workspaces_members_bulk_delete_Response_200:
      type: object
      properties:
        unassignments:
          type: integer
      title: workspaces_members_bulk_delete_Response_200
    workspaces_members_bulk_post_Response_200:
      type: object
      properties:
        assignments:
          type: integer
      title: workspaces_members_bulk_post_Response_200
    WorkspaceMemberBulkAssignRequest:
      type: object
      properties:
        all:
          type: boolean
          description: Apply to all workspace members
        excluded:
          type: array
          items:
            type: integer
          description: Excluded user IDs
        included:
          type: array
          items:
            type: integer
          description: Included user IDs
      required:
      - all
      title: WorkspaceMemberBulkAssignRequest
  securitySchemes:
    Token:
      type: apiKey
      in: header
      name: Authorization
      description: 'The token (or API key) must be passed as a request header. You can find your user token on the User Account page in Label Studio. Example: <br><pre><code class="language-bash">curl https://label-studio-host/api/projects -H "Authorization: Token [your-token]"</code></pre>'