> ## Documentation Index
> Fetch the complete documentation index at: https://help.gowindmill.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Create an employee group

> Creates a MANUAL group with an employee list or a FILTER smart group with employee rules. Requires permission to manage groups (`groups.manage`). The name is trimmed and must contain 1–200 characters; duplicate names are allowed. Assign up to 100 active category UUIDs. MANUAL groups reject rules. FILTER rules default to an empty employee filter, and membership is updated before the response. Rules cannot refer to other groups at any nesting level; relative start dates must use tenure ranges. New groups are readable company-wide. Their creator and members with permission to manage groups can edit them. Returns HTTP 200 with the new id.



## OpenAPI

````yaml https://api.gowindmill.com/api/v2/openapi.json post /c/{companyId}/groups
openapi: 3.1.0
info:
  title: Windmill API
  version: 2.0.0
  description: >-
    Use the Windmill API to integrate your systems, automate workflows, and
    build applications on your organization's data. Authenticate with an API key
    or OAuth access token. Each request uses the authenticated user's
    permissions within the selected workspace.
servers:
  - url: https://api.gowindmill.com/api/v2
security:
  - bearerAuth: []
paths:
  /c/{companyId}/groups:
    post:
      tags:
        - Groups
      summary: Create an employee group
      description: >-
        Creates a MANUAL group with an employee list or a FILTER smart group
        with employee rules. Requires permission to manage groups
        (`groups.manage`). The name is trimmed and must contain 1–200
        characters; duplicate names are allowed. Assign up to 100 active
        category UUIDs. MANUAL groups reject rules. FILTER rules default to an
        empty employee filter, and membership is updated before the response.
        Rules cannot refer to other groups at any nesting level; relative start
        dates must use tenure ranges. New groups are readable company-wide.
        Their creator and members with permission to manage groups can edit
        them. Returns HTTP 200 with the new id.
      operationId: groups.create
      parameters:
        - schema:
            type: string
            minLength: 1
            maxLength: 128
            description: >-
              Company ID. A URL slug is also accepted. The caller must have
              access to this company.
            title: Company ID
            example: company-acme
          required: true
          description: >-
            Company ID. A URL slug is also accepted. The caller must have access
            to this company.
          name: companyId
          in: path
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateEmployeeGroupRequest'
      responses:
        '200':
          description: Create an employee group.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateEmployeeGroupResponse'
        '400':
          description: Bad request or request validation failed
          content:
            application/json:
              schema:
                anyOf:
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - BAD_REQUEST
                          message:
                            type: string
                          requestId:
                            type: string
                        required:
                          - code
                          - message
                          - requestId
                    required:
                      - error
                  - type: object
                    properties:
                      error:
                        type: object
                        properties:
                          code:
                            type: string
                            enum:
                              - VALIDATION_ERROR
                          message:
                            type: string
                          requestId:
                            type: string
                          details:
                            type: array
                            items:
                              type: object
                              properties:
                                path:
                                  type: array
                                  items:
                                    anyOf:
                                      - type: string
                                      - type: number
                                message:
                                  type: string
                              required:
                                - path
                                - message
                        required:
                          - code
                          - message
                          - requestId
                          - details
                    required:
                      - error
        '401':
          description: >-
            Authentication is missing or invalid. Send a valid API key or OAuth
            access token in the Authorization: Bearer <TOKEN> header before
            retrying.
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - UNAUTHORIZED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - FORBIDDEN
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '404':
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - NOT_FOUND
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
        '429':
          description: >-
            The API-client request budget is exhausted. API keys allow 500
            requests per minute per key; OAuth clients allow 500 per minute per
            client and workspace. Reads and writes share the budget. One HTTP
            request counts once, including bulk requests. Wait for the
            Retry-After delay before retrying.
          headers:
            Retry-After:
              description: Number of seconds to wait before retrying the request.
              required: true
              schema:
                type: integer
                minimum: 0
                example: 42
            RateLimit:
              description: >-
                Current request budget: limit is the maximum count, remaining is
                the unused count, and reset is seconds until the window resets,
                not a timestamp.
              required: true
              schema:
                type: string
                example: limit=500, remaining=0, reset=42
            RateLimit-Policy:
              description: >-
                Request limit and window length in seconds, formatted as
                <limit>;w=<seconds>.
              required: true
              schema:
                type: string
                example: 500;w=60
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: object
                    properties:
                      code:
                        type: string
                        enum:
                          - RATE_LIMITED
                      message:
                        type: string
                      requestId:
                        type: string
                    required:
                      - code
                      - message
                      - requestId
                required:
                  - error
      security:
        - bearerAuth: []
