people/list

Returns all the users that are part of the logged account. You can filter the results to get data on a specific person.

URL

http://api.staction.com/people/list.format

HTTP Method:

GET

Optional Parameters

All parameters on this call are optional.

  • id: use this if you only want to get data on a specific person.

Examples (using curl)

To get a list of all users on the account authenticated on the call:
  • curl -d “developerKey=123&account=paste&email=test@pasteinteractive.com&password=mypassword” http://api.staction.com/people/list.json

To get data on a specific person:

  • curl -d “developerKey=123&account=paste&email=test@pasteinteractive.com&password=mypassword” http://api.staction.com/people/list.json?id=557

Expected Responses

If the call fails to be executed properly, the API will return an error in the default error format, with a status field set to false, and a reason field explaining why it failed to run (respecting the format requested). If the call runs properly, it will return a listing of all users on the account authenticated respecting the format you requested and the parameters set on the call.

As an example, here are a couple of parsed JSON responses, transferred into a multidimensional array for the sake of clarity.

Array
(
    [0] => Array
        (
            [id] => 1
            [is_account_holder] => true
            [name] => Brian
            [email] => brian@pasteinteractive.com
            [avatar_img] => http://pasteinteractive.staction.com/upload/avatars/de2ffdd567879aa97af43235515dda51.jpg
            [week_begins_on] => Sunday
            [timezone] => America/Sao_Paulo
            [created_on] => Sat, 15 Mar 2008 01:55:41 +0000
            [last_updated] => Mon, 20 Jul 2009 20:52:30 +0000
            [last_accessed] => Wed, 26 Aug 2009 20:46:34 +0000
        )

    [1] => Array
        (
            [id] => 2
            [is_account_holder] => false
            [name] => Joe
            [email] => joe@pasteinteractive.com
            [avatar_img] => http://pasteinteractive.staction.com/upload/avatars/f905123b74c4fb87ae86d30db8962f72.jpg
            [week_begins_on] => Sunday
            [timezone] => US/Central
            [created_on] => Sat, 15 Mar 2008 01:55:41 +0000
            [last_updated] => Fri, 12 Jun 2009 17:21:16 +0000
            [last_accessed] => Sun, 26 Jul 2009 15:19:57 +0000
        )

	
)