List sites

View as MarkdownOpen in Claude
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]`).

Authentication

AuthorizationBearer

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

Query parameters

page[number]stringOptional
page[size]stringOptional
Max 50, default 15
sortstringOptional

name (default, ascending) | created_at | is_favorite | updatable_items_count | vulnerable_items_count, --prefixed for descending

includestringOptional

team | tags

fields[sites]stringOptional

note only appears here when named: decrypting it for every row of a listing is a cost opted into on demand

filter[s]stringOptional
filter[team][]stringOptional
filter[tags][]stringOptional
filter[connected]stringOptional

1|0 - whether the site’s connection succeeded; both values are meaningful, not just the true case

filter[core_version][]stringOptional

Exact WordPress versions of the website, for example 6.8.1; repeat the parameter for several, any of them matches

filter[engine_version][]stringOptional

Exact PHP versions of the website, for example 8.2.27; repeat the parameter for several, any of them matches

Response

200 - websites

datalist of objectsOptional
jsonapiobjectOptional
metaobjectOptional

Errors

403
Forbidden Error