GuidesAPI ReferenceZapier API
Scenarios

Get Scenario

Retrieve a single scenario by ID, including questions and outcome. Only scenarios belonging to the organization associated with the API key can be retrieved.

GET
/v1/scenarios/{scenarioId}

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Path Parameters

scenarioId?number

The unique identifier of the scenario

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/scenarios/{scenarioId}"
{  "scenario": {    "id": 42,    "name": "Pricing Inquiry",    "prompt": "When a customer asks about pricing, follow this scenario.",    "response": "I would be happy to help you with pricing information. Let me walk you through our options.",    "isActive": true,    "questions": [      {        "question": "Are you an existing customer?",        "answerOptions": [          {            "answer": "Yes",            "followUps": [              {                "question": "Can you tell me more about that?"              }            ]          }        ]      }    ],    "outcome": {      "type": "continueCall",      "property1": null,      "property2": null    },    "tradeServiceId": null,    "createdAt": "2026-01-15T10:30:00.000Z",    "updatedAt": "2026-01-20T14:00:00.000Z"  }}
{  "success": false,  "message": "Invalid or expired token",  "error": {    "status": 401,    "message": "Invalid or expired token"  }}
{  "success": false,  "message": "Not found",  "error": {    "status": 404,    "message": "Not found"  }}
{  "success": false,  "message": "Internal server error",  "error": {    "status": 500,    "message": "Internal server error"  }}

Delete Scenario DELETE

Delete an existing scenario. Only scenarios belonging to the organization associated with the API key can be deleted. This performs a soft delete.

List Scenarios GET

Retrieve a paginated list of scenarios. Returns scenario data including name, prompt, response, questions, and outcome. Results are filtered by the organization associated with the API key.