List widgets

GET

/widgets

curl --request GET \
  --url 'https://api.example.com/v1/widgets?limit=20' \
  --header 'Authorization: Bearer <token>'

• Production
• Sandbox

Returns a paginated list of widgets owned by the authenticated account.

Authorizations

• bearerAuth

Parameters

Query Parameters

limit

integer

default: 20 >= 1 <= 100

Maximum number of widgets to return.

cursor

string

Pagination cursor returned by a previous response.

Responses

200

A page of widgets.

Media type application/json

object

data

required

Array<object>

object

id

required

string

name

required

string

description

string

nullable

created_at

required

string format: date-time

has_more

required

Whether more widgets are available beyond this page.

boolean

next_cursor

Cursor to pass on the next request to fetch the following page.

string

nullable

Example

{
  "data": [
    {
      "id": "wdg_01H8Z9XJ7M3K4P5Q6R7S8T9V0W",
      "name": "My first widget",
      "description": "Optional human-readable description."
    }
  ]
}

401

Authentication failed or was not provided.

Media type application/json

object

code

required

string

message

required

string

request_id

string

Example

{
  "code": "invalid_request",
  "message": "The `name` field is required.",
  "request_id": "req_01H8Z9XJ7M3K4P5Q6R7S8T9V0W"
}