Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fredy-rizo/ecommerce-delivery/llms.txt

Use this file to discover all available pages before exploring further.

This endpoint returns all users stored in the database, sorted by _id in descending order (newest first). Pagination is controlled through optional URL path parameters rather than query strings. The Paginate middleware computes the correct skip and limit values from those path segments before the controller runs.
This endpoint requires a valid JWT token in the Authorization header. Unauthenticated requests receive a 401 response.

​
Endpoint

POST /api/user/list-members/:pag?/:perpage?
Authentication: Required — Authorization: Bearer <token>

​
Path Parameters

​
pag
number
The page number to retrieve. Defaults to 1 when omitted. Page 1 starts at the first record (skip = 0). For pages greater than 1, the middleware computes skip = (pag - 1) * perpage.
​
perpage
number
The number of users to return per page. Defaults to 10 when omitted.

​
Request Body

The request body is optional. No filter fields are currently applied by the active controller implementation. The body may be omitted or sent as an empty JSON object.

​
Pagination Behaviour

The Paginate middleware translates path parameters into req.body properties before the controller runs:
Path parameterDefaultComputed value
pag1req.params.pag
perpage10req.body.limit
(derived)—req.body.skippag = (pag > 1 ? pag - 1 : 0) * perpage
The total number of pages is returned in the response as pagination.pags, calculated as Math.ceil(totalCount / perpage).

​
Response

​
200 — Members loaded

​
msj
string
"Cargando miembros"
​
status
boolean
true on success.
​
data
array
Array of user documents for the requested page. Each document contains all active fields stored on the user model (name, email, roles, status, address, phone_number, typeIdentification, identification, avatar, timestamps, etc.).
​
pagination
object
Pagination metadata for the current response.

​
401 — No token provided

{
  "msj": "Sin autorizacion",
  "status": false
}

​
403 — Token expired or invalid

{
  "msj": "Sesion finalizada",
  "status": false
}

​
Examples

​
Default — first page, 10 per page

curl -X POST https://your-api.com/api/user/list-members \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json"

​
Page 2, 20 items per page

curl -X POST https://your-api.com/api/user/list-members/2/20 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json"
Response: 
{
  "msj": "Cargando miembros",
  "status": true,
  "data": [
    {
      "_id": "664a1f2e9b1c4a001f2e3d44",
      "name": "Maria Lopez",
      "email": "maria@example.com",
      "roles": [{ "name": "usuario", "value": "1" }],
      "status": [{ "name": "usuario activo", "value": "1" }],
      "address": "Calle 10 #45-67",
      "phone_number": "3001234567",
      "typeIdentification": "CC",
      "identification": "1020304050",
      "avatar": [],
      "createdAt": "2024-05-19T18:00:00.000Z",
      "updatedAt": "2024-05-19T18:00:00.000Z"
    }
  ],
  "pagination": {
    "pag": "2",
    "perpage": "20",
    "pags": 5
  }
}
The pag value in the pagination response object is the raw URL path parameter string. Cast it to a number in your client if you need to perform arithmetic on it.

Build docs developers (and LLMs) love

Get started for freeTalk to us