Test Cases

Create and manage test cases for your products.

Get test case

Retrieve a specific test case by ID.

Endpoint: GET /products/{product_id}/test_cases/{test_case_id}

Parameters:

• product_id (number, required) - ID of the Product
• test_case_id (number, required) - ID of the Test Case

Example Request:

1curl -X GET "https://api.test.io/customer/v2/products/1/test_cases/123" \
2  -H "Authorization: Token YOUR_API_TOKEN"

Response: 200 OK

Returns the test case object. See the response shape in Create a bulk of test cases below.

List test cases

Returns a paginated list of visible (non-hidden) test cases for a product.

Endpoint: GET /products/{product_id}/test_cases{?page,per_page}

Parameters:

• product_id (number, required) - ID of the Product
• page (number, optional) - Page number of the result set. Default: 1
• per_page (number, optional) - Number of test cases per page. Maximum: 500. Default: 25 when page is given, 500 otherwise

Responses are always paginated and never return more than 500 test cases. A per_page above 500 is reduced to 500 rather than rejected, so read meta.per_page from the response — not the value you requested — when working out how many pages to fetch. page and per_page must both be 1 or greater; 0 or a negative number returns 400 Bad Request.

To retrieve every test case, request successive pages until an empty test_cases array comes back.

Example Request:

1curl -X GET "https://api.test.io/customer/v2/products/1/test_cases?page=1&per_page=100" \
2  -H "Authorization: Token YOUR_API_TOKEN"

Response: 200 OK

1{
2  "meta": {
3    "record_count": 600,
4    "page": 1,
5    "per_page": 100
6  },
7  "test_cases": []
8}

Response Fields:

See the test case object shape in Create a bulk of test cases below.

Create a bulk of test cases

Create multiple test cases at once.

Endpoint: POST /products/{product_id}/test_cases

Parameters:

• product_id (number, required) - ID of the Product

Request Body:

• test_cases (array[TestCase], required) - Array of test case objects

TestCase Object:

• title (string, required) - Title of the test case
• feature_id (number, required) - ID of the Feature the test case belongs to
• test_case_steps (array[Step], required) - Array of step objects
• target_idx (string, optional) - Reference of the test case in other system

Step Object:

• description (string, required) - Description of the step
• target_idx (string, optional) - Reference of the test case step in other system

Example Request:

1curl -X POST "https://api.test.io/customer/v2/products/1/test_cases" \
2  -H "Authorization: Token YOUR_API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "test_cases": [
6      {
7        "title": "Login Test",
8        "feature_id": 123,
9        "test_case_steps": [
10          {
11            "description": "Navigate to login page"
12          },
13          {
14            "description": "Enter credentials"
15          },
16          {
17            "description": "Click login"
18          }
19        ]
20      }
21    ]
22  }'

Response: 201 Created

Returns an array of created test case objects.

Update test case

Updates the top-level fields of a test case, and optionally its test case steps.

Endpoint: PUT /products/{product_id}/test_cases/{test_case_id}

Parameters:

• product_id (number, required) - ID of the Product
• test_case_id (number, required) - ID of the Test Case

All attributes must be provided inside the root object test_case. All fields are optional — only the fields you provide are updated. feature_id is not accepted by this endpoint, and top-level target_idx cannot be changed once the test case is created.

Request Body:

• title (string, optional) - Title of the test case
• requirements (string, optional) - Requirements of the test case
• test_case_steps (array[Step], optional) - Array of step objects to create, update, or remove

Step Object:

• id (number, optional) - ID of an existing step to update or remove. Omit to add a new step.
• description (string, optional) - Description of the step
• target_idx (string, optional) - Reference of the step in another system. Only used when adding a new step (no id); ignored when editing an existing step.
• _destroy (boolean, optional) - Set to true to remove the step identified by id

Example Request:

1curl -X PUT "https://api.test.io/customer/v2/products/1/test_cases/123" \
2  -H "Authorization: Token YOUR_API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "test_case": {
6      "title": "Login Test (updated)",
7      "test_case_steps": [
8        { "id": 456, "description": "Navigate to login page (updated)" },
9        { "description": "Confirm dashboard is shown", "target_idx": "ext-789" },
10        { "id": 789, "_destroy": true }
11      ]
12    }
13  }'

Response: 200 OK

Returns the updated test case object. See the response shape in Create a bulk of test cases above.

Delete test case

Deletes the specified test case from the product.

Endpoint: DELETE /products/{product_id}/test_cases/{test_case_id}

Parameters:

• product_id (number, required) - ID of the Product
• test_case_id (number, required) - ID of the Test Case

Example Request:

1curl -X DELETE "https://api.test.io/customer/v2/products/1/test_cases/123" \
2  -H "Authorization: Token YOUR_API_TOKEN"

Response: 204 No Content