mirror of
https://github.com/stack-auth/stack.git
synced 2026-06-16 21:08:38 +08:00
13fccd32b6
Some checks failed
all-good: Did all the other checks pass? / all-good (push) Has been cancelled
Ensure Prisma migrations are in sync with the schema / check_prisma_migrations (22.x) (push) Has been cancelled
DB migration compat / Check if migrations changed (push) Has been cancelled
Docker Server Build and Push / Docker Build and Push Server (push) Has been cancelled
Docker Server Build and Run / docker (push) Has been cancelled
Runs E2E API Tests (Local Emulator) / E2E Tests (Local Emulator, Node ${{ matrix.node-version }}) (22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (mock, 22.x) (push) Has been cancelled
Runs E2E API Tests / E2E Tests (Node ${{ matrix.node-version }}, Freestyle ${{ matrix.freestyle-mode }}) (prod, 22.x) (push) Has been cancelled
Runs E2E API Tests with custom port prefix / build (22.x) (push) Has been cancelled
Lint & build / lint_and_build (latest) (push) Has been cancelled
Dev Environment Test With Custom Base Port / restart-dev-and-test-with-custom-base-port (push) Has been cancelled
Dev Environment Test / restart-dev-and-test (push) Has been cancelled
Run setup tests with custom base port / setup-tests-with-custom-base-port (push) Has been cancelled
Run setup tests / setup-tests (push) Has been cancelled
TOC Generator / TOC Generator (push) Has been cancelled
DB migration compat / Back-compat — Current branch migrations with ${{ needs.check-migrations-changed.outputs.base_branch }} branch code (push) Has been cancelled
DB migration compat / Forward-compat — Current branch code with ${{ needs.check-migrations-changed.outputs.base_branch }} branch migrations (push) Has been cancelled
DB migration compat / No migration changes (skipped) (push) Has been cancelled
53 lines
1.5 KiB
Plaintext
53 lines
1.5 KiB
Plaintext
---
|
|
title: "List Users"
|
|
description: "Lists all the users in the project. By default, only fully onboarded users are returned."
|
|
api: "GET /users"
|
|
---
|
|
|
|
## Request
|
|
|
|
<ParamField query="team_id" type="string">
|
|
Filters results to users belonging to a specific team.
|
|
</ParamField>
|
|
|
|
<ParamField query="limit" type="integer">
|
|
Maximum number of items to return.
|
|
</ParamField>
|
|
|
|
<ParamField query="cursor" type="string">
|
|
Pagination cursor for starting the result set.
|
|
</ParamField>
|
|
|
|
<ParamField query="order_by" type="string" default="signed_up_at">
|
|
Field for sorting. Defaults to `signed_up_at`.
|
|
</ParamField>
|
|
|
|
<ParamField query="desc" type="boolean" default={false}>
|
|
Descending order flag. Defaults to `false`.
|
|
</ParamField>
|
|
|
|
<ParamField query="query" type="string">
|
|
Free-text search across user ID (exact match), display name, and primary email.
|
|
</ParamField>
|
|
|
|
<ParamField query="include_anonymous" type="boolean" default={false}>
|
|
When `true`, includes anonymous and restricted users. Defaults to `false`.
|
|
</ParamField>
|
|
|
|
<ParamField query="include_restricted" type="boolean" default={false}>
|
|
Includes restricted users not yet fully onboarded. Defaults to `false`.
|
|
</ParamField>
|
|
|
|
## Response
|
|
|
|
<ResponseField name="200" type="object">
|
|
Successful response containing the list of users.
|
|
</ResponseField>
|
|
|
|
<CodeGroup>
|
|
```bash cURL
|
|
curl -X GET "https://api.stack-auth.com/users?limit=10&order_by=signed_up_at&desc=true" \
|
|
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"
|
|
```
|
|
</CodeGroup>
|