List site items

GET

https://api.modulards.com/api/public/v1/site-items

GET

/api/public/v1/site-items

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

200200 - Site items

{
  "data": [
    {
      "attributes": {
        "basename": "woocommerce/woocommerce.php",
        "can_upgrade": true,
        "component_id": 42,
        "copilot_score": 92,
        "created_at": "2026-06-01T09:00:00.000000Z",
        "has_error": false,
        "is_hidden": false,
        "name": "WooCommerce",
        "new_version": "8.10.1",
        "previous_version": null,
        "slug": "woocommerce",
        "status": "active",
        "type": "plugin",
        "updated_at": "2026-09-15T07:30:00.000000Z",
        "version": "8.10.0",
        "vulnerabilities_c_exists": false,
        "vulnerabilities_exists": false
      },
      "id": "301",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-items/301"
      },
      "type": "site-items"
    },
    {
      "attributes": {
        "basename": null,
        "can_upgrade": false,
        "component_id": 7,
        "copilot_score": 100,
        "created_at": "2026-04-10T09:00:00.000000Z",
        "has_error": false,
        "is_hidden": false,
        "name": "WordPress",
        "new_version": null,
        "previous_version": "6.8.0",
        "slug": "wordpress",
        "status": "active",
        "type": "core",
        "updated_at": "2026-09-10T07:30:00.000000Z",
        "version": "6.8.1",
        "vulnerabilities_c_exists": false,
        "vulnerabilities_exists": false
      },
      "id": "302",
      "links": {
        "self": "{{base_url}}/api/public/v1/site-items/302"
      },
      "type": "site-items"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  },
  "links": {
    "first": "{{base_url}}/api/public/v1/site-items?page%5Bnumber%5D=1",
    "last": "{{base_url}}/api/public/v1/site-items?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/site-items?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/site-items",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Returns every plugin, theme and WordPress version installed on the websites your token can reach, one row per website and item. Use it to answer “which of my websites run this plugin?” (filter by component) or “what is waiting for an update on these websites?”. Sorted by name unless you sort otherwise.

Items whose update notice you hid are left out unless you filter on is_hidden.

Authentication

AuthorizationBearer

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

Query parameters

filter[component]stringOptional

Component id: returns the installs of one plugin, theme or WordPress version. Ids come from "List components".

filter[site][]stringOptional

Website ids. Several values match any of them.

filter[team][]stringOptional

Team ids. Several values match websites in any of these teams.

filter[tags][]stringOptional

Tag ids. Several values match websites carrying any of these tags.

filter[core_version][]stringOptional

Exact WordPress versions of the website, for example 6.8.1. Several values match any of them.

filter[engine_version][]stringOptional

Exact PHP versions of the website, for example 8.2.27. Several values match any of them.

filter[type][]stringOptional

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

filter[status][]stringOptional

Item states: active, inactive or uninstalled. Several values match any of them.

filter[update_available]stringOptional

1 for items with a newer version available, 0 for items that are up to date.

filter[updatable]stringOptional

1 for items that can be updated now: a newer version exists, the update notice is not hidden and the website accepts installs. 0 for the rest.

filter[has_vulnerabilities]stringOptional

1 for items whose installed version has a known vulnerability, 0 for items without one.

filter[is_hidden]stringOptional

1 for items whose update notice is hidden, 0 for visible ones. Default: only visible items.

filter[s]stringOptional

Free-text search on the item's name.

sortstringOptional

Sort order: name (default, ascending), type, site_name, new_version, released_at or copilot_score. Prefix with - for descending.

page[number]stringOptional

Page to return, starting at 1. Default 1.

page[size]stringOptional

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

fields[site-items]stringOptional

Attributes to return, comma-separated; only those are returned. These computed attributes are left out unless named: copilot_score (the Update Copilot score), released_at (with days_since_release), in_progress_action_id, in_progress_action_type, in_progress_action_status, last_error, can_upgrade, can_safe_upgrade, can_activate, can_deactivate, can_delete and history.

includestringOptional

Related records to embed: site embeds the website each item is installed on.

Response

200 - Site items

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional