Skip to main content
GET
Authentication: Any authenticated API key
Retrieve a paginated list of shared step collections for your project. Shared steps are reusable groups of test steps that can be referenced from any verification test. The response is intentionally lean (no step bodies) — fetch Get Shared Step for the full contents of a specific collection.

Query Parameters

page
integer
default:"0"
Page number (0-indexed)
page_size
integer
default:"25"
Results per page (1-100)

Response

data
SharedStepSummary[]
required
Array of shared step summary objects
pagination
object
required
Pagination metadata (page, page_size, total_count, total_pages)

SharedStepSummary Object

id
string
required
Shared step collection ID
project_id
string
required
Project the collection belongs to
name
string
required
Shared step collection name
steps_count
integer
required
Number of steps in the collection
created_at
string
ISO 8601 timestamp when the collection was created
created_by
string
Who created the collection

Authorizations

X-Api-Key
string
header
required

API key for authentication

Path Parameters

projectId
string
required

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

Query Parameters

page
integer
default:0

Page number (0-indexed)

Required range: x >= 0
page_size
integer
default:25

Results per page (1-100)

Required range: 1 <= x <= 100

Response

Successful response

data
object[]
required
pagination
object
required