Get an accessWidget license

Gets the details of the specified accessWidget license for the specified account ID. Use GET /accounts/{accountId}/access-widget-licenses and filter by domain to get the licenseId for a specific domain.

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.

get/accounts/{accountId}/access-widget-licenses/{licenseId}

Request

Base URL
https://dashboard.accessibe.com/api/v1/partners
Auth
API key in header X-API-Key
TypeScript
https://skmtc.dev/accessibe/apis/partners-api-license/docs/accounts/:accountId/access-widget-licenses/:licenseId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

accountIdstring required

The ID of the account. You can check your ID here.

licenseIdstring required

The ID of the license.

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.

Response

License found

successboolean

messagestring

Changes

No recorded changes to this operation across all 2 revisions of this API.