1. users
Product A
  • users
    • List all users
      GET
    • Create a new user
      POST
    • Get user by ID
      GET
    • Update user
      PUT
    • Delete user
      DELETE
  • orders
    • List all orders
      GET
    • Create a new order
      POST
    • Get order by ID
      GET
    • Update order status
      PATCH
    • Cancel an order
      POST
  • Schemas
    • ErrorResponse
    • UserResponse
    • OrderResponse
    • CreateUserRequest
    • OrderItem
    • UpdateUserRequest
    • Address
    • UserListResponse
    • CreateOrderRequest
    • UpdateOrderStatusRequest
    • OrderListResponse
  1. users

List all users

Cloud Mock
https://mock.apidog.com/m1/1332245-0-default
Cloud Mock
https://mock.apidog.com/m1/1332245-0-default
GET
/users
Retrieve a paginated list of users.
Tips
Use page-size (max 100) to tune payload sizes for your client.
Combine with the status filter to list only active users.
Results are ordered by creation date, newest first.

Request

Authorization
OAuth 2.0
Authorization Code
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Authorize URL: https://account-service-test-user-pool.auth.us-east-1.amazoncognito.com/oauth2/authorize
Token URL: https://account-service-test-user-pool.auth.us-east-1.amazoncognito.com/oauth2/token
Scopes:
openid-OpenID Connect sign-in
or
Query Params

Responses

🟢200OK
application/json
Successfully retrieved user list
Headers

Bodyapplication/json

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://mock.apidog.com/m1/1332245-0-default/users?page=1&page-size=20&status=active' \
--header 'Authorization: Bearer <token>'
Response Response Example
200 - success
{
    "data": [
        {
            "userId": "usr_1a2b3c4d",
            "email": "john.doe@example.com",
            "firstName": "John",
            "lastName": "Doe",
            "status": "active",
            "createdAt": "2024-01-15T10:30:00Z"
        },
        {
            "userId": "usr_5e6f7g8h",
            "email": "jane.smith@example.com",
            "firstName": "Jane",
            "lastName": "Smith",
            "status": "active",
            "createdAt": "2024-01-16T14:20:00Z"
        }
    ],
    "pagination": {
        "page": 1,
        "pageSize": 20,
        "totalItems": 2,
        "totalPages": 1
    }
}
Modified at 2026-07-10 12:05:55
Next
Create a new user
Built with