All Users API
Retrieve paginated list of all users with sorting and filtering
Users
All Users API
Retrieve a paginated list of all users with optional sorting and filtering. Comprehensive user management with search capabilities.
All Users
Complete user list.
Filtering
Search and filter.
Sorting
Order results.
Endpoint Overview
QUERY
/graphqlRetrieve a paginated list of all users with sorting and filtering options.
Authentication:Bearer Token
Required scopes:admin
Request Parameters
pageIntPage number for pagination (0-indexed).
sizeIntNumber of users per page.
sortBooleanEnable sorting of results.
paramStringParameter to sort or filter by.
queryStringSearch query for filtering users.
GraphQL Query
query allUsers($sort: Boolean, $page: Int, $size: Int, $param: String, $query: String) {
allUsers(sort: $sort, page: $page, size: $size, param: $param, query: $query) {
totalElements
size
number
content {
id
email
username
role
enabled
createdAt
}
}
}Variables:
{
"sort": true,
"page": 0,
"size": 20,
"param": "email",
"query": "example.com"
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query allUsers($page: Int, $size: Int) { allUsers(page: $page, size: $size) { totalElements size number } }",
"variables": { "page": 0, "size": 20 }
}'Response
200Users Retrieved Successfully
{
"data": {
"allUsers": {
"totalElements": 500,
"size": 20,
"number": 0,
"content": [
{
"id": 1,
"email": "user@example.com",
"username": "johndoe",
"role": "user",
"enabled": true,
"createdAt": "2024-01-01T00:00:00Z"
}
]
}
}
}Response Fields
totalElementsInt!Total number of users matching criteria.
sizeInt!Number of users per page.
numberInt!Current page number (0-indexed).
content[User!]!Array of user objects.
Related Endpoints
Search Tips
Use the query parameter to search across email, username, and other user fields.
Create New User
Add a new user to the system.