Skip to Content
CapstoneDocs
Simulations

List simulations

GET
/api/simulations

The active Capstone catalog plus your company's own published assessments. Another company's private assessments are never included. Requires the simulations:read scope. 120 requests per minute per key.

Authorization

apiKey
headerAuthorizationBearer <cap_<env>_<prefix>_<secret>>

A company API key, created by the workspace owner in the Capstone employer dashboard. Shown once at creation. Format cap_live_… or cap_test_…. The test label does not create a separate data environment: requests made with either key read and write real data.

Query Parameters

page?integer
Range1 <= value
Default1
size?integer

Items per page. Values above 50 are rejected.

Range1 <= value <= 50
Default50

Response Body

A page of simulations.

application/json
  1. response

Every Company API and open-endpoint response is wrapped in this envelope.

status*boolean
statusCode*integer
timestamp*string
Formatdate-time
data*
Example Request
curl -X GET 'https://api.usecapstone.com/v1/api/simulations'
Example Response
{  "status": true,  "statusCode": 200,  "timestamp": "2026-11-08T10:42:07.512Z",  "data": {    "page": 1,    "size": 1,    "total": 1,    "totalPages": 1,    "data": [      {        "id": "8d2f6b0e-1c4a-4f5e-9a7d-2b3c4d5e6f70",        "slug": "podify-product-manager",        "name": "Podify: Product Manager",        "description": "Lead a feature launch at a music streaming company.",        "role": "Product Manager",        "level": "intermediate",        "industry": "Media & Streaming",        "source": "catalog"      }    ]  }}

About the API

Base URL, credentials, and how to use Try it on these pages.

Cancel assessment POST

Cancels an order. If the candidate has not opened their link, the invitation is withdrawn too.