> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# List grant contexts

> Experimental: this endpoint is in beta and its contract may change.

List of contexts in which you want to grant scopes to your user. Pass a dimension and its selected value in the `grant_context` field of the [Get required scopes](/reference/api-reference/toolkits/recommendToolkitScopes) request to tailor the scope recommendation.

In the Jira example, `default_grant_context` is `{"scope_family": "classic"}`, so a recommendation with no `grant_context` uses classic scopes. Pass `{"scope_family": "granular"}` to get granular scopes instead.



## OpenAPI

````yaml api-reference/openapi.json GET /api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context
openapi: 3.1.0
info:
  version: 3.1.0
  title: Composio Platform API v3.1
  description: >-
    Composio v3.1 API — all endpoints available under /api/v3.1/. Tool endpoints
    default to the latest tool version.
  contact:
    name: Composio Support
    url: https://composio.dev/support
    email: support@composio.dev
  license:
    name: Proprietary
    url: https://composio.dev/terms
servers:
  - url: https://backend.composio.dev
    description: Composio production API
security:
  - ApiKeyAuth: []
tags:
  - name: Authentication
    description: Authentication related endpoints
    x-group: Authentication
  - name: Auth Configs
    description: Authentication configuration management
    x-group: Auth Configs
  - name: Connected Accounts
    description: Connected account management
    x-group: Connected Accounts
  - name: Logs
    description: Logging and monitoring
    x-group: Logs
  - name: OpenAPI
    description: OpenAPI specification management
    x-group: OpenAPI
  - name: Organization
    description: Organization management
    x-group: Organization
  - name: API Keys
    description: API key management
    x-group: API Keys
  - name: Webhooks
    description: Webhook configuration
    x-group: Webhooks
  - name: Webhook Endpoints
    description: >-
      Per-OAuth-app webhook ingress endpoints. Inbound URLs the provider posts
      to, plus signing secret storage and verification.
    x-group: Webhook Endpoints
  - name: Webhook Subscriptions
    description: >-
      Webhook delivery subscriptions. Outbound URLs Composio posts trigger
      events to, plus signing secret rotation and event-type filters.
    x-group: Webhook Subscriptions
  - name: Team
    description: Team member management
    x-group: Team
  - name: Consumer Skills
    description: Organization-authored Skill management
    x-group: Consumer Skills
  - name: Toolkits
    description: Toolkit and tool management
    x-group: Toolkits
  - name: Tools
    description: Tool execution endpoints
    x-group: Tools
  - name: Triggers
    description: Trigger management and execution
    x-group: Triggers
  - name: Payments
    description: Payment and subscription management
    x-group: Payments
  - name: Billing
    description: Dashboard billing state — usage, subscription, contract (cookie-auth only)
    x-group: Billing
  - name: Compliance
    description: Organization compliance agreements and acceptance state
    x-group: Compliance
  - name: Files
    description: File management
    x-group: Files
  - name: MCP
    description: MCP server management
    x-group: MCP
  - name: MCP Partner
    description: MCP partner management
    x-group: MCP Partner
  - name: Stripe Projects
    description: Stripe Projects provisioning
    x-group: Stripe Projects
  - name: Tool Router
    description: (Labs) Tool router endpoints
    x-group: Sessions (Prev Tool Router)
  - name: Playground
    description: Dashboard playground chat
    x-group: Playground
  - name: Arena
    description: Arena conversations, messages and terms
    x-group: Arena
  - name: Projects
    description: Projects API endpoints.
    x-group: Projects
  - name: Organization Management
    description: Organization Management API endpoints.
    x-group: Organization Management
  - name: Webhook Events
    description: Events delivered by Composio to your registered webhook endpoints
    x-group: Webhook Events
