Skip to main content
GET
/
scenarios
List scenarios
curl --request GET \
  --url https://api.exec.com/rest/v1/scenarios \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": "s1c2e3n4a5r6",
      "name": "Discovery Call with IT Director",
      "description": "Practice handling objections from skeptical IT buyers",
      "slug": "discovery-call-it-director",
      "url": "https://acme-corp.app.exec.com/roleplays/discovery-call-it-director",
      "difficulty": "medium",
      "language": "English",
      "visibility": "workspace",
      "owner": {
        "id": "u7v8w9x0y1z2",
        "email": "[email protected]",
        "first_name": "Jane",
        "last_name": "Smith"
      },
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-02-01T14:20:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "page_size": 50,
    "total_count": 125,
    "total_pages": 3
  }
}

Authorizations

​
Authorization
string
header
required

API key created in Settings > API.

Format: exec_live_ followed by 40 alphanumeric characters.

Query Parameters

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
page_size
integer
default:50

Number of results per page (max 100)

Required range: 1 <= x <= 100
​
owner_email
string<email>

Filter by scenario owner's email address

​
visible_to_email
string<email>

Filter by who can access the scenario (checks owner, user shares, group shares, workspace shares)

​
visibility
enum<string>

Filter by visibility scope

Available options:
private,
workspace
​
include_archived
boolean
default:false

Include archived scenarios in results

Response

List of scenarios

​
data
object[]
​
pagination
object