This endpoint provides access to retrieve a list of users. It is designed for developers working with our system.
📌 Path & Method
- Path:
/api/v1/users
- Method:
GET
- Description: Fetches a paginated list of user resources.
📦 Request Parameters
Parameter | Type | Description |
---|---|---|
page |
int |
Page number (default: 1 , max: 100 ) |
limit |
int |
Items per page (default: 20 , max: 50 ) |
filter |
string |
Filter by user role (e.g., admin , member ) |
📈 Response Example
{
"data": [
{
"id": 1,
"name": "John Doe",
"email": "john@example.com"
}
],
"total": 150,
"page": 1,
"limit": 20
}