iAdvizeDocs

List sites

Returns every site in your organization.

GET
/api/v1/sites

Authorization

ApiKeyAuth
AuthorizationBearer <token>

A WorkOS org-scoped API key, created from the dashboard's organization settings page. Identifies the tenant every read and write is scoped to. Missing, malformed, unknown, revoked, expired, or non-organization-owned keys all return 401 (no distinction, so the response can't be used to probe which keys or org ids exist).

In: header

Response Body

application/json

application/problem+json

application/problem+json

application/problem+json

application/problem+json

curl -X GET "https://example.com/api/v1/sites"
{  "data": [    {      "id": "site_01kvnwmagvf27rc9cze5rm9e1r",      "name": "Demo Storefront",      "platform": "shopify",      "createdAt": "2026-06-01T09:24:00.000Z",      "updatedAt": "2026-06-01T09:24:00.000Z",      "url": "https://demo-storefront.example",      "siteInformation": "Outdoor clothing and gear. Free returns within 30 days.",      "toneOfVoice": "Friendly and direct.",      "vertical": "retail",      "autoGenerateStarters": false,      "switchOnGeneratedStarters": false,      "pageViewCountingEnabled": true,      "storefrontCartCountingEnabled": true,      "autoReadPages": true,      "autoReadMinViews": 10,      "tagMonitoringEnabled": true,      "panelColors": null,      "panelPosition": "right",      "panelBackdrop": false,      "hostedPage": {        "enabled": true,        "link": "https://iadvize.ai/s/pk_site_k3v9m2x8q1w4"      },      "defaultAgentId": "agt_01kvnwmagvf27rc9cze5rm9e1s",      "analysisState": "acknowledged",      "resumeButton": {        "position": null,        "offsetBottom": null,        "offsetSide": null,        "offsetBottomNarrow": null,        "offsetSideNarrow": null,        "colors": {          "background": null,          "icon": null,          "border": null        },        "icon": null,        "size": null,        "radius": null,        "shadow": null      }    }  ]}