> ## 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 User Roles

> List the project's user roles. A role's id is what `user.userRoleId` takes on `POST /v1/api/projects/embed-token`; a role grants dashboard editing permissions.



## OpenAPI

````yaml get /v1/api/projects/{projectId}/user-roles
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}/user-roles:
    get:
      summary: List the project's user roles. A role's id is wha…
      description: >-
        List the project's user roles. A role's id is what `user.userRoleId`
        takes on `POST /v1/api/projects/embed-token`; a role grants dashboard
        editing permissions.
      operationId: GetV1ApiProjectsProjectIdUserRoles
      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: The project whose user roles to list.
          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})$
            description: The project whose user roles to list.
      responses:
        '200':
          description: GET /v1/api/projects/:projectId/user-roles Positive response
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    const: success
                  data:
                    type: object
                    properties:
                      userRoles:
                        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})$
                            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})$
                            permissions:
                              type: object
                              properties:
                                addChart:
                                  type: boolean
                                addFilter:
                                  type: boolean
                                createChart:
                                  type: boolean
                                createChartSQL:
                                  type: boolean
                                editCharts:
                                  type: boolean
                                removeChart:
                                  type: boolean
                                disableTabs:
                                  type: boolean
                                hideHeader:
                                  type: boolean
                                hideDownloadButton:
                                  type: boolean
                                aiCharts:
                                  type: boolean
                                editMarketplace:
                                  type: boolean
                                readOnly:
                                  type: boolean
                                aiInsight:
                                  type: boolean
                                drillDown:
                                  type: boolean
                                enableScheduleReport:
                                  type: boolean
                                canDuplicateDashboard:
                                  type: boolean
                                canSetDefaultDashboard:
                                  type: boolean
                                canEditChartFromSession:
                                  type: boolean
                                hideFilters:
                                  type: boolean
                                addDashboard:
                                  type: boolean
                              additionalProperties: false
                            created_at: {}
                            updated_at: {}
                          required:
                            - id
                            - name
                            - organization_id
                            - project_id
                            - permissions
                            - created_at
                            - updated_at
                          additionalProperties: false
                    required:
                      - userRoles
                    additionalProperties: false
                required:
                  - status
                  - data
                additionalProperties: false
        '400':
          description: GET /v1/api/projects/:projectId/user-roles 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_3: []
components:
  securitySchemes:
    APIKEY_3:
      type: apiKey
      in: query
      name: apiKey

````

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