Get All Users

GET

/users

Requires authenticated session. Requires manage:user permission.

Request

Authorization

API Key

Add parameter in cookie

core.session_token

Example:

core.session_token: ********************

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

Responses

🟢200

application/json

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/users?page&limit&search&sortBy&sortOrder&emailVerified&active&secondaryEmail'

Response Example

{
    "success": true,
    "message": "string",
    "meta": {
        "page": 0,
        "limit": 0,
        "total": 0
    },
    "errors": [
        {
            "code": "string",
            "field": "string",
            "message": "string"
        }
    ],
    "result": [
        {
            "id": "string",
            "name": "string",
            "email": "string",
            "emailVerified": true,
            "secondaryEmail": "string",
            "image": "string",
            "active": true
        }
    ]
}

Modified at 2026-05-01 04:13:11

Retrieve User Summary

Create a User