projects/list

Returns all the projects that the logged user has access to. You can filter the results to show active projects, or archived projects. You can also use this to get the data from a specific project.

URL

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

HTTP Method:

GET

Optional Parameters

All parameters on this call are optional.

  • id: use this if you want to get data on a specific project.
  • archived: boolean that indicates if you want to get the list of projects that are archived (instead of the default active listing).

Examples (using curl)

To get a list of all active projects that the logged user has access to:
  • curl -d “developerKey=123&account=paste&email=test@pasteinteractive.com&password=mypassword” http://api.staction.com/projects/list.json

To get a list of all active projects that the logged user has access to:

  • curl -d “developerKey=123&account=paste&email=test@pasteinteractive.com&password=mypassword” http://api.staction.com/projects/list.json&archived=true

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 projects respecting the format you requested and the parameters set on the call. As an example, here’s a parsed JSON response, transferred into a multidimensional array for the sake of clarity.

Array
(
    [0] => Array
        (
            [id] => 655
            [user_id] => 1
            [name] => Project 123
            [description] => 
            [is_archived] => false
            [created_on] => Mon, 29 Jun 2009 13:02:21 +0000
            [last_updated] => 
        )

    [1] => Array
        (
            [id] => 664
            [user_id] => 1
            [name] => Project 456
            [description] => 
            [is_archived] => false
            [created_on] => Mon, 29 Jun 2009 11:51:32 +0000
            [last_updated] => 
        )

    [2] => Array
        (
            [id] => 651
            [user_id] => 1
            [name] => Project 789
            [description] => 
            [is_archived] => false
            [created_on] => Mon, 29 Jun 2009 11:10:17 +0000
            [last_updated] => 
        )
)