API Reference

Features

Manage features for your products.

Prerequisites: You need a product before creating features. See Products to get or create a product. Features are used when creating exploratory tests (see Exploratory Tests).

List features

Retrieve all features for a specific product.

Endpoint: GET /products/{product_id}/features

Parameters:

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

Example Request:

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

Response: 200 OK

1{
2  "features": [
3    {
4      "id": 1,
5      "title": "Account Management",
6      "description": "Manage your account information",
7      "howtofind": "Top right of the screen",
8      "user_stories": ["User story 1", "User story 2"]
9    }
10  ]
11}

Create feature

Create a new feature.

Endpoint: POST /features

Request Body:

  • product_id (number, required) - ID of the Product
  • section_ids (array[number], optional) - Array of section IDs
  • feature (object, required) - Feature object
    • title (string, required) - Feature title
    • description (string, required) - Feature description
    • howtofind (string, optional) - Instructions on how to find the feature
    • target_idx (string, optional) - Target index
    • user_stories (array[string], optional) - Array of user story descriptions
    • use_markdown (boolean, optional) - Whether to use markdown formatting

Example Request:

1curl -X POST "https://api.test.io/customer/v2/features" \
2  -H "Authorization: Token YOUR_API_TOKEN" \
3  -H "Content-Type: application/json" \
4  -d '{
5    "product_id": 1,
6    "section_ids": [1],
7    "feature": {
8      "title": "Account Management",
9      "description": "Manage your account information",
10      "howtofind": "Top right of the screen",
11      "user_stories": ["User story 1"],
12      "use_markdown": true
13    }
14  }'

Response: 201 Created

1{
2  "feature": {
3    "id": 15,
4    "title": "Account Management",
5    "description": "Manage your account information",
6    "howtofind": "Top right of the screen",
7    "user_stories": ["User story 1"]
8  }
9}
Previous
Products