Widget types list

Endpoint GET /widget-types

Retrieve a list of Common Ninja's widget types.

Query parameters:

• limit - number of widget types 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/widget-types?limit=5"

Node.js

const axios = require('axios');

async function getData() {
    const response = await axios.get('https://api.commoninja.com/platform/api/v1/widget-types', {
        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": "countdown",
      "name": "Countdown",
      "slug": "countdown",
      "buttonText": "Create a Countdown",
      "teaser": "Boost engagement, increase conversions, and captivate visitors",
      "logo": "https://website-assets.commoninja.com/distribution/1681118357912_countdown-icon.png",
      "promotionImage": "https://website-assets.commoninja.com/distribution/1681118373386_countdown-promotion.png",
      "categories": ["Engagement", "Conversion"]
    }
  ]
}