---
title: "List all the site users for a Site"
method: GET
path: "/v1/sites/{id}/users"
tags: ["Site Users"]
---

# List all the site users for a Site

`GET /v1/sites/{id}/users`

For a given site, list all site user which have access to it

## Path parameters

- `id` integer, required — ID of the Site you are interacting with

## Query parameters

- `search` string — Search based on the site user's email/name
- `page` integer — Page of results to include (default = 1)
- `per_page` integer — How many results to include in each page (default = 10)
- `sort` 'email' | 'user_id' | 'status' — Sort results by the following property
- `direction` 'asc' | 'desc' | 'ASC' | 'DESC' — Direction to sort results in (asc = ascending, desc = descending)

## Response `200`

OK

- ListSiteSiteUsersResponse
  - `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` SiteUserExtended[]
    - `id` integer — ID of the site user
    - `site_id` integer — ID of the Site the Site User has access to
    - `name` string — Name of the site user
    - `email` string — Site user's email address (username)
    - `status` 'Active' | 'Declined' | 'Invited' — Status of the site user's access to this site
    - `token` string — Password Reset Token
    - `created_at` string — Time stamp of when the record was created

## 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)