Skip to main content

List

Description#

Retrieve a list of stories.

Request#

HTTP Method: GET

curl -X GET \  https://<tenant-domain>/api/v1/stories \  -H 'content-type: application/json' \  -H 'x-user-email: <email-address>' \  -H 'x-user-token: <api-token>'

Response#

A successful request will return a JSON Array describing stories in the Tines tenant.

Field description#

ParameterDescription
idThe story ID.
nameThe story name.
user_idID of story owner.
descriptionA user-defined description of the story.
created_atISO 8601 Timestamp representing date and time the story was created.
updated_atISO 8601 Timestamp representing date and time the story was last updated.
keep_events_forDefined event retention period in seconds.
disabledBoolean flag indicating whether story is disabled.
priorityBoolean flag indicating whether story is hight priority story.
guidUnique identifier of the story.
team_idID of team to which the story belongs.
folder_idID of folder to which the story belongs.
send_to_story_enabledBoolean flag indicating if send to stories is enable.
send_to_story_accessControls who is allowed to send to this story.
entry_agent_idThe ID of the entry action for this story
exit_agentsAn Array of objects describing exit actions for this story.
slugAn underscored representation of the story name

Sample response#

{  "stories": [    {      "id": 7981,      "name": "Simple story",      "user_id": 167,      "description": "In the simple story we will create a fictional situation where a detection system is configured to send alerts to our Tines tenant",      "keep_events_for": 604800,      "disabled": false,      "priority": false,      "send_to_story_enabled": false,      "send_to_story_access": null,      "entry_agent_id": null,      "exit_agents": [],      "team_id": 1,      "folder_id": 1,      "guid": "df1e838a18d20696120b41516497b017",      "slug": "simple_story",      "created_at": "2021-05-10T08:56:50Z",      "updated_at": "2021-05-10T08:56:50Z"    }  ],  "meta": {    "current_page": "https://<tenant-domain>/api/v1/stories?per_page=20&page=1",    "previous_page": null,    "next_page": null,    "per_page": 20,    "pages": 1,    "count": 1  }}