Retrieve a site item

GET

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

GET

/api/public/v1/site-items/:siteItem

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

200200 - Site item

{
  "data": {
    "attributes": {
      "basename": "woocommerce/woocommerce.php",
      "component_id": 42,
      "created_at": "2026-06-01T09:00:00.000000Z",
      "has_error": false,
      "history": [
        {
          "created_at": "2026-09-01T03:00:00.000000Z",
          "event": "upgraded",
          "from_version": "8.9.5",
          "to_version": "8.10.0"
        }
      ],
      "is_hidden": false,
      "last_error": null,
      "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"
  },
  "jsonapi": {
    "version": "1.1"
  }
}

Returns one installed item. Use fields[site-items] for details that a listing leaves out, such as the last error, which actions the item allows and its recent version history.

Only include and fields apply: filter, sort and page are ignored. Asking for history also requires a role that is allowed to see version history.

Authentication

AuthorizationBearer

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

Path parameters

siteItemstringRequired

Query parameters

includestringOptional

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

fields[site-items]stringOptional

Attributes to return, comma-separated; only those are returned. Any of the computed attributes of "List site items" can be named: copilot_score, released_at, 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.

Response

200 - Site item

dataobjectOptional

jsonapiobjectOptional