GuidesAPI ReferenceZapier API
Scenarios

List Scenarios

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.

GET
/v1/scenarios

Authorization

bearerAuth
AuthorizationBearer <token>

Bearer token authentication for API access.

In: header

Query Parameters

page?integer

Page number for pagination

Default1
Range1 <= value
limit?integer

Number of items per page (max 100)

Default50
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

curl -X GET "https://api.sophiie.ai/v1/scenarios"
{
  "scenarios": [
    {
      "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"
    }
  ],
  "totalPages": 3,
  "currentPage": 1,
  "totalCount": 25
}
{
  "success": false,
  "message": "Invalid or expired token",
  "error": {
    "status": 401,
    "message": "Invalid or expired token"
  }
}
{
  "success": false,
  "message": "Internal server error",
  "error": {
    "status": 500,
    "message": "Internal server error"
  }
}

Get Scenario GET

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

Update Scenario PUT

Update an existing scenario. Only scenarios belonging to the organization associated with the API key can be updated.