Skip to content
Docs
Arcus
Popular questions
↑↓ to navigate↵ to selectesc to close
Book a demo

List test plans

GET/projects/{project_id}/test_plans
Base URL https://arcus.testsigma.com/api/v1

Retrieves a paginated list of test plans for a specific project.

Authenticate with your API key as a Bearer token in the Authorization header. How to authenticate →
project_idUnique identifier of the project whose test plans are listed.
page_sizeNumber of test plans to return per page. Default 10.
cursorThe page_info.next or page_info.prev value from a previous page.
sortField to sort by, such as created_at, updated_at, title, or human_id. Add a leading - for descending order, for example -created_at.
searchMatches test plans by title or human_id.
title__NEQExcludes test plans whose title matches the given value. Filters take the form field__OPERATOR=value; field=value means equals.
messageStatus message for the request.
data.test_plans[].idUnique identifier of the test plan.
data.test_plans[].human_idHuman-readable identifier of the test plan.
data.test_plans[].titleTitle of the test plan.
data.test_plans[].descriptionDescription of the test plan. Left out when empty.
data.test_plans[].statusACTIVE or COMPLETED.
data.test_plans[].start_dateStart date of the test plan as a Unix timestamp in milliseconds. 0 when not set.
data.test_plans[].end_dateEnd date of the test plan as a Unix timestamp in milliseconds. 0 when not set.
data.test_plans[].completed_atUnix timestamp, in milliseconds, of when the test plan was completed. Left out until then.
data.test_plans[].completed_byID of the user who completed the test plan. Left out until then.
data.test_plans[].project_idUnique identifier of the project.
data.test_plans[].labelsLabels on the test plan, each with id, name, createdAt, and updatedAt. Left out when there are none.
data.test_plans[].environment_idEnvironment the plan's runs use. Null means the project default.
data.test_plans[].test_runs_countNumber of test runs in the test plan.
data.test_plans[].test_cases_countNumber of test cases in the test plan.
data.test_plans[].created_atUnix timestamp, in milliseconds, of when the test plan was created.
data.test_plans[].updated_atUnix timestamp, in milliseconds, of the last update to the test plan.
page_info.page_sizeNumber of test plans on this page.
page_info.total_countTotal number of test plans that match.
page_info.nextCursor for the next page. Empty on the last page.
page_info.prevCursor for the previous page. Empty on the first page.
Request
curl -X GET \
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans' \
  -H 'Authorization: Bearer <API_KEY>' \
  -H 'Content-Type: application/json'
const response = await fetch('https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();
import requests

response = requests.get(
  'https://arcus.testsigma.com/api/v1/projects/{project_id}/test_plans',
  headers={
    'Authorization': 'Bearer <API_KEY>',
    'Content-Type': 'application/json'
  }
)
data = response.json()
Response200 OK
{
  "message": "List of Test Plans",
  "data": {
    "test_plans": [
      {
        "id": "f2a8c1d4-9e63-4b27-8a51-7c0d6e9f3b42",
        "human_id": "HCP-P-1",
        "title": "Patient Portal Regression",
        "description": "Full regression cycle for the Q2 patient portal release.",
        "status": "ACTIVE",
        "start_date": 1710374400000,
        "end_date": 1712966400000,
        "project_id": "bd57bbc6-e83e-4f09-927d-fc48b3509cdf",
        "labels": [
          {
            "id": "3ebf1ec4-f994-4f41-822a-01305e1f78c1",
            "name": "regression",
            "createdAt": 1710370000000,
            "updatedAt": 1710370000000
          }
        ],
        "environment_id": null,
        "test_runs_count": 1,
        "test_cases_count": 42,
        "created_at": 1710370000000,
        "updated_at": 1710716800000
      },
      {
        "id": "6b9d0e72-3f15-4c88-a204-8e1f5a7c2d90",
        "human_id": "HCP-P-2",
        "title": "Smoke Suite Nightly",
        "description": "Nightly smoke checks for critical patient workflows.",
        "status": "COMPLETED",
        "start_date": 1710374400000,
        "end_date": 1712966400000,
        "project_id": "bd57bbc6-e83e-4f09-927d-fc48b3509cdf",
        "environment_id": null,
        "test_runs_count": 3,
        "test_cases_count": 18,
        "created_at": 1709452800000,
        "updated_at": 1710115200000
      }
    ]
  },
  "page_info": {
    "page_size": 2,
    "total_count": 9,
    "next": "W3siZmllbGQiOiJjcmVhdGVkX2F0IiwidmFsdWUiOjE3MDk0NTI4MDAwMDAsImRpcmVjdGlvbiI6IkRFU0MifV0=",
    "prev": ""
  }
}

Was this page helpful?