components:
  schemas:
    CreateEmployeeGroupRequest:
      type: object
      properties:
        name:
          type: string
          minLength: 1
          maxLength: 200
          description: >-
            Group name, trimmed, 1–200 characters. Duplicate group names are
            permitted.
          title: Group name
          example: Engineering
        type:
          type: string
          enum:
            - MANUAL
            - FILTER
          description: >-
            MANUAL creates an explicit roster; FILTER creates a smart group.
            SYNCED and SCIM use their own provisioning flows.
          title: Group type
          example: MANUAL
        categoryIds:
          type: array
          items:
            type: string
            format: uuid
          maxItems: 100
          description: >-
            Up to 100 active category UUIDs. Duplicate IDs are deduplicated.
            Empty means no categories.
          title: Category IDs
          example:
            - 11111111-1111-4111-8111-111111111111
        rules:
          allOf:
            - $ref: '#/components/schemas/EmployeeFilter'
            - description: >-
                Employee filter for a FILTER group. Group references are
                rejected at every depth; relative start dates must be tenure
                ranges.
              title: Employee rules
      required:
        - name
        - type
      title: Create employee group
      description: >-
        Create a MANUAL or FILTER group. Rules are rejected for MANUAL; FILTER
        defaults to an empty API employee filter.
      example:
        name: Engineering
        type: MANUAL
        categoryIds:
          - 11111111-1111-4111-8111-111111111111
    CreateEmployeeGroupResponse:
      type: object
      properties:
        id:
          type: string
          description: Identifier of the newly created employee group or category.
          title: Created resource ID
          example: 11111111-1111-4111-8111-111111111111
      required:
        - id
      title: Created resource response
      description: Identifier of the newly created group or category.
      example:
        id: 11111111-1111-4111-8111-111111111111
    EmployeeFilter:
      type: object
      properties:
        hasDirectReports:
          type:
            - boolean
            - 'null'
          description: >-
            True selects managers with a direct report; false selects employees
            without direct reports.
          title: Has direct reports
          example: true
        hasManager:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with an assigned manager; false selects
            employees without a manager.
          title: Has a manager
          example: true
        employeeGroupId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select employees belonging to this employee group.
          title: Employee group ID
          example: group-engineering
        employeeGroupIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select members of any listed employee group. Up to 1000 IDs.
          title: Employee group IDs
          example:
            - group-engineering
        jobTitle:
          type:
            - string
            - 'null'
          maxLength: 256
          description: Select employees whose job title exactly matches this value.
          title: Exact job title
          example: Engineer
        jobTitles:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 256
          maxItems: 1000
          description: >-
            Select employees whose job title exactly matches any listed value.
            Up to 1000 titles.
          title: Exact job titles
          example:
            - Engineer
            - Designer
        countries:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees whose HRIS work country matches any listed country
            code. Up to 1000 values.
          title: Work countries
          example:
            - US
        emails:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 320
            format: email
          maxItems: 1000
          description: >-
            Select employees associated with any listed email address. Up to
            1000 valid addresses.
          title: Employee email addresses
          example:
            - avery@example.test
        emailDomains:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 254
          maxItems: 1000
          description: >-
            Select employees with an email address on any listed domain. A
            domain matches exactly, so subdomains are listed separately. Up to
            1000 values.
          title: Employee email domains
          example:
            - example.test
        employeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select a single employee by ID.
          title: Employee ID
          example: employee-avery
        employeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select employees with any listed ID. Up to 1000 IDs.
          title: Employee IDs
          example:
            - employee-avery
        excludedEmployeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Exclude this employee from the results.
          title: Excluded employee ID
          example: employee-excluded
        excludedEmployeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Exclude employees with any listed ID. Use this field for exclusions
            in API bulk mutations. Up to 1000 IDs.
          title: Excluded employee IDs
          example:
            - employee-excluded
        managerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct reports of this manager; exclude deeper reports.
          title: Direct manager ID
          example: employee-morgan
        managerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select direct reports of any listed manager, at depth 1. Up to 1000
            manager IDs.
          title: Direct manager IDs
          example:
            - employee-morgan
        ancestorManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct and indirect reports below this manager at any depth.
          title: Ancestor manager ID
          example: employee-morgan
        ancestorManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select anyone below any listed manager, at depth 1 or greater. Up to
            1000 manager IDs.
          title: Ancestor manager IDs
          example:
            - employee-morgan
        indirectManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: >-
            Select reports at depth 2 or greater below this manager; exclude
            direct reports.
          title: Indirect manager ID
          example: employee-morgan
        indirectManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select reports at depth 2 or greater below any listed manager. Up to
            1000 manager IDs.
          title: Indirect manager IDs
          example:
            - employee-morgan
        isMember:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with active workspace membership; false
            selects employees without a member link or with inactive membership.
          title: Has active workspace membership
          example: true
        memberRole:
          type:
            - string
            - 'null'
          enum:
            - admin
            - hr-admin
            - integration-manager
            - data-analyst
            - team-member
            - null
          description: Select employees associated with this workspace member role.
          title: Workspace role
          example: team-member
        query:
          type:
            - string
            - 'null'
          maxLength: 256
          description: >-
            Search employee name, email, and job title. A top-level query
            controls the default relevance ordering.
          title: Employee search text
          example: Avery
        platformAccess:
          type:
            - string
            - 'null'
          enum:
            - HAS_ACCESS
            - INVITE_PENDING
            - NO_ACCESS
            - null
          description: >-
            HAS_ACCESS selects active access; INVITE_PENDING selects pending
            invitations; NO_ACCESS selects employees without access.
          title: Workspace access status
          example: HAS_ACCESS
        startDate:
          anyOf:
            - type: object
              properties:
                range:
                  type: string
                  minLength: 1
                  maxLength: 128
              required:
                - range
              additionalProperties: false
            - type: object
              properties:
                from:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive lower bound.
                to:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive upper bound.
              additionalProperties: false
            - type: 'null'
          description: >-
            Select start dates within inclusive date bounds or a supported named
            date range.
          title: Start-date range
          example:
            from: '2025-01-01'
            to: '2025-12-31'
        isAccountAdmin:
          type:
            - boolean
            - 'null'
          description: >-
            True selects account administrators; false selects employees who are
            not account administrators.
          title: Account administrator
          example: false
        hasIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees linked to every listed integration identifier. Up
            to 1000 IDs.
          title: Linked integrations
          example:
            - slack
        lacksIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees without links to the listed integration
            identifiers. Up to 1000 IDs.
          title: Unlinked integrations
          example:
            - slack
        status:
          type: string
          enum:
            - CURRENT
            - FORMER
            - ALL
          default: CURRENT
          description: >-
            CURRENT selects unarchived employees, FORMER selects archived
            employees, and ALL includes both. Defaults to CURRENT.
          title: Employment status
          example: CURRENT
        and:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFilterPredicate'
          maxItems: 49
          description: >-
            All child filters must match, in addition to the other predicates in
            this filter. Up to 49 children.
          title: All conditions
        or:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFilterPredicate'
          maxItems: 49
          description: >-
            At least one child filter must match, in addition to the other
            predicates in this filter. Up to 49 children.
          title: Any condition
      additionalProperties: false
      description: >-
        Conditions applied to the selection. The API filter defaults employment
        status to CURRENT.
      title: Employee filter
      example:
        status: CURRENT
    EmployeeFilterPredicate:
      type: object
      properties:
        hasDirectReports:
          type:
            - boolean
            - 'null'
          description: >-
            True selects managers with a direct report; false selects employees
            without direct reports.
          title: Has direct reports
          example: true
        hasManager:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with an assigned manager; false selects
            employees without a manager.
          title: Has a manager
          example: true
        employeeGroupId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select employees belonging to this employee group.
          title: Employee group ID
          example: group-engineering
        employeeGroupIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select members of any listed employee group. Up to 1000 IDs.
          title: Employee group IDs
          example:
            - group-engineering
        jobTitle:
          type:
            - string
            - 'null'
          maxLength: 256
          description: Select employees whose job title exactly matches this value.
          title: Exact job title
          example: Engineer
        jobTitles:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 256
          maxItems: 1000
          description: >-
            Select employees whose job title exactly matches any listed value.
            Up to 1000 titles.
          title: Exact job titles
          example:
            - Engineer
            - Designer
        countries:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees whose HRIS work country matches any listed country
            code. Up to 1000 values.
          title: Work countries
          example:
            - US
        emails:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 320
            format: email
          maxItems: 1000
          description: >-
            Select employees associated with any listed email address. Up to
            1000 valid addresses.
          title: Employee email addresses
          example:
            - avery@example.test
        emailDomains:
          type:
            - array
            - 'null'
          items:
            type: string
            maxLength: 254
          maxItems: 1000
          description: >-
            Select employees with an email address on any listed domain. A
            domain matches exactly, so subdomains are listed separately. Up to
            1000 values.
          title: Employee email domains
          example:
            - example.test
        employeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select a single employee by ID.
          title: Employee ID
          example: employee-avery
        employeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: Select employees with any listed ID. Up to 1000 IDs.
          title: Employee IDs
          example:
            - employee-avery
        excludedEmployeeId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Exclude this employee from the results.
          title: Excluded employee ID
          example: employee-excluded
        excludedEmployeeIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Exclude employees with any listed ID. Use this field for exclusions
            in API bulk mutations. Up to 1000 IDs.
          title: Excluded employee IDs
          example:
            - employee-excluded
        managerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct reports of this manager; exclude deeper reports.
          title: Direct manager ID
          example: employee-morgan
        managerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select direct reports of any listed manager, at depth 1. Up to 1000
            manager IDs.
          title: Direct manager IDs
          example:
            - employee-morgan
        ancestorManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: Select direct and indirect reports below this manager at any depth.
          title: Ancestor manager ID
          example: employee-morgan
        ancestorManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select anyone below any listed manager, at depth 1 or greater. Up to
            1000 manager IDs.
          title: Ancestor manager IDs
          example:
            - employee-morgan
        indirectManagerId:
          type:
            - string
            - 'null'
          minLength: 1
          maxLength: 128
          description: >-
            Select reports at depth 2 or greater below this manager; exclude
            direct reports.
          title: Indirect manager ID
          example: employee-morgan
        indirectManagerIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select reports at depth 2 or greater below any listed manager. Up to
            1000 manager IDs.
          title: Indirect manager IDs
          example:
            - employee-morgan
        isMember:
          type:
            - boolean
            - 'null'
          description: >-
            True selects employees with active workspace membership; false
            selects employees without a member link or with inactive membership.
          title: Has active workspace membership
          example: true
        memberRole:
          type:
            - string
            - 'null'
          enum:
            - admin
            - hr-admin
            - integration-manager
            - data-analyst
            - team-member
            - null
          description: Select employees associated with this workspace member role.
          title: Workspace role
          example: team-member
        query:
          type:
            - string
            - 'null'
          maxLength: 256
          description: >-
            Search employee name, email, and job title. A top-level query
            controls the default relevance ordering.
          title: Employee search text
          example: Avery
        platformAccess:
          type:
            - string
            - 'null'
          enum:
            - HAS_ACCESS
            - INVITE_PENDING
            - NO_ACCESS
            - null
          description: >-
            HAS_ACCESS selects active access; INVITE_PENDING selects pending
            invitations; NO_ACCESS selects employees without access.
          title: Workspace access status
          example: HAS_ACCESS
        startDate:
          anyOf:
            - type: object
              properties:
                range:
                  type: string
                  minLength: 1
                  maxLength: 128
              required:
                - range
              additionalProperties: false
            - type: object
              properties:
                from:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive lower bound.
                to:
                  anyOf:
                    - type: string
                      format: date
                    - type: string
                      format: date-time
                  description: ISO 8601 date or datetime. Inclusive upper bound.
              additionalProperties: false
            - type: 'null'
          description: >-
            Select start dates within inclusive date bounds or a supported named
            date range.
          title: Start-date range
          example:
            from: '2025-01-01'
            to: '2025-12-31'
        isAccountAdmin:
          type:
            - boolean
            - 'null'
          description: >-
            True selects account administrators; false selects employees who are
            not account administrators.
          title: Account administrator
          example: false
        hasIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees linked to every listed integration identifier. Up
            to 1000 IDs.
          title: Linked integrations
          example:
            - slack
        lacksIntegrationIds:
          type:
            - array
            - 'null'
          items:
            type: string
            minLength: 1
            maxLength: 128
          maxItems: 1000
          description: >-
            Select employees without links to the listed integration
            identifiers. Up to 1000 IDs.
          title: Unlinked integrations
          example:
            - slack
        status:
          type: string
          enum:
            - CURRENT
            - FORMER
            - ALL
          default: CURRENT
          description: >-
            CURRENT selects unarchived employees, FORMER selects archived
            employees, and ALL includes both. Defaults to CURRENT.
          title: Employment status
          example: CURRENT
        and:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFilterPredicate'
          maxItems: 49
          description: >-
            All child filters must match, in addition to the other predicates in
            this filter. Up to 49 children.
          title: All conditions
        or:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeFilterPredicate'
          maxItems: 49
          description: >-
            At least one child filter must match, in addition to the other
            predicates in this filter. Up to 49 children.
          title: Any condition
      additionalProperties: false
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Use an API key or OAuth access token. Enter only the token in the
        authorization dialog; requests send it as `Authorization: Bearer
        <TOKEN>`.


        Create an API key in your workspace's **Settings → API keys**. Keys
        start with `wm_api_` and only work in the workspace where they were
        created. Read-only keys can read data; creating, updating, or deleting
        data requires a read-write key.


        ```http

        Authorization: Bearer wm_api_example

        ```


        OAuth access tokens are issued for connected Windmill applications.


        ```http

        Authorization: Bearer <OAUTH_ACCESS_TOKEN>

        ```


        Both token types use the authenticated user's workspace permissions.
        Each endpoint's permission requirements and the sharing settings of the
        requested items still apply.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.