User Stories

The User Stories API allows you to manage the granular requirements tied to specific personas and features.

The User Story Object

Field	Type	Description
id	UUID	Unique identifier for the user story.
feature_id	UUID	ID of the parent feature.
title	string	Short title of the story.
description	string	Detailed explanation of the requirement.
user_role	string	The "As a..." part of the story (default: "user").
i_want_to	string	The "I want to..." part of the story.
so_that	string	The "So that..." part of the story.
priority	string	One of high, medium, low.
status	string	draft, has_criteria, open, in_progress, completed.
estimated_effort	integer	Story points or effort estimate.

List User Stories

GET /crud/user-stories

Query Parameters

Parameter	Type	Default	Description
feature_id	UUID	-	Filter by parent feature.
project_id	UUID	-	Filter all stories in a project.
limit	integer	100	Number of records to return.
offset	integer	0	Number of records to skip.

Example Request

curl -X GET "https://vibemap.ai/api/crud/user-stories?feature_id=FEATURE_UUID" \
     -H "Authorization: Bearer YOUR_TOKEN"

Get a User Story

GET /crud/user-stories?id={storyId}

Retrieve a specific user story with its associated acceptance criteria.

Query Parameters

Parameter	Type	Description
id	UUID	Required. The unique ID of the user story.
includeCriteria	boolean	If true, returns associated acceptance criteria.

Create a User Story

POST /crud/user-stories

Request Body

{
  "feature_id": "FEATURE_UUID",
  "persona_id": "PERSONA_UUID",
  "title": "Email Login",
  "user_role": "Registered User",
  "i_want_to": "log in with my email and password",
  "so_that": "I can access my private dashboard"
}

Update a User Story

PUT /crud/user-stories

Update an existing story. id must be in the body.

Delete a User Story

DELETE /crud/user-stories?id={storyId}

Batch Operations

Supports create, update, delete operations similarly to the Features API.