---
title: "List Users"
method: GET
path: "/users"
tags: ["user"]
---

# List Users

`GET /users`

List users within workspace

## Query parameters

- `email_search_query` string

## Response `200`

Successful operation

- object
  - `users` User[], required
    - `user_id` string — ID of the user. Will override exisiting user if the specified ID already being used. Please note that `id` field is only used internally.
    - `name` string — Name of the user.
    - `profile_url` string — Profile image of the user
    - `default_member_type` 'guest' | 'host' | 'monitor' — Type of user in this room - guest: The user is guest. - host: The user is host. This user has administrator privileges. - monitor: The user is observer. Can watch the meeting, but can not join.
    - `access_token` string — Access token to authenticate as the user.
    - `created_at` string, date-time — Creation time of the user
    - `updated_at` string, date-time — Last modified time of the user
  - `paging` Paging — Details of pagination used for current responses.
    - `limit` number, required
    - `offset` number, required
    - `total` number, required

## Other responses

- `400` — Invalid Parameters Supplied or Unauthenticated or Unauthorized
- `500` — Validation exception

---

[API](https://skmtc.net/pplink/apis/pagecall-public-api-openapi-3-0.md) · [All operations](https://skmtc.net/pplink/apis/pagecall-public-api-openapi-3-0/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pplink/pagecall-public-api-openapi-3-0/revisions/c6a9d7e46d2a/schema)