GetUsersResponseDTO
Package: @nauth-toolkit/core
Type: DTO (Response)
Response DTO for paginated user listing with pagination metadata.
- NestJS
- Express
- Fastify
import { GetUsersResponseDTO } from '@nauth-toolkit/nestjs';
import { GetUsersResponseDTO } from '@nauth-toolkit/core';
import { GetUsersResponseDTO } from '@nauth-toolkit/core';
Properties
| Property | Type | Description |
|---|---|---|
users | UserResponseDto[] | Array of sanitized user objects |
pagination | object | Pagination metadata |
pagination.page | number | Current page number (1-indexed) |
pagination.limit | number | Records per page |
pagination.total | number | Total number of matching records |
pagination.totalPages | number | Total number of pages |
Example
{
"users": [
{
"sub": "550e8400-e29b-41d4-a716-446655440000",
"email": "user@example.com",
"username": "johndoe",
"isEmailVerified": true,
"isPhoneVerified": false,
"isActive": true,
"mfaEnabled": false,
"hasSocialAuth": true,
"socialProviders": ["google", "apple"],
"createdAt": "2024-01-01T00:00:00.000Z",
"updatedAt": "2024-01-15T12:30:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 150,
"totalPages": 8
}
}