Laravel Design First
GET /api/widgets

This endpoint returns a list of widgets.

Responses

  • 200 application/json

    successful

    Hide headers attribute Show headers attribute
    • Cache-Control string

      This header declares the cacheability of the content so you can skip repeating requests.

    Hide response attributes Show response attributes object

    • data array | object Required

      The response data. This can be an array or an object, depending on the endpoint.

      One of:
      array-1 array object-2 object
    • data array[object]

      This is a widget. It has a name and a description. It can be used to demonstrate the use of components.

      Hide data attributes Show data attributes object
      • id string(uuid)
      • created_at string(date-time)
      • updated_at string(date-time)
    • links object

      Links related to the response. This is useful for pagination, for example.
  • 429

    too many requests

    Hide headers attributes Show headers attributes
    • X-Rate-Limit-Limit integer

      The number of allowed requests in the current period

    • X-Rate-Limit-Remaining integer

      The number of remaining requests in the current period

    • X-Rate-Limit-Reset integer

      The number of seconds left in the current period

GET /api/widgets 
curl \
 --request GET 'https://example.com/api/widgets'
Response examples (200) 
# Headers
Cache-Control: string

# Payload
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2026-05-04T09:42:00Z",
      "updated_at": "2026-05-04T09:42:00Z"
    }
  ],
  "links": {}
}