Retrieve a widget

Returns one widget by its id.

GET/widgets/{widget_id}

Request

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

import json
import requests

url = "https://api.example.com/v1/widgets/<widget_id>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.example.com/v1/widgets/<widget_id>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.example.com/v1/widgets/<widget_id>");
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/<widget_id>", 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/<widget_id>"))
    .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/<widget_id>")
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

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

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

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

A 404 is a normal answer, not a failure of the request. Treat it as a value: the widget is not there. It does not mean the API key is wrong, which is a 401.

Terminalstatus=$(curl -s -o body.json -w '%{http_code}' \
  "https://api.example.com/v1/widgets/$WIDGET_ID" \
  -H "Authorization: Bearer $API_KEY")

case "$status" in
  200) jq -r '.name' body.json ;;
  404) echo "gone" ;;
  *)   jq -r '.error.code' body.json; exit 1 ;;
esac

Request

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

import json
import requests

url = "https://api.example.com/v1/widgets/<widget_id>"
headers = {
  "Authorization": "<api-key>"
}

response = requests.request("GET", url, headers=headers)
print(response.json())

const response = await fetch("https://api.example.com/v1/widgets/<widget_id>", {
  method: "GET",
  headers: {
    "Authorization": "<api-key>"
  },
});

const data = await response.json();
console.log(data);

<?php
$client = curl_init();

curl_setopt($client, CURLOPT_URL, "https://api.example.com/v1/widgets/<widget_id>");
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/<widget_id>", 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/<widget_id>"))
    .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/<widget_id>")
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

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

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

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

Retrieve a widget

Handling a missing widget

Use these docs with your AI tools

Query these docs via MCP

Query these docs over HTTP

Read these docs as Markdown