---
title: "Get all entitlements for an organization"
url: "https://nov18-dev.movespot.fyi/apis/konnect-entitlements-internal-1/versions/c0909a65-f006-4b8b-acde-baa60d7b0faf/operations/get-entitlements-v1"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/konnect-entitlements-internal-1/versions/c0909a65-f006-4b8b-acde-baa60d7b0faf.md

# Get all entitlements for an organization

`GET` `/entitlements`

Operation ID: `get-entitlements-v1`

Get all entitlements for an organization

## Responses

- `200` - A list of entitlements for the organization
- `401` - Unauthorized
- `403` - Forbidden

## OpenAPI definition

```yaml
openapi: 3.0.3
info:
  title: Konnect Entitlements
  version: 1.0.1
servers:
  - url: https://global.api.konghq.com/v1
    description: Global Base URL
paths:
  /entitlements:
    get:
      operationId: get-entitlements-v1
      summary: Get all entitlements for an organization
      description: Get all entitlements for an organization
      responses:
        "200":
          $ref: "#/components/responses/EntitlementsResponse"
        "401":
          $ref: "#/components/responses/Unauthorized"
        "403":
          $ref: "#/components/responses/Forbidden"
      tags:
        - Entitlements
security:
  - konnectAccessToken: []
components:
  responses:
    EntitlementsResponse:
      description: A list of entitlements for the organization
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/OrganizationEntitlements"
          examples:
            DefaultEntitlements:
              $ref: "#/components/examples/DefaultEntitlements"
    Unauthorized:
      description: Unauthorized
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/UnauthorizedError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/UnauthorizedExample"
    Forbidden:
      description: Forbidden
      content:
        application/problem+json:
          schema:
            $ref: "#/components/schemas/ForbiddenError"
          examples:
            UnauthorizedExample:
              $ref: "#/components/examples/ForbiddenExample"
  schemas:
    OrganizationEntitlements:
      type: object
      properties:
        default_regions:
          description: List of required regions
          type: array
          items:
            $ref: "#/components/schemas/DefaultRegion"
          readOnly: true
          uniqueItems: true
        opted_in_regions:
          $ref: "#/components/schemas/OptedInRegions"
        features:
          $ref: "#/components/schemas/FeaturesResponse"
      required:
        - default_regions
        - opted_in_regions
        - features
    UnauthorizedError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 401
            title:
              example: Unauthorized
            type:
              example: https://httpstatuses.com/401
            instance:
              example: kong:trace:1234567890
            detail:
              example: Invalid credentials
    ForbiddenError:
      allOf:
        - $ref: "#/components/schemas/BaseError"
        - type: object
          properties:
            status:
              example: 403
            title:
              example: Forbidden
            type:
              example: https://httpstatuses.com/403
            instance:
              example: kong:trace:1234567890
            detail:
              example: Forbidden
    DefaultRegion:
      description: A region that is always enabled
      type: string
      enum:
        - us
        - eu
        - au
        - me
        - in
    OptedInRegions:
      description: List of optional regions
      type: array
      items:
        $ref: "#/components/schemas/OptInRegion"
      minItems: 1
      uniqueItems: true
    FeaturesResponse:
      description: Map of feature names to their settings
      type: object
      properties:
        ai:
          $ref: "#/components/schemas/FeatureSettingsResponse"
        mcp:
          $ref: "#/components/schemas/MCPFeatureSettingsResponse"
    BaseError:
      description: standard error
      type: object
      properties:
        status:
          description: >
            The HTTP status code of the error. Useful when passing the response

            body to child properties in a frontend UI. Must be returned as an
            integer.
          type: integer
          readOnly: true
        title:
          description: |
            A short, human-readable summary of the problem. It should not
            change between occurences of a problem, except for localization.
            Should be provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
        type:
          description: The error type.
          type: string
          readOnly: true
        instance:
          description: |
            Used to return the correlation ID back to the user, in the format
            kong:trace:<correlation_id>. This helps us find the relevant logs
            when a customer reports an issue.
          type: string
          readOnly: true
        detail:
          description: >
            A human readable explanation specific to this occurence of the
            problem.

            This field may contain request/entity data to help the user
            understand

            what went wrong. Enclose variable values in square brackets. Should
            be

            provided as "Sentence case" for direct use in the UI.
          type: string
          readOnly: true
      required:
        - status
        - title
        - instance
        - detail
      title: Error
    OptInRegion:
      description: A region that can be optionally enabled
      type: string
      enum:
        - sg
    FeatureSettingsResponse:
      type: object
      properties:
        editable:
          $ref: "#/components/schemas/FeatureToggleResponse"
        enabled:
          $ref: "#/components/schemas/FeatureToggleResponse"
      required:
        - enabled
    MCPFeatureSettingsResponse:
      type: object
      properties:
        enabled:
          $ref: "#/components/schemas/FeatureToggleResponse"
    FeatureToggleResponse:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        value:
          type: boolean
      required:
        - name
        - description
        - value
  examples:
    DefaultEntitlements:
      summary: Default entitlements for an organization
      value:
        default_regions:
          - us
          - eu
          - au
          - me
          - in
        opted_in_regions:
          - sg
        features:
          ai:
            editable:
              name: editable
              description: makes the field available to the end user
              value: false
            enabled:
              name: enabled
              description: enables or disables the AI feature
              value: false
          mcp:
            enabled:
              name: enabled
              description: enables or disables the MCP feature
              value: false
    UnauthorizedExample:
      value:
        status: 401
        title: Unauthorized
        instance: kong:trace:8347343766220159418
        detail: Unauthorized
    ForbiddenExample:
      value:
        status: 403
        title: Forbidden
        instance: kong:trace:2723154947768991354
        detail: You do not have permission to perform this action
  securitySchemes:
    konnectAccessToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        The Konnect access token is meant to be used by the Konnect dashboard
        and the decK CLI authenticate with.
```
