Widgets list

Endpoint GET /widgets

Retrieve a list of user's widgets data.

Query parameters:

• limit - number of widgets to retrieve (default: 10)
• fields - comma-separated list of fields to include in the response

Example Request:

curl

curl -H "Authorization: Bearer ACCESS_TOKEN" "https://api.commoninja.com/platform/api/v1/widgets?limit=5"

Node.js

const axios = require('axios');

async function getData() {
    const response = await axios.get('https://api.commoninja.com/platform/api/v1/widgets', {
        headers: {
            'Authorization': 'Bearer ACCESS_TOKEN'
        },
        params: {
            limit: 5
        }
    });

    return response.data;
}

getData();

Example Response:

{
  "total": 5,
  "limit": 5,
  "offset": 0,
  "page": 1,
  "pages": 1,
  "docs": [
    {
      "id": "894f5aed-29f5-46c5-9f26-022bfccc5292",
      "name": "My Comparison Table",
      "description": "",
      "type": "comparison_table",
      "previewImage": "",
      "status": "draft",
      "modelVersion": 1,
      "created": "2023-04-25T09:44:42.842Z",
      "updated": "2023-04-25T09:44:42.842Z"
    }
  ]
}

Please Note

This endpoint doesn't include the actual widget data. To retrieve the widget data, use the Get Widget endpoint.