list-checkFeatures

The Features API allows you to manage the high-level functional requirements of a project.

The Feature Object

Field
Type
Description

id

UUID

Unique identifier for the feature.

project_id

UUID

ID of the parent project.

name

string

The name of the feature.

description

string

Detailed description of the feature.

priority

string

One of high, medium, low.

category

string

One of core, enhancement, infrastructure.

complexity

string

One of low, medium, high.

effort

string

One of xs, s, m, l, xl.

business_value

string

One of low, medium, high.

status

string

One of draft, open, in_progress, completed.

List Features

GET /crud/features

Retrieve features, optionally filtered by project.

Query Parameters

Parameter
Type
Default
Description

project_id

UUID

-

Recommended. Filter features by project.

limit

integer

100

Number of records to return.

offset

integer

0

Number of records to skip.

status

string

-

Filter by status.

priority

string

-

Filter by priority.

search

string

-

Search term for name or description.

Example Request

Get a Feature

GET /crud/features?id={featureId}

Retrieve details for a specific feature.

Query Parameters

Parameter
Type
Description

id

UUID

Required. The unique ID of the feature.

includeRelationships

boolean

If true, returns associated user stories and personas in a relationships field.

Example Request

Create a Feature

POST /crud/features

Create a new feature for a project.

Request Body

Update a Feature

PUT /crud/features

Update an existing feature. id must be passed in the request body.

Request Body

Delete a Feature

DELETE /crud/features?id={featureId}

Delete a specific feature.

Example Request

Batch Operations

The Features API supports batch creation, updates, and deletions.

Batch Create

POST /crud/features

Batch Update

PUT /crud/features

Batch Delete

DELETE /crud/features

Last updated

Was this helpful?