Skip to main content

List Admins (v1)

Get all admin users with filtering.

Method & Path

GET /v1/admin/admins

Description

Retrieves a paginated list of all admin users with optional filtering by role and status.

Authentication

Required: Admin authentication with admins.manage permission.

Query Parameters

ParameterTypeRequiredDescription
pagenumberNoPage number
limitnumberNoItems per page (max: 100)
searchstringNoSearch query (email or name)
roleenumNoFilter by role
statusenumNoFilter by status

Response 200 OK

{
"admins": [
{
"id": "507f1f77bcf86cd799439011",
"email": "admin@example.com",
"role": "admin",
"status": "active"
}
],
"meta": {
"roles": ["super_admin", "admin", "support"],
"permissions": [],
"pagination": {
"page": 1,
"limit": 20,
"total": 10
}
}
}

Common Errors

  • 401 Unauthorized: Missing or invalid admin authentication token
  • 403 Forbidden: Insufficient permissions
  • 400 Bad Request: Invalid query parameters
  • 500 Internal Server Error: Server error