Show site

GET

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

GET

/api/public/v1/sites/:site

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

200200 - Website

{
  "data": {
    "attributes": {
      "host": "acme-corp.com",
      "name": "Acme Corp",
      "note": "<p>Client prefers deployments on Tuesdays.</p>"
    },
    "id": "101",
    "links": {
      "self": "https://api.modulards.com/api/public/v1/sites/101"
    },
    "relationships": {
      "site_preset_uptime": {
        "data": {
          "id": "553",
          "type": "site-preset-uptimes"
        }
      },
      "tags": {
        "data": [
          {
            "id": "1",
            "type": "tags"
          }
        ]
      },
      "team": {
        "data": {
          "id": "7",
          "type": "teams"
        }
      }
    },
    "type": "sites"
  },
  "included": [
    {
      "attributes": {
        "created_at": "2026-01-14T09:30:00.000000Z",
        "name": "Default team",
        "slug": "default-team",
        "updated_at": "2026-01-14T09:30:00.000000Z"
      },
      "id": "7",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/teams/7"
      },
      "type": "teams"
    },
    {
      "attributes": {
        "color": "#FF5733",
        "created_at": "2026-01-20T10:00:00.000000Z",
        "name": "Production",
        "order": 1,
        "updated_at": "2026-01-20T10:00:00.000000Z"
      },
      "id": "1",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/tags/1"
      },
      "type": "tags"
    },
    {
      "attributes": {
        "created_at": "2026-09-01T08:30:00.000000Z",
        "keyword": {
          "keys": [],
          "status": "disabled",
          "type": null
        },
        "next_request": "2026-09-17T10:08:00.000000Z",
        "path": null,
        "redirects": {
          "expected_url": null,
          "max_redirects": 3,
          "status": "disabled"
        },
        "site_status": "up",
        "status": "enabled",
        "updated_at": "2026-09-17T10:03:10.000000Z"
      },
      "id": "553",
      "links": {
        "self": "https://api.modulards.com/api/public/v1/uptime-services/553"
      },
      "type": "site-preset-uptimes"
    }
  ],
  "jsonapi": {
    "version": "1.1"
  }
}

Reads one website in full. note decrypts and appears by default here even without naming it in fields[sites] - unlike “List sites”, where it stays out unless requested.

Query params: include (team, tags, site_preset_backup, site_preset_uptime, site_preset_malware_scan, site_preset_broken_link) and fields[sites] (sparse fieldset - when present, only the named attributes are returned).

Answers 200 with the resource document; included carries whatever include named.

Sites of other organizations answer 404.

Reads one website in full. `note` decrypts and appears by default here even without naming it in `fields[sites]` - unlike "List sites", where it stays out unless requested. Query params: `include` (`team`, `tags`, `site_preset_backup`, `site_preset_uptime`, `site_preset_malware_scan`, `site_preset_broken_link`) and `fields[sites]` (sparse fieldset - when present, only the named attributes are returned). Answers **200** with the resource document; `included` carries whatever `include` named. Sites of other organizations answer 404.

Authentication

AuthorizationBearer

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

Path parameters

sitestringRequired

Query parameters

includestringOptional

site_preset_uptime embeds the website’s Uptime Monitor settings (status, configuration, keyword, path, redirects) - the id “Show uptime service” and “Update uptime service” take

fields[sites]stringOptional

note answers by default on show even without this param; named here to show it opts into the index too

Response

200 - Website

dataobjectOptional

includedlist of objectsOptional

jsonapiobjectOptional