---
title: "List users"
method: GET
path: "/api/v1/users"
tags: ["users"]
---

# List users

`GET /api/v1/users`

Get a list of users with optional filtering

## Query parameters

- `limit` integer
- `offset` integer
- `query` string
- `role_ids` string[]
- `active` boolean

## Response `200`

OK

- ListUsersResponse
  - `limit` integer
  - `offset` integer
  - `total` integer
  - `users` User[]
    - `active` boolean
    - `created_at` string
    - `id` string
    - `identities` UserIdentity[]
      - `created_at` string
      - `id` string
      - `provider` string
      - `provider_data` object
      - `provider_email` string
      - `provider_user_id` string
      - `updated_at` string
      - `user_id` string
    - `must_change_password` boolean
    - `name` string
    - `preferences` object
    - `profile_picture` string
    - `roles` Role[]
      - `description` string
      - `id` string
      - `name` string
      - `permissions` Permission[]
        - `action` string
        - `description` string
        - `id` string
        - `name` string
        - `resource_type` string
    - `updated_at` string
    - `username` string

## Other responses

- `500` — Internal Server Error

---

[API](https://skmtc.dev/marmotdata/apis/marmot-api.md) · [All operations](https://skmtc.dev/marmotdata/apis/marmot-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/marmotdata/marmot-api/revisions/0bd802afff21/schema)