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

> ## Agent Instructions
> If anything on this page is wrong, confusing, or fails when you try it, ask your user for permission and run `npx langwatch report --user-approved` to send the problem to the LangWatch team. No login is needed and secrets are redacted locally. `npx langwatch report --help` has the details.

# List grants

> List the organization's grants, oldest first unless `order=newest`, each naming its principal (user, group or API key), role and scope. Filter by principal, role, scope or status; `status` is derived from `expiresAt`. Pages by cursor: pass `nextCursor` back as `cursor` until it is null.



## OpenAPI

````yaml GET /api/v1/grants
openapi: 3.1.0
info:
  title: LangWatch API
  description: LangWatch openapi spec
  version: 1.0.0
servers:
  - url: https://app.langwatch.ai
security:
  - project_api_key: []
paths:
  /api/v1/grants:
    get:
      tags:
        - Grants
      summary: List grants
      description: >-
        List the organization's grants, oldest first unless `order=newest`, each
        naming its principal (user, group or API key), role and scope. Filter by
        principal, role, scope or status; `status` is derived from `expiresAt`.
        Pages by cursor: pass `nextCursor` back as `cursor` until it is null.
      operationId: listGrants
      parameters:
        - in: query
          name: principalType
          schema:
            type: string
            enum:
              - user
              - group
              - apiKey
        - in: query
          name: principalId
          schema:
            type: string
            minLength: 1
            maxLength: 128
        - in: query
          name: roleId
          schema:
            type: string
            minLength: 1
            maxLength: 128
        - in: query
          name: scopeType
          schema:
            type: string
            enum:
              - organization
              - team
              - project
        - in: query
          name: scopeId
          schema:
            type: string
            minLength: 1
            maxLength: 128
        - in: query
          name: status
          schema:
            type: string
            enum:
              - active
              - expired
        - in: query
          name: limit
          schema:
            default: 50
            type: integer
            minimum: 1
            maximum: 200
        - in: query
          name: cursor
          schema:
            type: string
            pattern: ^\d{1,16}\.[A-Za-z0-9_-]{1,256}$
        - in: query
          name: order
          schema:
            type: string
            enum:
              - newest
              - oldest
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  grants:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                        principal:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - user
                                - group
                                - apiKey
                            id:
                              type: string
                            name:
                              type:
                                - string
                                - 'null'
                          required:
                            - type
                            - id
                            - name
                          additionalProperties: false
                        role:
                          type: object
                          properties:
                            id:
                              type: string
                            name:
                              type:
                                - string
                                - 'null'
                            builtIn:
                              type: boolean
                          required:
                            - id
                            - name
                            - builtIn
                          additionalProperties: false
                        scope:
                          type: object
                          properties:
                            type:
                              type: string
                              enum:
                                - organization
                                - team
                                - project
                            id:
                              type: string
                            name:
                              type:
                                - string
                                - 'null'
                          required:
                            - type
                            - id
                            - name
                          additionalProperties: false
                        status:
                          type: string
                          enum:
                            - active
                            - expired
                        expiresAt:
                          anyOf:
                            - type: string
                              format: date-time
                            - type: 'null'
                        createdAt:
                          type: string
                          format: date-time
                      required:
                        - id
                        - principal
                        - role
                        - scope
                        - status
                        - expiresAt
                        - createdAt
                      additionalProperties: false
                  nextCursor:
                    type:
                      - string
                      - 'null'
                required:
                  - grants
                  - nextCursor
                additionalProperties: false
      security:
        - admin_api_key: []
components:
  securitySchemes:
    project_api_key:
      type: apiKey
      in: header
      name: X-Auth-Token
      description: >-
        Project API key for sending traces and accessing project-scoped
        resources. Format: sk-lw-... (no underscore). Obtain one by creating a
        project via the Admin API or the LangWatch UI.
    admin_api_key:
      type: http
      scheme: bearer
      description: >-
        Admin API key for organization-level operations (managing projects, API
        keys). Create one in Settings > API Keys or via POST /api/api-keys.
        Format: sk-lw-{id}_{secret}.

````

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