Inactive Users API
Retrieve paginated list of inactive users
Reseller
Inactive Users API
Retrieve a paginated list of inactive users. Identify users who haven't been active and implement re-engagement strategies.
Inactive Users
Not currently active.
Pagination
Page through results.
Re-engagement
Target campaigns.
Endpoint Overview
QUERY
/graphqlRetrieve a paginated list of inactive users.
Authentication:Bearer Token
Required scopes:reselleradmin
Request Parameters
pageIntPage number for pagination (0-indexed).
sizeIntNumber of users per page.
GraphQL Query
query inactiveUsers($page: Int, $size: Int) {
inactiveUsers(page: $page, size: $size) {
totalElements
size
number
content {
id
email
username
enabled
createdAt
}
}
}Variables:
{
"page": 0,
"size": 20
}HTTP Request:
curl -X POST https://api.orbnet.com/graphql \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_TOKEN" \
-d '{
"query": "query inactiveUsers($page: Int, $size: Int) { inactiveUsers(page: $page, size: $size) { totalElements size number } }",
"variables": { "page": 0, "size": 20 }
}'Response
200Inactive Users Retrieved Successfully
{
"data": {
"inactiveUsers": {
"totalElements": 300,
"size": 20,
"number": 0
}
}
}Response Fields
totalElementsInt!Total number of inactive users.
sizeInt!Number of users per page.
numberInt!Current page number (0-indexed).
content[User!]!Array of inactive user objects.
Related Endpoints
Re-engagement Strategy
Use this list to identify users for re-engagement campaigns and win-back offers.
View Online Users
See which users are currently online.