---
title: "Get accessWidget licenses"
method: GET
path: "/accounts/{accountId}/access-widget-licenses"
---

# Get accessWidget licenses

`GET /accounts/{accountId}/access-widget-licenses`

## Request

- Base URL: `https://dashboard.accessibe.com/api/v1/partners`
- URL: `https://dashboard.accessibe.com/api/v1/partners/accounts/{accountId}/access-widget-licenses`
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/accessibe/apis/partners-api-license/docs/accounts/:accountId/access-widget-licenses/get.ts> (a function with typed inputs; its response is checked against the schema)

Gets all the accessWidget licenses for the specified account.

This endpoint requires the `x-api-key` header for authentication. The key must match the API key associated with the specified account. The account must also be a partner account.

## Path parameters

- `accountId` string, required

## Query parameters

- `expand[]` 'settings': Expands extra fields in the response. If present, includes `maxImagesReached`, `maxImagesLimit`, and the `settings` object (which related to customization settings). `maxImagesReached` indicates the maximum allowed images is exceeded.
- `nextToken` string
- `limit` integer: The number of results to return.
- `status` 'active' | 'trial' | 'expired' | 'grace'
- `domain` string

## Response `200`

The list of licenses found.

- object
  - `success` boolean
  - `message` string
  - `data` object
    - `total` integer: The total number of licenses without any filters.
    - `licenses` License[]
      - `id` string
      - `date` string, date-time
      - `relatedAccountId` string
      - `domain` string
      - `status` 'active' | 'grace' | 'expired' | 'trial'
      - `price` number
      - `licenseType` string
      - `plan` Plan, nullable
        - `name` string
        - `planSKU` number
      - `relatedBillingId` string, nullable
      - `statementDate` string, date-time
      - `dateTrialExpires` string, date-time
      - `datePlanExpires` string, date-time, nullable
      - `datePlanFirstActivated` string, date-time, nullable
      - `lastSubscriptionPaymentId` string, nullable
      - `enableGoogleAnalytics` boolean
      - `enableRemediationReport` boolean
      - `monthly` boolean
      - `autoRenew` boolean
      - `contactName` string, nullable
      - `contactEmail` string, nullable
      - `contactPhone` string, nullable
      - `contactCountry` string, nullable
      - `settings` LicenseSettings
        - `leadColor` string, nullable
        - `language` 'en' | 'es' | 'fr' | 'de' | 'pl' | 'it' | 'pt' | 'nl' | 'hu' | 'no' | 'sl' | 'sk' | 'sv' | 'cs' | 'tr' | 'ja' | 'tw' | 'zh' | 'he' | 'ru' | 'ar' | 'fi' | 'uk' | 'ro' | 'ga' | 'el' | 'sr' | 'bs' | 'hr' | 'lb' | 'sq' | 'da', nullable
        - `position` 'left' | 'right', nullable
        - `triggerColor` string, nullable
        - `triggerPositionX` 'left' | 'right', nullable
        - `triggerPositionY` 'top' | 'center' | 'bottom', nullable
        - `triggerSize` 'small' | 'medium' | 'big', nullable
        - `triggerRadius` '50%' | '0' | '10px' | '5px', nullable
        - `hideTrigger` boolean, nullable
        - `triggerOffsetX` number, nullable
        - `triggerOffsetY` number, nullable
        - `triggerIcon` 'checkmark' | 'display' | 'display2' | 'display3' | 'help' | 'people' | 'people2' | 'settings' | 'settings2' | 'wheels' | 'wheels2', nullable
        - `hideMobile` boolean, nullable
        - `mobile` object, nullable
          - `triggerPositionX` 'left' | 'right', nullable
          - `triggerPositionY` 'top' | 'center' | 'bottom', nullable
          - `triggerSize` 'small' | 'medium' | 'big', nullable
          - `triggerRadius` '50%' | '0' | '10px' | '5px', nullable
          - `triggerOffsetX` number, nullable
          - `triggerOffsetY` number, nullable
        - `statementLink` string, url, nullable
        - `footerHtml` string, nullable
      - `maxImagesReached` boolean: Indicates if the maximum allowed images have been reached for this license
      - `maxImagesLimit` number: Shows the maximum images limit for this license
    - `nextToken` string, nullable

## Other responses

- `400`: The request is invalid. Any field could potentially be the cause.
- `401`: Missing or invalid API key
- `403`: Account does not have access to do this operation
- `404`: No licenses were found

---

[API](https://skmtc.dev/accessibe/apis/partners-api-license.md) - [All operations](https://skmtc.dev/accessibe/apis/partners-api-license/llms.txt) - [OpenAPI document](https://skmtc.dev/accessibe/apis/partners-api-license/revisions/b7f155181cf7?raw)