Skip to main content
GET
/
frontend
/
api
/
v1
/
user
List users
curl --request GET \
  --url https://{host}/frontend/api/v1/user \
  --header 'Authorization: Bearer <token>'
{
  "filter": {
    "created": {
      "from": "2024-11-21T20:27:08.392904463Z",
      "to": "2025-11-21T20:27:08.392904463Z"
    },
    "parent-id": 1,
    "updated": {
      "from": "2024-11-21T20:27:08.392904463Z",
      "to": "2025-11-21T20:27:08.392904463Z"
    },
    "user-id": [
      1
    ]
  },
  "pagination": {
    "count": 0,
    "limit": 10,
    "page": 1,
    "total": 0
  },
  "sort": {
    "field": "id",
    "order": "asc"
  },
  "users": [
    {
      "id": 1,
      "created": "2023-11-07T05:31:56Z",
      "email": "<string>",
      "first-name": "<string>",
      "last-name": "<string>",
      "role": "root",
      "status": "anonymous",
      "updated": "2023-11-07T05:31:56Z",
      "username": "<string>"
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key Security (Header).

Query Parameters

parent-id
integer
Required range: x >= 0
user-id
integer[]
Required range: x >= 0
status
enum<string>[]
Available options:
anonymous,
pending,
active,
suspended
email
string[]
email-contains
string
first-name
string
Example:

"J"

last-name
string
Example:

"Doe"

created
object
updated
object
pagination
object
sort
object

Response

OK

filter
object
pagination
object
sort
object
users
object[] | null