---
title: "List all the site for user."
method: GET
path: "/v1/sites/users"
tags: ["Site Users"]
---

# List all the site for user.

`GET /v1/sites/users`

For a given user, list all sites user has access to.

## Query parameters

- `domain` string — search string to match the domain by
- `search` string — search string to match either tha domain or label by
- `page` integer — Page of results to include (default = 1)
- `per_page` integer — How many results to include in each page (default = 10)
- `status` string[] — One or more statuses to filter by
- `sort` 'created_at' | 'domain' | 'label' | 'disk_usage' — Sort results by the following property
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListSiteUserSitesResponse
  - `success` boolean — whether the request succeeded
  - `errors` string[]
  - `messages` string[], nullable
  - `metadata` object
    - `page` integer — Page number of the results
    - `page_size` integer — Number of results per page
    - `total` integer — Total number of results
    - `sort` string — Sorting criteria
    - `direction` 'asc' | 'desc' — Sorting direction
  - `result` SiteUserSite[]
    - `id` integer — ID of the Site the Site User has access to
    - `domain` string — Domain of the Site the Site User has access to (UTF-8 via punycode)
    - `display_domain` string — Display domain of the Site the Site User has access to (UTF-8 supported)
    - `rocket_url` string — Rocket URL of the Site the Site User has access to
    - `location` string — Location of the Site the Site User has access to
    - `ftp_ip_address` string — FTP IP address of the Site the Site User has access to
    - `sftp_username` string — SFTP username of the Site the Site User has access to
    - `disk_usage` integer — Disk usage of the Site the Site User has access to
    - `created_at` string — Time stamp of when the record was created
    - `production` 0 | 1 — If the site is a production site (1) or a staging site (0)
    - `staging` object
      - `staging_id` integer — ID of the staging site
      - `staging_status` 'active' | 'deleting' | 'pending' | 'locked' — Status of the staging site
    - `site_type` 0 | 1 — Type of site. 0 == WordPress, 1 == static site
    - `label` string — Label of the Site
    - `metadata` string — Metadata tagged to the Site
    - `status` 'Active' | 'Declined' | 'Invited' — Status of the Site
    - `status_reason` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 — Reasons why a site is in a specific status (for now, only related to pending). 0 == No additional status information required, 1 == Site is being transferred to a new server, 2 == Site template is being created from this site, 3 == Site template is being applied to this site, 4 == This is a staging site that is currently in the process of being created, 5 == Site was locked with "Lock My Site" 6 == Main Domain is currently being changed 7 == Main Domain validation change in progress 8 == Site is being cloned 9 == New Cloned Site, not ready yet 10 == Site is being created from a template

## Other responses

- `400` — Bad Request
- `401` — Authentication failed
- `403` — Not authorized to access endpoint
- `404` — Given site not found for user
- `405` — Invalid input
- `500` — Internal error

---

[API](https://skmtc.net/rocket/apis/rocket-net-api.md) · [All operations](https://skmtc.net/rocket/apis/rocket-net-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/rocket/rocket-net-api/revisions/db0dcbbc5764/schema)