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

# List Project Users

> List the project's users



## OpenAPI

````yaml get /v1/api/projects/{projectId}/users
openapi: 3.1.0
info:
  title: Upsolve API
  version: 1.5.0
servers:
  - url: https://api.upsolve.ai
security: []
tags: []
paths:
  /v1/api/projects/{projectId}/users:
    get:
      summary: List the project's users
      description: List the project's users
      operationId: GetV1ApiProjectsProjectIdUsers
      parameters:
        - name: apiKey
          in: query
          required: false
          description: >-
            Upsolve API key, generated under Account → Developer settings in the
            Upsolve Hub. Keys are user-scoped: pass organizationId alongside the
            key to select which org to act on.
          schema:
            type: string
            minLength: 1
            description: >-
              Upsolve API key, generated under Account → Developer settings in
              the Upsolve Hub. Keys are user-scoped: pass organizationId
              alongside the key to select which org to act on.
            examples:
              - up_embed_************
          examples:
            example1:
              value: up_embed_************
        - name: organizationId
          in: query
          required: false
          description: >-
            Your Upsolve organization's UUID — the org that owns the API key and
            project. This is NOT a project organization: do not pass a value
            registered via /projects/register-organization, and do not pass an
            `externalId` (only `projectOrganizationId` accepts those). Omit it
            when using an org-bound API key — the org is read from the key and
            any value sent here is ignored. Required only for user-scoped API
            keys (created under Account → Developer settings) and for the
            Supabase JWT path, where the org is ambiguous and membership is
            verified against it.
          schema:
            description: >-
              Your Upsolve organization's UUID — the org that owns the API key
              and project. This is NOT a project organization: do not pass a
              value registered via /projects/register-organization, and do not
              pass an `externalId` (only `projectOrganizationId` accepts those).
              Omit it when using an org-bound API key — the org is read from the
              key and any value sent here is ignored. Required only for
              user-scoped API keys (created under Account → Developer settings)
              and for the Supabase JWT path, where the org is ambiguous and
              membership is verified against it.
            examples:
              - 123e4567-e89b-12d3-a456-426614174000
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
          examples:
            example1:
              value: 123e4567-e89b-12d3-a456-426614174000
        - name: projectId
          in: path
          required: true
          description: GET /v1/api/projects/:projectId/users Parameter
          schema:
            type: string
            format: uuid
            pattern: >-
              ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
        - name: environment
          in: query
          required: false
          description: Only the users of this environment.
          schema:
            description: Only the users of this environment.
            type: string
      responses:
        '200':
          description: GET /v1/api/projects/:projectId/users Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      users:
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            name:
                              type: string
                            organization_id:
                              type: string
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            properties:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties: {}
                            user_role_id:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            project_id:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            project_organization_id:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            created_at: {}
                            updated_at: {}
                            user_role_name:
                              type:
                                - string
                                - 'null'
                            member_user_id:
                              type:
                                - string
                                - 'null'
                              format: uuid
                              pattern: >-
                                ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$
                            is_managed:
                              type: boolean
                              description: >-
                                True for a shadow project user provisioned for
                                an organization member. Its name, role and
                                identity are fixed; only `properties` and the
                                project organization can be edited, and it
                                cannot be deleted.
                            environment:
                              default: production
                              description: >-
                                The environment this user belongs to:
                                `production` or one the project created, such as
                                `staging`. It decides which workspace versions
                                and databases their queries are served from.
                                Always `production` for a workspace member's own
                                (shadow) user.
                              type: string
                            is_self:
                              type: boolean
                              description: >-
                                True for the project user that represents the
                                caller's own organization membership — the
                                identity the Playground chats as when it is not
                                emulating anyone. Exactly one row can carry it;
                                every other member's shadow row is listed too,
                                with `is_self` false.
                            is_former_member:
                              type: boolean
                              description: >-
                                True for a shadow project user whose member has
                                left the organization. The row is kept so their
                                chat history, favourites and canvases survive;
                                false on every project user that is not a shadow
                                row.
                            has_project_access:
                              type: boolean
                              description: >-
                                Whether a project-user token for this row is
                                honoured: true for a user you created or
                                registered, for a member with a builder role,
                                and for an end-user assigned to this project.
                                False for a former member and for an end-user
                                not assigned to this project; a token minted for
                                either is refused on its first use, so there is
                                no point previewing as them.
                          required:
                            - id
                            - name
                            - organization_id
                            - properties
                            - user_role_id
                            - project_id
                            - project_organization_id
                            - created_at
                            - updated_at
                            - user_role_name
                            - member_user_id
                            - is_managed
                            - environment
                            - is_self
                            - is_former_member
                            - has_project_access
                          additionalProperties: false
                    required:
                      - users
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: GET /v1/api/projects/:projectId/users Negative response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: error
                  error:
                    type: object
                    properties:
                      message:
                        type: string
                      code:
                        type: string
                      details:
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - message
                    additionalProperties: false
                required:
                  - status
                  - error
                additionalProperties: false
      security:
        - APIKEY_2: []
components:
  securitySchemes:
    APIKEY_2:
      type: apiKey
      in: query
      name: apiKey

````

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