---
title: "GET /api/v1/organizations/{org_slug}/pages/sites"
method: GET
path: "/api/v1/organizations/{org_slug}/pages/sites"
tags: ["organizations"]
---

# GET /api/v1/organizations/{org_slug}/pages/sites

`GET /api/v1/organizations/{org_slug}/pages/sites`

## Request

- Base URL: `https://composal.com` (the document declares no server; this is the origin it was published from)
- URL: `https://composal.com/api/v1/organizations/{org_slug}/pages/sites`
- Auth: HTTP bearer

## Path parameters

- `org_slug` string, required

## Query parameters

- `site` string

## Response `200`

Organization Sites page contract. `domains` and `deployments` belong to `selected_site_id`, which names one of `sites`.

- object
  - `organization_id` string, required
  - `sites` StaticSite[], required
    - `id` string, required
    - `organization_id` string, required
    - `hosted_app_id` string, nullable, required
    - `repository_id` string, nullable, required
    - `slug` string, required
    - `name` string, required
    - `description` string, nullable, required
    - `status` 'draft' | 'provisioning' | 'active' | 'degraded' | 'archived' | 'failed', required
    - `region` string, nullable, required
    - `replication_regions` string[], required
    - `index_document` string, required
    - `error_document` string, nullable, required
    - `default_url` string, uri, required
    - `cdn_url` string, uri, required
    - `cdn_hostname` string, required
    - `cname_target` string, required
    - `provisioned` boolean, required
    - `failure_message` string, nullable, required
    - `active_deployment_id` string, nullable, required
    - `provisioned_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `selected_site_id` string, nullable, required
  - `domains` StaticSiteDomain[], required
    - `id` string, required
    - `hosted_app_id` string, nullable, required
    - `app_service_id` string, nullable, required
    - `app_environment_id` string, nullable, required
    - `static_site_id` string, nullable, required
    - `hostname` string, required
    - `kind` 'primary' | 'redirect' | 'preview' | 'internal', required
    - `target_kind` 'app_service' | 'static_site', required
    - `dns_mode` 'manual_cname' | 'cloudflare', required
    - `record_type` string, nullable, required
    - `record_name` string, nullable, required
    - `record_value` string, nullable, required
    - `tls_status` 'pending' | 'active' | 'failed', required
    - `dns_status` 'pending' | 'configured' | 'failed', required
    - `verification_status` 'pending' | 'configured' | 'failed', required
    - `last_checked_at` string, date-time, nullable, required
    - `failure_message` string, nullable, required
    - `redirect_to` string, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `deployments` StaticSiteDeployment[], required
    - `id` string, required
    - `static_site_id` string, required
    - `creator_user_id` string, nullable, required
    - `deploy_slug` string, required
    - `status` 'pending' | 'uploading' | 'uploaded' | 'activating' | 'active' | 'failed' | 'canceled' | 'superseded', required
    - `trigger_kind` 'cli' | 'api' | 'dashboard' | 'ci', required
    - `commit_sha` string, nullable, required
    - `source_ref` string, nullable, required
    - `file_count` integer, required
    - `total_bytes` integer, required
    - `file_count_label` string, required
    - `total_bytes_label` string, required
    - `failure_message` string, nullable, required
    - `is_active` boolean, required
    - `uploaded_at` string, date-time, nullable, required
    - `activated_at` string, date-time, nullable, required
    - `started_at` string, date-time, nullable, required
    - `finished_at` string, date-time, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `uploaded_at_label` string, nullable, required
    - `activated_at_label` string, nullable, required
    - `started_at_label` string, nullable, required
    - `finished_at_label` string, nullable, required
    - `created_at_label` string, nullable, required
    - `updated_at_label` string, nullable, required
  - `cloudflare_connected` boolean, required
  - `summary` object, required
    - `total` integer, required
    - `active` integer, required
    - `failed` integer, required

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `422`: Unprocessable entity
- `502`: Bad gateway

---

[API](https://skmtc.dev/composal/apis/vex-api.md) - [All operations](https://skmtc.dev/composal/apis/vex-api/llms.txt) - [OpenAPI document](https://skmtc.dev/composal/apis/vex-api/revisions/74298a24e040?raw)