List widget types

List all active widget types for the widget builder, plus the widget add-on status when you supply store_id (whether the store has an active add-on and which store ids it covers).

Auth

  • Bearer — account (account) role.

Rate limit

  • No rate limit.

Query

FieldTypeRequiredNotes
store_idintegerOptionalMust be an existing location + must belong to the auth company. When present, widget_add_ons is populated.
company_idintegerOptionalMust be an existing account + must belong to the auth company.

Behaviour

  • 200 with { "data": { "status": "success", "data": [.widget types ], "widget_add_ons": { status, store_ids } | null } }. widget_add_ons is null when no store_id is given.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json