---
title: "Get list of all license subscriptions."
method: GET
path: "/api/v1/subscription/license/list"
tags: ["SubscriptionLicense"]
---

# Get list of all license subscriptions.

`GET /api/v1/subscription/license/list`

## Request

- Base URL: `https://api.intheloop.io`
- URL: `https://api.intheloop.io/api/v1/subscription/license/list`
- Auth: API key in header `Authorization`

## Headers

- `Authorization` string
- `X-Impersonate-User` string

## Response `200`

OK

- ListOfResourcesOfSubscriptionLicense: List of resources
  - `resources` SubscriptionLicense[]: List of resources
    - `id` string: Resource id
    - `name` string: Resource name or title
    - `revision` string: Resource revision
    - `clientId` string: Resource client id
    - `$type` string, required
    - `members` ListOfResourcesOfSubscriptionMember: List of resources
      - `resources` SubscriptionMember[]: List of resources
        - `user` ContactBase: Contact base resource
          - `id` string: Resource id
          - `name` string: Resource name or title
          - `revision` string: Resource revision
          - `clientId` string: Resource client id
          - `$type` string, required
          - `tags` ListOfTags: List of tags resource
            - `id` string: Resource id
            - `name` string: Resource name or title
            - `revision` string: Resource revision
            - `clientId` string: Resource client id
            - `$type` string, required
            - `tags` ListOfResourcesOfTag: List of resources
              - …
            - `parent` ResourceBase: Resource base
              - …
          - `weight` number: Usage weight.
          - `created` string, date-time: Date time of contact creation
          - `modified` string, date-time: Date time of last time contact was modified
        - `role` 'Owner' | 'Admin' | 'Member', required: Subscription Role types
        - `subscriptionMemberType` 'User' | 'SharedInbox' | 'Personal' | 'SharedInboxAccount' | 'Bot', required: Subscription types
        - `paymentStatus` string: Payment status - ttemporary remove when FE(dta) will save this document because this is current state
      - `size` integer, required: Page size
      - `offset` integer, required: Page offset
      - `offsetHistoryId` string: Offset history id
      - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size
    - `subscriptionType` SubscriptionType: Subscription type
      - `id` string: Id of subcription type
      - `name` string: name of subscription type
    - `validUntil` string, date-time: Valid until
    - `numLicenses` integer, required: Num of licenses
    - `details` SubscriptionDetails: Subscription type
      - `vouchers` ListOfResourcesOfSubscriptionVoucher: List of resources
        - `resources` SubscriptionVoucher[]: List of resources
          - `code` string: Code
          - `valid` boolean, required: Valid
          - `validationMessage` string: Validation message
        - `size` integer, required: Page size
        - `offset` integer, required: Page offset
        - `offsetHistoryId` string: Offset history id
        - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size
      - `paidAccounts` SubscriptionPaidAccounts: Paid accounts
        - `users` integer, required: users count
        - `sharedInbox` integer, required: shared inbox count
        - `personal` integer, required: personal count
        - `teams` integer, required: teams count
    - `subscriptionStatus` 'Trial' | 'Suspended' | 'Active', required: Subscription Status types
    - `classificationEnabled` boolean, required: Classification enabled
    - `aiEnabled` boolean, required: AI enabled
    - `categoryEnabled` boolean, required: Category enabled
    - `kioskModeEnabled` boolean, required: Kiosk mode enabled
    - `directLoopInboxEnabled` boolean, required: Direct LoopInbox enabled (rail Inbox opens LoopInbox without sidebar)
    - `handleTimeSettings` HandleTimeSettings: Handle Time Settings
      - `isVisible` boolean, required: Handle Time is visible
      - `isEnabled` boolean, required: Handle Time is enabled
      - `idleThresholdSeconds` integer, required: Handle Time idle time
      - `maxTimeCapSeconds` integer, required: Handle Time max time cap
    - `uiSettings` UISettings: Represents configuration settings for user interface elements.
      - `colorScheme` ColorScheme: Represents a set of colors used to define a visual theme or appearance.
        - `light` ColorPalette: Represents a collection of colors that can be used to define a palette for graphical applications.
          - `primary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
          - `secondary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
          - `tertiary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
        - `dark` ColorPalette: Represents a collection of colors that can be used to define a palette for graphical applications.
          - `primary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
          - `secondary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
          - `tertiary` Color: Represents a color value, typically used to define colors in graphical applications or user interfaces.
            - `base` string: Gets or sets the base color (hex value of color).
            - `contrast` string: Gets or sets the contrast color (hex value of color).
      - `areDefaultSchemeVisible` boolean, required: Gets or sets a value indicating whether the default color schemes are visible in the user interface.
    - `logo` string: Workspace Logo
    - `bumpSettings` 'RepliesAndComments' | 'Comments' | 'Replies' | 'Never', required: Bump settings types
    - `purgeSettings` PurgeSettings: Represents configuration settings for purge.
      - `purgeEnabled` boolean, required: Purge is enabled
      - `gracePeriod` integer, required: Gets or sets grace period in days.
    - `profileSettings` ProfileSettings: Represents the configuration settings for a user profile.
      - `profileEnabled` boolean, required: Gets or sets a value indicating whether profiling is enabled.
  - `size` integer, required: Page size
  - `offset` integer, required: Page offset
  - `offsetHistoryId` string: Offset history id
  - `totalSize` integer, required: Total size (if total size is at least one bigger than size, then there are more resources). Total size does not necessarily mean the actual total size

## Other responses

- `400`: Bad request. Check fields message and error code from response body for additional information.
- `401`: Unauthorized request. Check fields message and error code from response body for additional information.
- `403`: Requested resource forbidden.Check fields message and error code from response body for additional information.
- `404`: Requested resource not found.
- `429`: Too many requests. Check response header Retry-After indicating how long to wait before making a new request.
- `451`: Unavailable because account is not verified.

---

[API](https://skmtc.dev/intheloop/apis/loop-api.md) - [All operations](https://skmtc.dev/intheloop/apis/loop-api/llms.txt) - [OpenAPI document](https://skmtc.dev/intheloop/apis/loop-api/revisions/0892c5ba0787?raw)
