Get Shared Step

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow",
  "version": 2,
  "is_shared": true,
  "created_at": "2026-03-01T10:00:00.000000+00:00",
  "created_by": "user@example.com",
  "steps_by_key": {
    "1": {
      "test_step_id": "step_1",
      "goal": "Open login screen",
      "expected_results": [
        { "expected": "login fields are visible" }
      ],
      "finish_condition": "login fields are visible",
      "screenshots": 1,
      "pause_game": false,
      "performance_monitoring": false,
      "hint_manual": []
    }
  },
  "step_order": ["1"]
}

{
  "error": "shared step not found"
}

GET

project

{projectId}

shared-steps

{sharedStepId}

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow",
  "version": 2,
  "is_shared": true,
  "created_at": "2026-03-01T10:00:00.000000+00:00",
  "created_by": "user@example.com",
  "steps_by_key": {
    "1": {
      "test_step_id": "step_1",
      "goal": "Open login screen",
      "expected_results": [
        { "expected": "login fields are visible" }
      ],
      "finish_condition": "login fields are visible",
      "screenshots": 1,
      "pause_game": false,
      "performance_monitoring": false,
      "hint_manual": []
    }
  },
  "step_order": ["1"]
}

{
  "error": "shared step not found"
}

Authentication: Any authenticated API key

Retrieve a single shared step collection, including the full body of every step.

Path Parameters

sharedStepId

string

required

The shared step collection ID

Query Parameters

version

integer

Fetch a specific version of the collection instead of the latest. Must be a positive integer.

Response

string

required

Shared step collection ID

project_id

string

required

Project the collection belongs to

name

string

required

Collection name

version

integer

required

Current version. Pass this back as expected_version when calling Update Shared Step.

is_shared

boolean

required

Always true for collections returned by this endpoint

created_at

string

ISO 8601 timestamp when the collection was created

created_by

string

Who created the collection

steps_by_key

object

required

Map of step key ("1", "2", …) → step body. Each step has the same shape used inside test cases (goal, expected_results, finish_condition, screenshots, pause_game, performance_monitoring, hint_manual). See Get Test → Verification step shape for the field details — expected_results is the structured list of checks and finish_condition is its legacy single-string rendering.

step_order

string[]

required

Ordered list of step keys

curl -X GET "https://nunu.ai/api/v1/project/your-project-id/shared-steps/ssc_login" \
  -H "X-Api-Key: YOUR_API_TOKEN"

{
  "id": "ssc_login",
  "project_id": "test",
  "name": "Login Flow",
  "version": 2,
  "is_shared": true,
  "created_at": "2026-03-01T10:00:00.000000+00:00",
  "created_by": "user@example.com",
  "steps_by_key": {
    "1": {
      "test_step_id": "step_1",
      "goal": "Open login screen",
      "expected_results": [
        { "expected": "login fields are visible" }
      ],
      "finish_condition": "login fields are visible",
      "screenshots": 1,
      "pause_game": false,
      "performance_monitoring": false,
      "hint_manual": []
    }
  },
  "step_order": ["1"]
}

{
  "error": "shared step not found"
}

Authorizations

X-Api-Key

string

header

required

API key for authentication

Path Parameters

sharedStepId

string

required

Shared step collection ID

projectId

string

required

The project ID. You can copy it from the project settings page or the project URL in the dashboard.

Query Parameters

version

integer

Specific version (positive integer)

Required range: x >= 1

Response

Successful response

string

project_id

string

name

string

version

integer

is_shared

boolean

created_at

string<date-time> | null

created_by

string | null

steps_by_key

object

step_order

string[]

List Shared Steps Create Shared Step

​Path Parameters

​Query Parameters

​Response

Authorizations

Path Parameters

Query Parameters

Response

Path Parameters

Query Parameters

Response