Get accessWidget licenses

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.

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

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/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.

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.

nextTokenstring

Token used in pagination to retrieve the next set of results. Make the call again using the returned token to retrieve the next results.

limitinteger

The number of results to return.

Example:3

status'active' | 'trial' | 'expired' | 'grace'

Filter the results by license status.

domainstring

Filter the results by domain.

Response

The list of licenses found.

successboolean

messagestring

Changes

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