Widgets

List widgets

Returns widgets, newest first. Pagination is cursor-based. Pass the next_cursor from the previous response without changing it. Offsets are not supported, because a widget created mid-pagination would shift them.

GET/widgets

Request

curl --request GET \
  --url 'https://api.example.com/v1/widgets' \
  --header 'Authorization: <api-key>'

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.example.com/v1/widgets");
curl_setopt($client, CURLOPT_CUSTOMREQUEST, "GET");
curl_setopt($client, CURLOPT_HTTPHEADER, [
    "Authorization: <api-key>",
]);
curl_setopt($client, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($client);
curl_close($client);
echo $response;

package main

import (
  "fmt"
  "io"
  "net/http"
)

func main() {
  req, _ := http.NewRequest("GET", "https://api.example.com/v1/widgets", nil)
  req.Header.Set("Authorization", "<api-key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  data, _ := io.ReadAll(res.Body)
  fmt.Println(string(data))
}

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;

var request = HttpRequest.newBuilder(URI.create("https://api.example.com/v1/widgets"))
    .header("Authorization", "<api-key>")
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();

var response = HttpClient.newHttpClient().send(
    request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

require 'net/http'
require 'json'

uri = URI("https://api.example.com/v1/widgets")
request = Net::HTTP::Get.new(uri)
request["Authorization"] = "<api-key>"

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end

puts response.body

application/json

{
  "data": [
    {
      "id": "wid_01HQ8ZK7",
      "name": "Checkout banner",
      "description": "Shown above the payment step.",
      "status": "active",
      "tags": [
        "marketing"
      ],
      "created_at": "2026-08-01T09:24:11Z"
    }
  ],
  "has_more": false,
  "next_cursor": "w_01HQ8ZK7"
}

{
  "error": {
    "code": "widget_not_found",
    "message": "No widget with this id exists.",
    "field": "name"
  }
}

Read has_more to decide whether to continue, and pass next_cursor back as cursor without changing it. Do not build the cursor yourself. Its format is not part of the contract and it can change.

Terminalcursor=""
while :; do
  page=$(curl -s "https://api.example.com/v1/widgets?limit=100&cursor=$cursor" \
    -H "Authorization: Bearer $API_KEY")
  echo "$page" | jq -r '.data[].id'
  [ "$(echo "$page" | jq -r '.has_more')" = "true" ] || break
  cursor=$(echo "$page" | jq -r '.next_cursor')
done

Offsets are deliberately not supported. A widget created while you page would shift every offset after it, so a loop would repeat one record or skip another. A cursor names a position in the result set instead, which stays correct.

{ "data": [ { "id": "wid_01HQ8ZK7", "name": "Checkout banner", "description": "Shown above the payment step.", "status": "active", "tags": [ "marketing" ], "created_at": "2026-08-01T09:24:11Z" } ], "has_more": false, "next_cursor": "w_01HQ8ZK7" }

List widgets

Paging through every widget

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown