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

# List users

> Returns users that belong to the organization associated with the authenticated service account.



## OpenAPI

````yaml /openapi/platform-v1.yaml get /api/v1/users
openapi: 3.0.1
info:
  title: CrewAI Platform API
  version: v1
  description: Supported public API for CrewAI Platform.
servers:
  - url: https://app.crewai.com
    description: Current CrewAI Platform host
security:
  - bearerAuth: []
tags:
  - name: Users
    description: Users in the organization.
  - name: Status
    description: Platform health and API availability.
  - name: Automations
    description: Automations and their source artifacts.
  - name: Teams
    description: Teams in the organization.
  - name: Group Mappings
    description: Identity-provider group mappings to Teams.
  - name: Service Accounts
    description: Service accounts in the organization.
  - name: Webhook Endpoints
    description: Endpoints that receive signed event deliveries.
paths:
  /api/v1/users:
    get:
      tags:
        - Users
      summary: List users
      description: >-
        Returns users that belong to the organization associated with the
        authenticated service account.
      operationId: listUsers
      parameters:
        - name: filter
          in: query
          required: false
          description: >-
            Filters results using an expression. Combine comparisons with `AND`,
            `OR`, `NOT`, and parentheses. Supported fields: `id`, `email`.
            Strings, integers, and timestamps support `=`, `!=`, `<`, `<=`, `>`,
            and `>=`; UUIDs and booleans support `=` and `!=`.
          schema:
            type: string
        - name: order_by
          in: query
          required: false
          description: >-
            Orders results by a comma-separated list of fields. Fields sort
            ascending by default; append ` asc` or ` desc` to set a direction.
            Supported fields: `id`, `email`, `name`. Default: `id asc`. Unless
            `id` is explicitly included, `id asc` is appended as a deterministic
            tie-breaker.
          schema:
            type: string
            example: email,name desc
      responses:
        '200':
          description: OK
          content:
            application/json:
              examples:
                success:
                  value:
                    data:
                      - id: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                        email: member@example.com
                        name: Member Example
                        created_at: '2026-07-07T00:00:00Z'
                        updated_at: '2026-07-07T00:00:00Z'
                  summary: Users in the authenticated service account's organization
              schema:
                type: object
                required:
                  - data
                additionalProperties: false
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      required:
                        - id
                        - email
                        - name
                        - created_at
                        - updated_at
                      additionalProperties: false
                      properties:
                        id:
                          type: string
                          format: uuid
                          example: 4f6d0d9a-7b78-4c6a-b64f-2e2e3d2c8f9a
                        email:
                          type: string
                          example: member@example.com
                          format: email
                        name:
                          type: string
                          example: Member Example
                          nullable: true
                        created_at:
                          type: string
                          format: date-time
                          example: '2026-07-07T00:00:00Z'
                        updated_at:
                          type: string
                          format: date-time
                          example: '2026-07-07T00:00:00Z'
        '401':
          description: Unauthorized
          content:
            application/json:
              examples:
                unauthorized:
                  value:
                    errors:
                      - type: >-
                          https://docs-platform.crewai.com/api/problems/unauthorized
                        code: unauthorized
                        title: Unauthorized
                        status: 401
                        detail: Missing or invalid bearer token.
                  summary: Missing or invalid bearer token
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - errors
      additionalProperties: false
      properties:
        errors:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/Error'
    Error:
      type: object
      description: Public API error object.
      required:
        - type
        - code
        - title
        - status
        - detail
      additionalProperties: false
      properties:
        type:
          type: string
          format: uri
          enum:
            - https://docs-platform.crewai.com/api/problems/bad_request
            - https://docs-platform.crewai.com/api/problems/clipper_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_disallowed
            - >-
              https://docs-platform.crewai.com/api/problems/clipper_feature_disabled
            - https://docs-platform.crewai.com/api/problems/clipper_not_found
            - https://docs-platform.crewai.com/api/problems/conflict
            - https://docs-platform.crewai.com/api/problems/forbidden
            - https://docs-platform.crewai.com/api/problems/internal_error
            - https://docs-platform.crewai.com/api/problems/not_found
            - https://docs-platform.crewai.com/api/problems/service_unavailable
            - >-
              https://docs-platform.crewai.com/api/problems/tool_execution_failed
            - https://docs-platform.crewai.com/api/problems/unauthorized
            - https://docs-platform.crewai.com/api/problems/validation_error
          example: https://docs-platform.crewai.com/api/problems/bad_request
        code:
          type: string
          enum:
            - bad_request
            - clipper_disabled
            - clipper_disallowed
            - clipper_feature_disabled
            - clipper_not_found
            - conflict
            - forbidden
            - internal_error
            - not_found
            - service_unavailable
            - tool_execution_failed
            - unauthorized
            - validation_error
          example: bad_request
        title:
          type: string
          x-crewai-enum-format: freeform
          enum:
            - Bad request
            - Clipper resource disabled
            - Clipper resource disallowed
            - Clipper feature disabled
            - Clipper resource not found
            - Conflict
            - Forbidden
            - Internal error
            - Not found
            - Service unavailable
            - Tool execution failed
            - Unauthorized
            - Validation error
          example: Bad request
        status:
          type: integer
          enum:
            - 400
            - 401
            - 403
            - 404
            - 409
            - 422
            - 500
            - 503
          example: 400
        detail:
          type: string
          example: The request is invalid.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: opaque

````

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