Get All Test Plans
8 min
this endpoint retrieves all test plans for the authenticated user's company, optionally filtering by project id and active status the user must have the plan view authority to access this endpoint endpoint information url https //testinium io/testinium restapi/api/plans/lazy method get authentication required ( bearer token ) header required ( current company id \<your company id> ) request parameters parameter type required default description projectid long no null the unique id of the project to filter test plans active boolean no true whether to fetch only active test plans response the response is a list of test plans with detailed information { "id" 11695, "type" "selenium", "project id" 5876, "project name" "inticket test project", "company id" 2760, "plan name" "emergency warnings test plan", "scenarios" \[ 70024, 70026 ], "alerts" \[ { "alert type" "email", "alert sending status" "every test", "target" "atetestteam\@acibadem com", "plan id" 11695, "enabled" true, "unsubscribe link eliminated" false } ], "enabled" true, "group plan" false, "plan parallel test limit" 1, "failed test retry count" 1, "alerts enabled result" false, "project enabled" true, "test run type" "cross", "created at" "2021 09 13t05 57 43z", "updated at" "2022 07 18t14 32 32z", "created by" "acibadem", "updated by" "onurhanozcan", "xray enabled" false, "screen shot type" "yes", "video enabled" true, "test plan java parameters" \[], "performance data enabled" false, "file download path" "" }, { "id" 11706, "type" "appium", "project id" 5927, "project name" "patient online android project", "company id" 2760, "plan name" "measurements test plan", "scenarios" \[ 70043 ], "alerts" \[], "enabled" true, "group plan" false, "plan parallel test limit" 10, "failed test retry count" 0, "alerts enabled result" false, "project enabled" true, "test run type" "cross", "created at" "2021 09 13t10 49 32z", "created by" "acibadem", "updated by" "acibadem", "xray enabled" false, "screen shot type" "yes", "video enabled" true, "test plan java parameters" \[], "clear app data" false, "uninstall app after test" false }, response fields field type description id long unique id of the test plan type string the type of test plan (e g , selenium , appium ) project id long id of the associated project project name string name of the associated project company id long id of the company that owns the test plan plan name string name of the test plan scenarios array list of scenario ids linked to the test plan alerts array list of alerts associated with the test plan enabled boolean whether the test plan is enabled group plan boolean whether the test plan is a group plan plan parallel test limit integer maximum parallel tests allowed failed test retry count integer number of retries for failed tests alerts enabled result boolean whether alerts are enabled for this plan project enabled boolean whether the associated project is enabled test run type string the type of test execution (e g , cross ) created at string timestamp of when the test plan was created updated at string timestamp of when the test plan was last updated created by string username of the creator of the test plan updated by string username of the last updater of the test plan xray enabled boolean whether xray integration is enabled screen shot type string whether screenshots are taken ( yes , no ) video enabled boolean whether video recording is enabled test plan java parameters array java parameters used in the test plan performance data enabled boolean whether performance data collection is enabled file download path string file download path if applicable clear app data boolean (for mobile tests) whether app data is cleared uninstall app after test boolean (for mobile tests) whether the app is uninstalled after the test error codes http code error message description 403 access denied user lacks plan view authority 400 invalid request the request was malformed or contained invalid parameters 500 system internal error an unexpected error occurred on the server side example request curl location request get 'https //testinium io/testinium restapi/api/plans/lazy?projectid=5876\&active=true' \\ \ header 'authorization bearer \<your access token>' \\ \ header 'current company id \<your company id>'