• 30 Minute Maintenance Window, Midnight Pacific, Sat May 19. Learn more.

View
 

Admin Users API Methods


users/list

Lists Users.

 

  GET /users.{json or xml} 

 

// Code

admin_users_list($page=1, $perpage=15) 

 

Parameters:

  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

users/search

Search through Users.

 

  POST /users/search.{json or xml} 

 

// Code

admin_users_search($search=null, $page=1, $perpage=15) 

 

Parameters:

  • search. Optional. Keywords to search for.  
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.

users/pending_list

Lists Pending Users. Pending Users require additional approval before their account is activated.

 

  GET /users/pending.{json or xml} 

 

// Code

admin_users_pending_list()


user/pending_proccess

Approve or Reject a Pending User.

 

  POST /users/#{user_id}/pending_process.{json or xml} 

 

// Code

admin_users_pending_process($user_id, $status, $message=null)

 

Parameters:

  • user_id.  Required. An User ID.
  • status. Required. "accept" or "reject"
  • message. Optional. A message that gets sent to the user with the request status.

user/destroy

Destroy a User.

 

  DELETE /users/#{user_id}.{json or xml} 

 

// Code

admin_user_destroy($user_id)

 

Parameters:

  • user_id. Required. An User ID.

users/search

Search through Users.

 

  POST /users/search.xml   

 

// Code

admin_users_search($search=null, $page=1, $perpage=15) 

 

Parameters:

  • search. Optional. Keywords to search for.  
  • page. Optional. The desired page.
  • perpage. Optional. How many items per page.