Retrieve a widget

GET

/widgets/{widgetId}

const url = 'https://api.example.com/v1/widgets/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Authorizations

bearerAuth

Parameters

Path Parameters

widgetId

required

string

The unique identifier of the widget.

Responses

200

The requested widget.

application/json

object

required

string

name

required

string

description

string

nullable

created_at

required

string format: date-time

Example

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

404

The requested resource does not exist.

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"
}

Maintained by EkLine