The Beta release of our documentation is available at:
Story State Changes in Mavenlink act as an audit trail for changes to the
state of a Story.
Story State Change objects have four readable attributes. They are:
idthe unique identifier for this story state change object
created_atthe date the story state change was recorded in Mavenlink
statethe new state of the story (started, not started, or completed)
formatted_statethe formatted version of the new state of the story (Started, Not Started, or Completed)
The story state changes endpoint provides a list of state changes for a given story.
story_id is a required parameter to retrieve story state changes for a given story.
As with all API listing actions, you can provide
page to paginate your response. You may also limit the response to one story state change using the
To list all story state changes' of a Story#10 using curl, run:
You can include story state changes' associations with the
include param. For example, to include the story and user for StoryStateChange#5, you would do the following:
In this example, our API will ensure that the returned JSON contains top-level keys called
users, where you can find associated data by inspecting the StoryStateChange's
user_id. See Object Associations to learn more. The following associations can be requested through the API:
story- when included, the
story_idwill reference the story for which the story state change belongs
user- when included, the
user_idwill reference the user for which the story state change belongs
Valid orders are:
The default order is
As with all resources, you can request either
GET /api/v1/story_state_changes.json?only=5 or
You cannot create a story state change directly. They will be created for you automatically when you set the
state of a Story.
You cannot update a story state change.
You cannot destroy a story state change.