Skip to main content
GET
/
users
/
getAll
Get all users
curl --request GET \
  --url https://api.octaviatech.app/cms/users/getAll \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "statusCode": 200,
  "message": "OK",
  "data": {
    "items": [
      {
        "id": "{{objectId}}",
        "email": "editor@example.com",
        "role": 2,
        "firstName": "Jane",
        "lastName": "Editor",
        "isActive": true
      }
    ],
    "pagination": {
      "total": 1,
      "page": 1,
      "limit": 50,
      "totalPages": 1
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
page
integer
Required range: x >= 1
Example:

1

​
limit
integer
Required range: 1 <= x <= 100
Example:

50

​
keyword
string
Example:

"jane"

​
roles
string

Filter by roles (comma-separated)

Example:

"1,2"

​
isActive
boolean
Example:

true

Response

200 - application/json

OK

The response is of type any.