> 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 sites GET https://api.modulards.com/api/public/v1/sites Lists the websites the token can reach, one JSON:API resource per website, with standard pagination. Public filters: `id[]` (exact website ids), `team[]` (team ids), `tags[]` (tag ids), `connected` (`1`/`0` - whether the website's connection succeeded, both values meaningful), `core_version[]` and `engine_version[]` (exact WordPress/PHP versions, e.g. `6.8.1`/`8.2.27`; repeat the parameter for several, any of them matches), and `s` for a free-text search on the name. Public sorts: `name` (default, ascending), `created_at`, `is_favorite`, `updatable_items_count` and `vulnerable_items_count` - prefix with `-` for descending. Public includes: `team`, `tags`, `site_preset_backup`, `site_preset_uptime`, `site_preset_malware_scan` and `site_preset_broken_link` - the last four carry the row id and settings a website's backup, uptime, malware scan or Broken Links Checker service uses, read and edited under their own folders. Sparse fieldsets (`fields[sites]`) opt individual websites into computed attributes a bare listing skips for cost: `note` (decrypting it for a whole page is a cost opted into on demand), `is_favorite`, `updatable_items_count` and `vulnerable_items_count`. Default page size is 15, capped at 50 (`page[size]`). Reference: https://api.docs.modulards.com/modular-ds-public-api/websites/list-sites ## 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 - `page[number]` (string, optional) - `page[size]` (string, optional) — Max 50, default 15 - `sort` (string, optional) — name (default, ascending) | created_at | is_favorite | updatable_items_count | vulnerable_items_count, `-`-prefixed for descending - `include` (string, optional) — team | tags - `fields[sites]` (string, optional) — note only appears here when named: decrypting it for every row of a listing is a cost opted into on demand - `filter[s]` (string, optional) - `filter[team][]` (string, optional) - `filter[tags][]` (string, optional) - `filter[connected]` (string, optional) — 1|0 - whether the site's connection succeeded; both values are meaningful, not just the true case - `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 ## Response ### 200 200 - websites - `data` (list of object, optional) - `attributes` (object, optional) - `connection_status` (string, optional) - `connector_version` (string, optional) - `core_version` (string, optional) - `created_at` (string, optional) - `created_by` (double, optional) - `db_engine` (string, optional) - `db_engine_version` (string, optional) - `deleted_at` (any, optional, nullable) - `display_host` (string, optional) - `ecommerce_engine` (string, optional, nullable) - `ecommerce_version` (string, optional, nullable) - `engine` (string, optional) - `engine_version` (string, optional) - `host` (string, optional) - `is_connected` (boolean, optional) - `is_main_site` (boolean, optional) - `is_multisite` (boolean, optional) - `locale` (string, optional) - `name` (string, optional) - `path` (any, optional, nullable) - `provider` (string, optional) - `scheme` (string, optional) - `slug` (string, optional) - `synced_at` (string, optional) - `timezone` (string, optional) - `updated_at` (string, optional) - `uri` (string, optional) - `id` (string, optional) - `links` (object, optional) - `self` (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) ## Errors ### 403 Forbidden Error 403 Forbidden - Public API disabled / 403 Forbidden - Request quota used up - `errors` (list of object, optional) - `detail` (string, optional) - `status` (string, optional) - `title` (string, optional) - `jsonapi` (object, optional) - `version` (string, optional) ## Examples **Response** ```json { "data": [ { "attributes": { "connection_status": "established", "connector_version": "3.4.2", "core_version": "6.6.2", "created_at": "2026-01-14T09:30:00.000000Z", "created_by": 42, "db_engine": "mysql", "db_engine_version": "8.0.36", "deleted_at": null, "display_host": "acme-corp.com", "ecommerce_engine": "woocommerce", "ecommerce_version": "9.2.3", "engine": "php", "engine_version": "8.3.10", "host": "acme-corp.com", "is_connected": true, "is_main_site": true, "is_multisite": false, "locale": "en_US", "name": "Acme Corp", "path": null, "provider": "wp", "scheme": "https", "slug": "acme-corp", "synced_at": "2026-09-16T08:12:00.000000Z", "timezone": "Europe/Madrid", "updated_at": "2026-09-16T08:12:00.000000Z", "uri": "https://acme-corp.com" }, "id": "101", "links": { "self": "{{base_url}}/api/public/v1/sites/101" }, "type": "sites" }, { "attributes": { "connection_status": "lost", "connector_version": "3.4.1", "core_version": "6.6.1", "created_at": "2026-03-02T11:15:00.000000Z", "created_by": 42, "db_engine": "mysql", "db_engine_version": "8.0.36", "deleted_at": null, "display_host": "blog.acme-corp.com", "ecommerce_engine": null, "ecommerce_version": null, "engine": "php", "engine_version": "8.2.20", "host": "blog.acme-corp.com", "is_connected": false, "is_main_site": true, "is_multisite": false, "locale": "en_US", "name": "Acme Blog", "path": null, "provider": "wp", "scheme": "https", "slug": "acme-blog", "synced_at": "2026-09-10T21:05:00.000000Z", "timezone": "Europe/Madrid", "updated_at": "2026-09-10T21:05:00.000000Z", "uri": "https://blog.acme-corp.com" }, "id": "102", "links": { "self": "{{base_url}}/api/public/v1/sites/102" }, "type": "sites" } ], "jsonapi": { "version": "1.1" }, "links": { "first": "{{base_url}}/api/public/v1/sites?page%5Bnumber%5D=1", "last": "{{base_url}}/api/public/v1/sites?page%5Bnumber%5D=1", "next": null, "prev": null }, "meta": { "current_page": 1, "from": 1, "last_page": 1, "links": [ { "active": false, "label": "« Previous", "url": null }, { "active": true, "label": "1", "url": "{{base_url}}/api/public/v1/sites?page%5Bnumber%5D=1" }, { "active": false, "label": "Next »", "url": null } ], "path": "{{base_url}}/api/public/v1/sites", "per_page": 15, "to": 2, "total": 2 } } ``` **SDK Code** ```python 200 - websites import requests url = "https://api.modulards.com/api/public/v1/sites" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript 200 - websites const url = 'https://api.modulards.com/api/public/v1/sites'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go 200 - websites package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.modulards.com/api/public/v1/sites" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby 200 - websites require 'uri' require 'net/http' url = URI("https://api.modulards.com/api/public/v1/sites") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java 200 - websites import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.modulards.com/api/public/v1/sites") .header("Authorization", "Bearer ") .asString(); ``` ```php 200 - websites request('GET', 'https://api.modulards.com/api/public/v1/sites', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp 200 - websites using RestSharp; var client = new RestClient("https://api.modulards.com/api/public/v1/sites"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift 200 - websites import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.modulards.com/api/public/v1/sites")! 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() ```