Skip to main content
GET
/
scenarios
List scenarios
curl --request GET \
  --url https://api.exec.com/rest/v1/scenarios \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.exec.com/rest/v1/scenarios"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.exec.com/rest/v1/scenarios', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.exec.com/rest/v1/scenarios",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.exec.com/rest/v1/scenarios"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.exec.com/rest/v1/scenarios")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.exec.com/rest/v1/scenarios")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "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/scenarios/discovery-call-it-director",
      "difficulty": "medium",
      "context": "The buyer is the VP of Engineering at a Series B fintech. They have an active RFP out for an observability tool and your competitor presented yesterday.",
      "objective": "Qualify the opportunity and book a follow-up meeting with the economic buyer.\n##### Outcomes to Avoid:\n- Discounting before discovery\n- Skipping the budget conversation\n- Committing to a custom integration without scoping",
      "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
  }
}
{
"error": {
"type": "invalid_request",
"code": "invalid_pagination",
"message": "Invalid pagination parameters"
}
}
{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid or inactive API key"
}
}

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

skill_ids
string

Comma-separated skill IDs to filter by

collection_ids
string

Comma-separated collection IDs to filter by

include
string

Comma-separated list of optional data to include. Available values: skills (list of skills evaluated by each scenario).

Example:

"skills"

Response

List of scenarios

data
object[]
pagination
object