all

The endpoint retrieves a list of users with pagination support. It accepts a query parameter ‘page’ to specify the page number and ‘limit’ to specify the number of users per page.

The response for this request can be documented as a JSON schema as follows:

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "users": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "array",
              "items": {
                "type": "object",
                "properties": {
                  "_id": { "type": "string" },
                  "firstName": { "type": "string" },
                  "lastName": { "type": "string" },
                  "userName": { "type": "string" },
                  "email": { "type": "string" },
                  "role": { "type": "string" },
                  "createdAt": { "type": "string" },
                  "updatedAt": { "type": "string" },
                  "__v": { "type": "number" }
                }
              }
            },
            "totalDocs": { "type": "number" },
            "offset": { "type": "number" },
            "limit": { "type": "number" },
            "totalPages": { "type": "number" },
            "page": { "type": "number" },
            "pagingCounter": { "type": "number" },
            "hasPrevPage": { "type": "boolean" },
            "hasNextPage": { "type": "boolean" },
            "prevPage": { "type": ["null", "number"] },
            "nextPage": { "type": ["null", "number"] }
          }
        },
        "error": { "type": ["null", "string"] }
      }
    }
  }
}

GET /users/all

all

cURL

curl --request GET \
  --url http://localhost:8000/v1/users/all

200

{
  "data": {
    "users": {
      "docs": [
        {
          "__v": 0,
          "_id": "670e2bc28296c4aa4d13749f",
          "createdAt": "2024-10-15T08:45:54.874Z",
          "email": "[e-mail]",
          "firstName": "abebe",
          "lastName": "kebede",
          "role": "user",
          "updatedAt": "2024-10-15T08:45:54.874Z",
          "userName": "abebekeb"
        },
        {
          "__v": 0,
          "_id": "6708d54f9c193b2aeae09b80",
          "createdAt": "2024-10-11T07:35:43.468Z",
          "email": "[e-mail]",
          "firstName": "abebe",
          "lastName": "kebede",
          "role": "user",
          "updatedAt": "2024-10-11T07:35:43.468Z",
          "userName": "abebekebede1"
        }
      ],
      "hasNextPage": false,
      "hasPrevPage": false,
      "limit": 10,
      "nextPage": null,
      "offset": 0,
      "page": 1,
      "pagingCounter": 1,
      "prevPage": null,
      "totalDocs": 2,
      "totalPages": 1
    }
  },
  "error": null
}

Query Parameters

page · string

Example:

"1"

limit · string

Example:

"10"

Response

200

application/json

all - success

data · object

Show child attributes

error · unknown