> ## 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.

# List employees in a group

> Lists non-archived employees in a group that you can read, whether or not they have workspace access. Access to this list comes from the group; individual employee profile visibility does not further limit it. Supports employee-name search. Pages start at 1; pageSize defaults to 50 and is limited to 100. Request include.total for the matching count. Continue while pagination.hasMore is true. The default name order is last name, first name, then employee ID. Other sorts use the selected field, then employee ID. Missing, archived, or inaccessible groups return 404.



## OpenAPI

````yaml https://api.gowindmill.com/api/v2/openapi.json get /c/{companyId}/groups/{groupId}/members
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/{groupId}/members:
    get:
      tags:
        - Groups
      summary: List employees in a group
      description: >-
        Lists non-archived employees in a group that you can read, whether or
        not they have workspace access. Access to this list comes from the
        group; individual employee profile visibility does not further limit it.
        Supports employee-name search. Pages start at 1; pageSize defaults to 50
        and is limited to 100. Request include.total for the matching count.
        Continue while pagination.hasMore is true. The default name order is
        last name, first name, then employee ID. Other sorts use the selected
        field, then employee ID. Missing, archived, or inaccessible groups
        return 404.
      operationId: groups.members.list
      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
        - schema:
            type: string
            description: Opaque employee group identifier in this company.
            title: Employee group ID
            example: group-engineering
          required: true
          description: Opaque employee group identifier in this company.
          name: groupId
          in: path
        - schema:
            type: string
            description: >-
              Employee-name search using the same matching as the group member
              list.
            title: Search text
            example: Avery
          required: false
          description: >-
            Employee-name search using the same matching as the group member
            list.
          name: query
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 90071992547409
            default: 1
            description: One-based page number. Defaults to 1.
            title: Page number
            example: 1
          required: false
          description: One-based page number. Defaults to 1.
          name: page
          in: query
        - schema:
            type: integer
            minimum: 1
            maximum: 100
            default: 50
            description: Maximum results per page, from 1 to 100. Defaults to 50.
            title: Page size
            example: 50
          required: false
          description: Maximum results per page, from 1 to 100. Defaults to 50.
          name: pageSize
          in: query
        - schema:
            type: object
            properties:
              total:
                type: boolean
                description: >-
                  Set true to count all matching items and include
                  pagination.total. False or omission skips the count.
                title: Include total count
                example: true
            description: >-
              Request total:true to include pagination.total; otherwise no count
              is performed.
            title: Additional response details
            example:
              total: true
          required: false
          description: >-
            Request total:true to include pagination.total; otherwise no count
            is performed.
          style: deepObject
          explode: true
          name: include
          in: query
        - schema:
            $ref: '#/components/schemas/EmployeeGroupMemberSortProperty'
          required: false
          description: >-
            Field used to order results. Supported values depend on this
            listing. Defaults to name.
          name: sortProperty
          in: query
        - schema:
            type: string
            enum:
              - asc
              - desc
            default: asc
            description: Ascending or descending order. Defaults to asc.
            title: Sort direction
            example: asc
          required: false
          description: Ascending or descending order. Defaults to asc.
          name: sortDirection
          in: query
      responses:
        '200':
          description: List group members.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListEmployeeGroupMembersResponse'
        '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:
    EmployeeGroupMemberSortProperty:
      type: string
      enum:
        - name
        - email
        - jobTitle
        - id
      default: name
      title: Sort field
      description: >-
        Field used to order results. Supported values depend on this listing.
        Defaults to name.
      example: name
    ListEmployeeGroupMembersResponse:
      type: object
      properties:
        members:
          type: array
          items:
            $ref: '#/components/schemas/EmployeeGroupMember'
          description: >-
            Matching non-archived employees in the group. They need not have
            workspace membership.
          title: Employees
          example:
            - id: employee-avery
              firstName: Avery
              lastName: Chen
              displayFullName: Avery Chen
              avatarUrl: null
              primaryEmail: avery@example.test
              jobTitle: Engineer
        pagination:
          $ref: '#/components/schemas/EmployeeGroupPagination'
      required:
        - members
        - pagination
      title: Group members response
      description: Current non-archived roster page and optional matching count.
      example:
        members:
          - id: employee-avery
            firstName: Avery
            lastName: Chen
            displayFullName: Avery Chen
            avatarUrl: null
            primaryEmail: avery@example.test
            jobTitle: Engineer
        pagination:
          page: 1
          pageSize: 50
          hasMore: false
          total: 1
    EmployeeGroupMember:
      type: object
      properties:
        id:
          type: string
          description: Opaque employee identifier in this company.
          title: Employee ID
          example: employee-avery
        firstName:
          type:
            - string
            - 'null'
          description: Recorded employee first name, or null when unavailable.
          title: First name
          example: Avery
        lastName:
          type:
            - string
            - 'null'
          description: Recorded employee last name, or null when unavailable.
          title: Last name
          example: Chen
        displayFullName:
          type:
            - string
            - 'null'
          description: Recorded employee display name, or null when unavailable.
          title: Display name
          example: Avery Chen
        avatarUrl:
          type:
            - string
            - 'null'
          description: Avatar URL, or null when no avatar is available.
          title: Avatar URL
          example: null
        primaryEmail:
          type:
            - string
            - 'null'
          description: Primary employee email, or null when unavailable.
          title: Primary email
          example: avery@example.test
        jobTitle:
          type:
            - string
            - 'null'
          description: Recorded employee job title, or null when unavailable.
          title: Job title
          example: Engineer
      required:
        - id
        - firstName
        - lastName
        - displayFullName
        - avatarUrl
        - primaryEmail
        - jobTitle
      title: Group employee
      description: An org-chart employee, independent of workspace membership.
      example:
        id: employee-avery
        firstName: Avery
        lastName: Chen
        displayFullName: Avery Chen
        avatarUrl: null
        primaryEmail: avery@example.test
        jobTitle: Engineer
    EmployeeGroupPagination:
      type: object
      properties:
        page:
          type: integer
          minimum: 1
          default: 1
          description: One-based page number. Defaults to 1.
          title: Page number
          example: 1
        pageSize:
          type: integer
          minimum: 1
          maximum: 100
          default: 50
          description: Maximum results per page, from 1 to 100. Defaults to 50.
          title: Page size
          example: 50
        hasMore:
          type: boolean
          description: Whether there are more matching results after this page.
          title: Has another page
          example: false
        total:
          type: integer
          minimum: 0
          description: >-
            Total matching items, independent of pagination. The route
            determines the item type.
          title: Total matches
          example: 1
      required:
        - page
        - pageSize
        - hasMore
      title: Group pagination
      example:
        page: 1
        pageSize: 50
        hasMore: false
        total: 1
      description: Page position and optional total count.
  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.