Widgets
List widgets
Returns a paginated list of widgets belonging to the authenticated
List widgets
cURL
curl --request GET \
--url 'https://api.example.com/v3/widgets?per_page=SOME_INTEGER_VALUE&page=SOME_INTEGER_VALUE' \
--header 'Authorization: Bearer your-api-token' 200 application/json
{
"widgets": [
{
"id": "wdg_abc123",
"name": "My first widget",
"colour": "blue",
"quantity": 12,
"created_at": "2026-05-11T09:30:00Z",
"updated_at": "2026-05-11T09:30:00Z"
},
{
"id": "wdg_def456",
"name": "Backup widget",
"colour": "red",
"quantity": 3,
"created_at": "2026-05-10T14:22:00Z",
"updated_at": "2026-05-10T14:22:00Z"
}
],
"current_page": 1,
"from": 1,
"to": 2,
"total": 2,
"per_page": 50,
"last_page": 1
} Returns a paginated list of widgets belonging to the authenticated user, sorted by creation date (newest first).
Headers
- Authorization string required header
Bearer your-api-token - Accept string required header
application/json
Query parameters
- per_page integer query
Number of items per page. Default 50, maximum 200.
- page integer query
The page number for pagination. Defaults to 1.
Response codes
HTTP status- 200
Returns a paginated list of widgets.
- 401
Unauthorized — invalid or missing API token.
- 422
Validation Error — invalid parameters.