List widgets
List widgets visible to the authenticated service account.
/api/json/v1/widgets
Access and behavior
- Required scope
- api_read
- Authentication
- Bearer token
- Idempotency
- not-applicable
- Operation ID
- listWidgets
Request headers
| Header | Presence | Description |
|---|---|---|
| Authorization | Required | Short-lived service-account bearer token. |
| Accept | Required | JSON:API response media type. |
Parameters
filter
query · Optional
widget-filter
Filters the query to results with attributes matching the given filter object
sort
query · Optional
string
Sort order to apply to the results
page
query · Optional
object
Paginates the response with the limit and offset or keyset pagination.
include
query · Optional
string
Relationship paths to include in the response
fields
query · Optional
object
Limits the response fields to only those listed for each type
Success response
- Media type
- application/vnd.api+json
- Schema
- object
Errors and retries
Keep x-request-id
from failed responses. Retry only rows marked retryable, and obey
Retry-After
when present.
| Status | Code | Recovery | Meaning |
|---|---|---|---|
| 401 | unauthorized | Do not retry unchanged | A valid bearer token is required. |
| 403 | forbidden | Do not retry unchanged | The service account lacks the required scope or object access. |
| 429 | rate_limited | Retry after guidance | The request exceeded its rate window; wait for Retry-After. |