Export users to CSV or PDF format with applied filters (max 10,000 users)
Query parameters
-
Export format (csv or pdf)
Values are
csvorpdf. -
Search term. For organizations (distributors, resellers, customers), searches across name, description, and all custom_data fields (vat, address, city, contact, email, phone, language, notes, etc.). For systems, also searches across ipv4_address and ipv6_address.
Minimum length is
1. -
Field to sort users by
Values are
name,email,username,created_at,updated_at,latest_login_at,organization, orstatus. -
Sort direction
Values are
ascordesc. Default value isasc. -
Filter by organization logto_id
-
Filter by user status. Supports multiple values.
- enabled: not suspended and not deleted
- suspended: suspended but not deleted
- deleted: soft-deleted
Values are
enabled,suspended, ordeleted. -
Filter by user role ID
GET
/users/export
curl \
--request GET 'https://api.your-domain.com/api/users/export?format=csv' \
--header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (400)
{
"code": 400,
"message": "validation failed",
"data": {
"type": "validation_error",
"errors": [
{
"key": "username",
"message": "required",
"value": "string"
}
]
}
}
Response examples (401)
{
"code": 401,
"message": "invalid token",
"data": {}
}
Response examples (403)
{
"code": 403,
"message": "insufficient permissions",
"data": {}
}