paths:
  /api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context:
    get:
      tags:
        - Toolkits
      summary: List grant contexts
      description: >-
        Experimental: this endpoint is in beta and its contract may change.


        List of contexts in which you want to grant scopes to your user. Pass a
        dimension and its selected value in the `grant_context` field of the
        [Get required
        scopes](/reference/api-reference/toolkits/recommendToolkitScopes)
        request to tailor the scope recommendation.


        In the Jira example, `default_grant_context` is `{"scope_family":
        "classic"}`, so a recommendation with no `grant_context` uses classic
        scopes. Pass `{"scope_family": "granular"}` to get granular scopes
        instead.
      operationId: recommendToolkitScopesGrantContext
      parameters:
        - schema:
            type: string
            minLength: 1
            description: Toolkit to list grant contexts for.
          required: true
          description: Toolkit to list grant contexts for.
          name: toolkit_slug
          in: path
        - schema:
            type: string
            enum:
              - OAUTH2
              - OAUTH1
              - API_KEY
              - BASIC
              - BILLCOM_AUTH
              - BEARER_TOKEN
              - GOOGLE_SERVICE_ACCOUNT
              - NO_AUTH
              - BASIC_WITH_JWT
              - CALCOM_AUTH
              - SERVICE_ACCOUNT
              - SAML
              - DCR_OAUTH
              - CIMD_OAUTH
              - S2S_OAUTH2
            default: OAUTH2
            description: Auth scheme the connection will use. Defaults to OAUTH2.
          required: false
          description: Auth scheme the connection will use. Defaults to OAUTH2.
          name: auth_scheme
          in: query
        - schema:
            type: string
            minLength: 1
            default: latest
            description: >-
              Toolkit version to read the catalog from; defaults to the latest
              published version. Pass a concrete version to pin.
          required: false
          description: >-
            Toolkit version to read the catalog from; defaults to the latest
            published version. Pass a concrete version to pin.
          name: toolkit_version
          in: query
      responses:
        '200':
          description: Successfully discovered the toolkit's grant-context dimensions
          content:
            application/json:
              schema:
                type: object
                properties:
                  auth_scheme:
                    type: string
                    description: >-
                      Auth scheme whose scope catalog the vocabulary was read
                      from.
                  toolkit_version:
                    type: string
                    description: >-
                      Concrete toolkit version the answer was computed from;
                      pass it back as toolkit_version to pin.
                  grant_context_dimensions:
                    type: array
                    items:
                      type: object
                      properties:
                        dimension:
                          type: string
                          description: >-
                            Context in which you could grant scopes to your
                            user.
                        description:
                          type: string
                          description: What this dimension means and when to pass it.
                        values:
                          type: array
                          items:
                            type: string
                          description: Values that this dimension can take.
                      required:
                        - dimension
                        - description
                        - values
                    description: >-
                      Dimensions this toolkit accepts in grant_context under the
                      auth scheme; [] when no scope depends on grant_context.
                  default_grant_context:
                    type: object
                    additionalProperties:
                      type: string
                    description: >-
                      The grant_context assumed when you pass none — pass a
                      dimension and its selected value only to override or
                      extend it.
                required:
                  - auth_scheme
                  - toolkit_version
                  - grant_context_dimensions
                  - default_grant_context
                x-experimental: true
              examples:
                jira:
                  summary: 'Jira: classic or granular scopes'
                  value:
                    auth_scheme: OAUTH2
                    toolkit_version: 20260917_00
                    grant_context_dimensions:
                      - dimension: scope_family
                        description: >-
                          Which Atlassian OAuth scope catalog to draw from:
                          classic scopes cover broad product areas, granular
                          scopes name individual operations. Defaults to
                          classic, matching the scopes our Jira OAuth app
                          requests today.
                        values:
                          - classic
                          - granular
                    default_grant_context:
                      scope_family: classic
        '400':
          description: >-
            Bad request (validation_error: auth_scheme outside the platform enum
            or not defined by the toolkit)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Toolkit or toolkit_version not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        error:
          type: object
          properties:
            message:
              type: string
            code:
              type: number
            slug:
              type: string
            status:
              type: number
            request_id:
              type: string
            suggested_fix:
              type: string
            errors:
              type: array
              items:
                type: string
          required:
            - message
            - code
            - slug
            - status
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your Composio project API key. Create or copy it from the Composio
        dashboard.
      x-default: your-project-api-key

````