> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://api.docs.modulards.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://api.docs.modulards.com/_mcp/server.

# List components

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

One row per plugin/theme/core installed anywhere the token can reach, with per-organization aggregates. Default sort: `sites_updatable` descending.

Reference: https://api.docs.modulards.com/modular-ds-public-api/updater/list-components

## Authentication

- `Authorization` header (bearer token, required) — Personal access token created in the Modular DS dashboard; read-only tokens can only call GET endpoints.

## Request

### Query parameters

- `filter[type][]` (string, optional) — core | plugin | theme
- `filter[site][]` (string, optional) — Narrows the counted sites
- `filter[team][]` (string, optional)
- `filter[tags][]` (string, optional)
- `filter[core_version][]` (string, optional) — Exact WordPress versions of the website, for example 6.8.1; repeat the parameter for several, any of them matches
- `filter[engine_version][]` (string, optional) — Exact PHP versions of the website, for example 8.2.27; repeat the parameter for several, any of them matches
- `filter[update_available]` (string, optional) — 1|0: true = at least one counted site has an update pending
- `filter[has_vulnerabilities]` (string, optional) — 1|0: true = a known vulnerability affects an installed version
- `filter[is_abandoned]` (string, optional) — 1|0: true = no release by its author in 2 years
- `filter[closed]` (string, optional) — 1|0: true = closed on wordpress.org
- `filter[s]` (string, optional)
- `sort` (string, optional) — sites_updatable (default, desc) | name | vulnerabilities | released_at | sites_total, `-`-prefixed for descending
- `page[number]` (string, optional)
- `page[size]` (string, optional) — Max 50, default 15
- `fields[components]` (string, optional) — Sparse fieldset. Base attributes: slug, name, type, url, is_abandoned, closed, latest_version, released_at, days_since_release, copilot_score, vulnerabilities, sites_total, sites_updatable, sites_active, in_progress_actions. `sites_updatable`: of those, how many have a newer version pending on a site that also accepts installs - the same rule as the site item's own `updatable` filter.

## Response

### 200

200 - Components

- `data` (list of object, optional)
  - `attributes` (object, optional)
    - `closed` (boolean, optional)
    - `copilot_score` (double, optional)
    - `days_since_release` (double, optional)
    - `in_progress_actions` (double, optional)
    - `is_abandoned` (boolean, optional)
    - `latest_version` (string, optional)
    - `name` (string, optional)
    - `released_at` (string, optional)
    - `sites_active` (double, optional)
    - `sites_total` (double, optional)
    - `sites_updatable` (double, optional)
    - `slug` (string, optional)
    - `type` (string, optional)
    - `url` (string, optional)
    - `vulnerabilities` (double, optional)
  - `id` (string, optional)
  - `type` (string, optional)
- `jsonapi` (object, optional)
  - `version` (string, optional)
- `links` (object, optional)
  - `first` (string, optional)
  - `last` (string, optional)
  - `next` (any, optional, nullable)
  - `prev` (any, optional, nullable)
- `meta` (object, optional)
  - `current_page` (double, optional)
  - `from` (double, optional)
  - `last_page` (double, optional)
  - `links` (list of object, optional)
    - `active` (boolean, optional)
    - `label` (string, optional)
    - `url` (string, optional, nullable)
  - `path` (string, optional)
  - `per_page` (double, optional)
  - `to` (double, optional)
  - `total` (double, optional)

## Examples

**Response**

```json
{
  "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
  }
}
```

**SDK Code**

```python 200 - Components
import requests

url = "https://api.modulards.com/api/public/v1/components"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript 200 - Components
const url = 'https://api.modulards.com/api/public/v1/components';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 - Components
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.modulards.com/api/public/v1/components"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 - Components
require 'uri'
require 'net/http'

url = URI("https://api.modulards.com/api/public/v1/components")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 - Components
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.modulards.com/api/public/v1/components")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 - Components
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.modulards.com/api/public/v1/components', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 - Components
using RestSharp;

var client = new RestClient("https://api.modulards.com/api/public/v1/components");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 - Components
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/components")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```