List Users (list view)
GET/api/users
Returns a paginated list view list of users. Supports search, sort, and pagination.
Authentication: Requires Bearer token.
Query parameters:
- page — Page number (default: 1)
- limit — Results per page (default: 15)
- search — Full-text search across name and email
- sort — Sort field, prefix with - for descending (e.g., -created_at)
- archived — 0 = active users, 1 = soft-deleted users
- included[] — IDs to force-include in results
- excluded[] — IDs to exclude from results
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Content-Type
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.