The major AAM release is live! For questions or concerns, visit the Release Page.
Users
About 3 min
Get User List
Get paginated list of users.
Endpoint
GET /aam/v2/users
Parameters
| Query Params | Description |
|---|---|
search | Optional. Search users by "user_login", "user_email" or "display_name". |
offset | Optional. Pagination offset. The default is 0. |
per_page | Optional. Number of results to return. The default is 10. |
role | Optional. Narrow down the list of users to specific role. |
fields | Optional. Comma-separated list of additional fields to return. The supported values are "user_login", "display_name", "user_level", "policies", "expiration", "roles", "assigned_capabilities", "all_capabilities", "status". |
Response Sample
{
"list": [
{
"id": 1,
"policies": [],
"user_login": "admin",
"display_name": "Default Administrator",
"user_level": 10,
"roles": [
"Administrator"
],
"assigned_capabilities": {
"administrator": true
},
"all_capabilities": {
"switch_themes": true,
"edit_themes": true,
"activate_plugins": true,
"edit_plugins": true,
"edit_users": true,
"edit_files": true,
"manage_options": true,
"moderate_comments": true,
"manage_categories": true,
"manage_links": true,
"upload_files": true,
"import": true,
"unfiltered_html": true,
"edit_posts": true,
"edit_others_posts": true,
"edit_published_posts": true,
"publish_posts": true,
"edit_pages": true,
"read": true,
"level_10": true,
"level_9": true,
"level_8": true,
"level_7": true,
"level_6": true,
"level_5": true,
"level_4": true,
"level_3": true,
"level_2": true,
"level_1": true,
"level_0": true,
"edit_others_pages": true,
"edit_published_pages": true,
"publish_pages": true,
"delete_pages": true,
"delete_others_pages": true,
"delete_published_pages": true,
"delete_posts": true,
"delete_others_posts": true,
"delete_published_posts": true,
"delete_private_posts": true,
"edit_private_posts": true,
"read_private_posts": true,
"delete_private_pages": true,
"edit_private_pages": true,
"read_private_pages": true,
"delete_users": true,
"create_users": true,
"unfiltered_upload": true,
"edit_dashboard": true,
"update_plugins": true,
"delete_plugins": true,
"install_plugins": true,
"update_themes": true,
"install_themes": true,
"update_core": true,
"list_users": true,
"remove_users": true,
"promote_users": true,
"edit_theme_options": true,
"delete_themes": true,
"export": true,
"manage_woocommerce": true,
"view_woocommerce_reports": true,
"edit_product": true,
"read_product": true,
"delete_product": true,
"edit_products": true,
"edit_others_products": true,
"publish_products": true,
"read_private_products": true,
"delete_products": true,
"delete_private_products": true,
"delete_published_products": true,
"delete_others_products": true,
"edit_private_products": true,
"edit_published_products": true,
"manage_product_terms": true,
"edit_product_terms": true,
"delete_product_terms": true,
"assign_product_terms": true,
"edit_shop_order": true,
"read_shop_order": true,
"delete_shop_order": true,
"edit_shop_orders": true,
"edit_others_shop_orders": true,
"publish_shop_orders": true,
"read_private_shop_orders": true,
"delete_shop_orders": true,
"delete_private_shop_orders": true,
"delete_published_shop_orders": true,
"delete_others_shop_orders": true,
"edit_private_shop_orders": true,
"edit_published_shop_orders": true,
"manage_shop_order_terms": true,
"edit_shop_order_terms": true,
"delete_shop_order_terms": true,
"assign_shop_order_terms": true,
"edit_shop_coupon": true,
"read_shop_coupon": true,
"delete_shop_coupon": true,
"edit_shop_coupons": true,
"edit_others_shop_coupons": true,
"publish_shop_coupons": true,
"read_private_shop_coupons": true,
"delete_shop_coupons": true,
"delete_private_shop_coupons": true,
"delete_published_shop_coupons": true,
"delete_others_shop_coupons": true,
"edit_private_shop_coupons": true,
"edit_published_shop_coupons": true,
"manage_shop_coupon_terms": true,
"edit_shop_coupon_terms": true,
"delete_shop_coupon_terms": true,
"assign_shop_coupon_terms": true,
"view_all_adminify_activity_logs": true,
"wpml_manage_translation_management": true,
"wpml_manage_languages": true,
"wpml_manage_theme_and_plugin_localization": true,
"wpml_manage_support": true,
"wpml_manage_woocommerce_multilingual": true,
"wpml_operate_woocommerce_multilingual": true,
"wpml_manage_media_translation": true,
"wpml_manage_navigation": true,
"wpml_manage_sticky_links": true,
"wpml_manage_string_translation": true,
"wpml_manage_translation_analytics": true,
"wpml_manage_wp_menus_sync": true,
"wpml_manage_taxonomy_translation": true,
"wpml_manage_troubleshooting": true,
"wpml_manage_translation_options": true,
"manage_translations": true,
"aam_test_6": true,
"aam_test_cap": true,
"administrator": true
},
"status": "active"
},
{
"id": 3,
"policies": [],
"user_login": "ut_editor",
"display_name": "Editor User",
"user_level": 7,
"roles": [
"Editor"
],
"assigned_capabilities": {
"editor": true,
"edit_users": true
},
"all_capabilities": {
"moderate_comments": true,
"manage_categories": true,
"manage_links": true,
"upload_files": true,
"unfiltered_html": true,
"edit_posts": true,
"edit_others_posts": true,
"edit_published_posts": true,
"publish_posts": true,
"edit_pages": true,
"read": true,
"level_7": true,
"level_6": true,
"level_5": true,
"level_4": true,
"level_3": true,
"level_2": true,
"level_1": true,
"level_0": true,
"edit_others_pages": true,
"edit_published_pages": true,
"publish_pages": true,
"delete_pages": true,
"delete_others_pages": true,
"delete_published_pages": true,
"delete_posts": true,
"delete_others_posts": true,
"delete_published_posts": true,
"delete_private_posts": true,
"edit_private_posts": true,
"read_private_posts": true,
"delete_private_pages": true,
"edit_private_pages": true,
"read_private_pages": true,
"edit_users": true,
"delete_users": true,
"create_users": true,
"list_users": true,
"remove_users": true,
"editor": true
},
"status": "active"
},
{
"id": 2,
"policies": [],
"user_login": "ut_multirole",
"display_name": "Multirole User",
"user_level": 2,
"expiration": {
"expires_at": "2025-07-21T13:00:00+00:00",
"expires_at_timestamp": 1753102800,
"trigger": {
"type": "lock"
}
},
"roles": [
"Subscriber",
"Author"
],
"assigned_capabilities": {
"subscriber": true,
"author": true
},
"all_capabilities": {
"read": true,
"level_0": true,
"aam_test_cap2": true,
"aam_test_cap3": true,
"aam_test_cap_b": false,
"upload_files": true,
"edit_posts": true,
"edit_published_posts": false,
"publish_posts": true,
"level_2": true,
"level_1": true,
"delete_posts": true,
"delete_published_posts": false,
"publish_pages": true,
"aam_test_6": true,
"subscriber": true,
"author": true
},
"status": "inactive"
}
],
"summary": {
"total_count": 3,
"filtered_count": 3
}
}
Get Single User
Get a single user by ID.
Endpoint
GET /aam/v2/user/<id>
Parameters
| Query Params | Description |
|---|---|
id | Required. Valid numeric user ID. |
fields | Optional. Comma-separated list of additional fields to return. The supported values are "user_login", "display_name", "user_level", "policies", "expiration", "roles", "assigned_capabilities", "all_capabilities", "status". |
Response Sample
{
"id": 2,
"policies": [],
"user_login": "ut_multirole",
"display_name": "Multirole User",
"user_level": 2,
"expiration": {
"expires_at": "2025-07-21T13:00:00+00:00",
"expires_at_timestamp": 1753102800,
"trigger": {
"type": "lock"
}
},
"roles": [
"Subscriber",
"Author"
],
"assigned_capabilities": {
"subscriber": true,
"author": true
},
"all_capabilities": {
"read": true,
"level_0": true,
"aam_test_cap2": true,
"aam_test_cap3": true,
"aam_test_cap_b": false,
"upload_files": true,
"edit_posts": true,
"edit_published_posts": false,
"publish_posts": true,
"level_2": true,
"level_1": true,
"delete_posts": true,
"delete_published_posts": false,
"publish_pages": true,
"aam_test_6": true,
"subscriber": true,
"author": true
},
"status": "inactive"
}
Update User
Update settings for an existing user.
Endpoint
PATCH /aam/v2/user/<id>
Parameters
| Params | Description |
|---|---|
id | Required. Valid numeric user ID. |
status | Optional. Set user's status to either "active" or "inactive". If user is inactive, they cannot login to the site anymore. |
expiration | Optional. Set user access expiration. |
add_capabilities | Optional. Array of capabilities to add to user. |
remove_capabilities | Optional. Array of capabilities to remove from user. |
fields | Optional. Comma-separated list of additional fields to return. The supported values are "user_login", "display_name", "user_level", "policies", "expiration", "roles", "assigned_capabilities", "all_capabilities", "status". |
Response Sample
{
"id": 2,
"policies": [],
"user_login": "ut_multirole",
"display_name": "Multirole User",
"user_level": 2,
"expiration": {
"expires_at": "2025-07-21T13:00:00+00:00",
"expires_at_timestamp": 1753102800,
"trigger": {
"type": "lock"
}
},
"roles": [
"Subscriber",
"Author"
],
"assigned_capabilities": {
"subscriber": true,
"author": true,
"test_capability_1": true
},
"all_capabilities": {
"read": true,
"level_0": true,
"aam_test_cap2": true,
"aam_test_cap3": true,
"aam_test_cap_b": false,
"upload_files": true,
"edit_posts": true,
"edit_published_posts": false,
"publish_posts": true,
"level_2": true,
"level_1": true,
"delete_posts": true,
"delete_published_posts": false,
"publish_pages": true,
"aam_test_6": true,
"subscriber": true,
"author": true,
"test_capability_1": true
},
"status": "inactive"
}
Reset User Settings
Reset user settings to default.
Endpoint
DELETE /aam/v2/user/<id>
Parameters
| Query Params | Description |
|---|---|
id | Required. Valid numeric user ID. |
fields | Optional. Comma-separated list of additional fields to return. The supported values are "user_login", "display_name", "user_level", "policies", "expiration", "roles", "assigned_capabilities", "all_capabilities", "status". |
Response Sample
{
"id": 2,
"policies": [],
"user_login": "ut_multirole",
"display_name": "Multirole User",
"user_level": 2,
"roles": [
"Subscriber",
"Author"
],
"assigned_capabilities": {
"subscriber": true,
"author": true,
"test_capability_1": true
},
"all_capabilities": {
"read": true,
"level_0": true,
"aam_test_cap2": true,
"aam_test_cap3": true,
"aam_test_cap_b": false,
"upload_files": true,
"edit_posts": true,
"edit_published_posts": false,
"publish_posts": true,
"level_2": true,
"level_1": true,
"delete_posts": true,
"delete_published_posts": false,
"publish_pages": true,
"aam_test_6": true,
"subscriber": true,
"author": true,
"test_capability_1": true
},
"status": "active"
}
Virtual Assistant