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

# List all users

`GET /api/v1/users`

## Query parameters

- `limit` integer, nullable
- `offset` integer, nullable

## Response `200`

List of users

- PaginatedApiResponseUser — Response type for paginated list endpoints (pagination is always present in meta)
  - `data` object[], required — The page of results. Empty when nothing matched the query.
    - `email` string, email, required — The user's email address, also their login identifier.
    - `email_settings` EmailSettings — Per-user toggles for the user-pausable email categories. Each field maps 1:1 to a [`PausableCategory`]; required emails are never gated here. Stored as a JSONB blob, so new categories are added as new fields rather than via migration. New fields carry `#[serde(default = "default_true")]` so a category is opted in by default if its key is absent from the stored JSON.
      - `daemon_alerts` boolean — Send an alert when a daemon stops reporting.
      - `discovery_digest` boolean, required — Send a periodic summary of what discovery found.
      - `product_onboarding` boolean — Send getting-started guidance.
      - `trial_and_usage` boolean — Send trial reminders and plan-usage warnings.
    - `email_verified` boolean — Whether the user has verified their email address
    - `has_password` boolean — Whether the user has a password set — computed from password_hash, never stored in DB
    - `network_ids` string[], required — The networks this entity applies to.
    - `oidc_linked_at` string, date-time, nullable — When the account was linked to the identity provider.
    - `oidc_provider` string, nullable — Slug of the identity provider this account signs in through, when linked.
    - `organization_id` string, uuid, required — The organization that owns this record.
    - `permissions` 'Owner' | 'Admin' | 'Member' | 'Viewer', required
    - `terms_accepted_at` string, date-time, nullable — When the user accepted the terms of service.
    - `created_at` string, date-time, required — When this record was first created.
    - `id` string, uuid, required — Server-assigned unique identifier.
    - `updated_at` string, date-time, required — When this record was last modified.
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` PaginatedApiMeta, required — API metadata for paginated list responses (pagination is always present)
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `pagination` PaginationMeta, required — Pagination metadata returned with paginated responses.
      - `group_counts` GroupCount[], nullable — Size of every group, in the same order the rows are grouped, when the request specified a `group_by`. Lets a paginated client show a group's true size instead of the slice of it that happens to be on this page. Absent when the list isn't grouped.
        - `count` integer, required — How many rows fall in this group in total, not just on this page.
        - `value` string, nullable — The group's value, rendered as text. `null` for rows whose group key is NULL (the "ungrouped" bucket).
      - `has_more` boolean, required — Whether there are more items after this page
      - `limit` integer, required — Maximum items per page (as requested)
      - `offset` integer, required — Number of items skipped
      - `total_count` integer, required — Total number of items matching the filter (ignoring pagination)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

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