List components

GET

https://api.modulards.com/api/public/v1/components

GET

/api/public/v1/components

curl https://api.modulards.com/api/public/v1/components \
     -H "Authorization: Bearer <token>"

200200 - Components

{
  "data": [
    {
      "attributes": {
        "closed": false,
        "copilot_score": 92,
        "days_since_release": 11,
        "in_progress_actions": 0,
        "is_abandoned": false,
        "latest_version": "8.10.1",
        "name": "WooCommerce",
        "released_at": "2026-09-10T00:00:00.000000Z",
        "sites_active": 8,
        "sites_total": 9,
        "sites_updatable": 4,
        "slug": "woocommerce",
        "type": "plugin",
        "url": "https://woocommerce.com/",
        "vulnerabilities": 1
      },
      "id": "42",
      "type": "components"
    },
    {
      "attributes": {
        "closed": false,
        "copilot_score": 100,
        "days_since_release": 68,
        "in_progress_actions": 0,
        "is_abandoned": false,
        "latest_version": "6.8.1",
        "name": "WordPress",
        "released_at": "2026-07-15T00:00:00.000000Z",
        "sites_active": 12,
        "sites_total": 12,
        "sites_updatable": 1,
        "slug": "wordpress",
        "type": "core",
        "url": "https://wordpress.org/",
        "vulnerabilities": 0
      },
      "id": "7",
      "type": "components"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/components?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/components?page%5Bnumber%5D=1",
    "next": null,
    "prev": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "active": false,
        "label": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/components?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/components",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Returns each plugin, theme and WordPress version installed on your websites once, with how many websites have it, how many can be updated, its known vulnerabilities and the actions running on it. Use it to decide what to update first. Sorted by the number of websites with an update available, most first, unless you sort otherwise.

The website filters narrow which websites are counted. When fields[components] is not sent, every counter is returned.

Authentication

AuthorizationBearer

Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

Query parameters

filter[type][]stringOptional

Component types: core, plugin or theme. Several values match any of them.

filter[site][]stringOptional

Website ids: only installs on these websites are counted. Several values match any of them.

filter[team][]stringOptional

Team ids: only installs on websites of these teams are counted.

filter[tags][]stringOptional

Tag ids: only installs on websites carrying any of these tags are counted.

filter[core_version][]stringOptional

Exact WordPress versions: only installs on websites running one of them are counted, for example 6.8.1.

filter[engine_version][]stringOptional

Exact PHP versions: only installs on websites running one of them are counted, for example 8.2.27.

filter[update_available]stringOptional

1 for components with at least one counted website waiting for an update, 0 for the rest.

filter[has_vulnerabilities]stringOptional

1 for components with a known vulnerability in an installed version, 0 for the rest.

filter[is_abandoned]stringOptional

1 for components whose author has not released anything in 2 years, 0 for the rest.

filter[closed]stringOptional

1 for components closed on wordpress.org, 0 for the rest.

filter[s]stringOptional

Free-text search on the component's name.

sortstringOptional

Sort order: sites_updatable (default, descending), name, vulnerabilities, released_at or sites_total. Prefix with - for descending.

page[number]stringOptional

Page to return, starting at 1. Default 1.

page[size]stringOptional

Number of components per page, 1 to 50. Default 15.

fields[components]stringOptional

Attributes to return, comma-separated; only those are returned. Default: all of slug, name, type, url, is_abandoned, closed, latest_version, released_at, days_since_release, copilot_score, vulnerabilities, sites_total, sites_updatable, sites_active and in_progress_actions. sites_updatable counts the websites with a newer version pending, an update notice that is not hidden, and that also accept installs.

Response

200 - Components

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional