List websites

GET

https://api.modulards.com/api/public/v1/sites

GET

/api/public/v1/sites

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

{
  "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": "&laquo; Previous",
        "url": null
      },
      {
        "active": true,
        "label": "1",
        "url": "{{base_url}}/api/public/v1/sites?page%5Bnumber%5D=1"
      },
      {
        "active": false,
        "label": "Next &raquo;",
        "url": null
      }
    ],
    "path": "{{base_url}}/api/public/v1/sites",
    "per_page": 15,
    "to": 2,
    "total": 2
  }
}

Returns the websites your token can reach, ordered by name unless you sort otherwise. Use it to find websites by team, tag, connection state, WordPress or PHP version, or name, and to read the details of many websites at once.

A plain listing leaves out some attributes because they cost more to compute; ask for them with fields[sites]. To find out which websites are covered by Patch & Protect, filter with filter[patchstack] or read has_patchstack.

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 to return, starting at 1. Default 1.

page[size]stringOptional

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

sortstringOptional

Sort order: name (default, ascending), created_at, is_favorite (starred websites first with -is_favorite), updatable_items_count or vulnerable_items_count. Prefix with - for descending.

includestringOptional

Related records to embed, comma-separated: team, tags, site_preset_backup, site_preset_uptime, site_preset_malware_scan, site_preset_broken_link, site_preset_patchstack. The last five embed the settings the website uses for backups, Uptime Monitor, Malware Scanner, Broken Links Checker and Patch & Protect.

fields[sites]stringOptional

Attributes to return, comma-separated; only those are returned. These computed attributes are left out unless you name them: note (the private note), is_favorite, updatable_items_count, vulnerable_items_count and has_patchstack (whether Patch & Protect is switched on for the website).

filter[s]stringOptional

Free-text search on the website's name, slug or address.

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[connected]stringOptional

1 for websites whose connection works, 0 for websites that are not connected.

filter[patchstack]stringOptional

1 for websites with Patch & Protect switched on, 0 for websites without it.

filter[core_version][]stringOptional

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

filter[engine_version][]stringOptional

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

filter[alerts][]stringOptional

Notification configuration ids. Several values match websites associated with any of them.

filter[id][]stringOptional

Website ids. Several values match any of them.

Response

200 - websites

datalist of objectsOptional

jsonapiobjectOptional

linksobjectOptional

metaobjectOptional

Errors

403

Forbidden Error