Stories are tasks, milestones, deliverables, or issues in Kantata OX. They belong to Workspaces, show up in the local and global task trackers, can be linked to Posts, can have sub-Stories and TaskLists, and have many attributes for planning, tasking, and financials.
This endpoint returns structured Story objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the stories
top-level JSON key.
Please see our Response Format section for more information.
active_between | string Filter for tasks that have a start or due date that is within a specified date range. Specify the date range with
a pair of colon-separated dates, in YYYY-MM-DD format. For example, |
all_on_account | boolean If you are a reports viewer or administrator, you can retrieve all stories on an account. |
archived | string Include, filter for, or exclude archived tasks (e.g. |
assigned_to_current_user | boolean If set to |
by_any_tag | string Include tasks with at least 1 of the specified tags.
Give multiple tags in a comma-separated list (e.g. |
by_custom_choice_value | string Filter by a custom field choice value, represented as a string with the custom field id, followed by a colon, and 0 to many comma separated custom field choice values IDs. The custom field choice value can also be the word 'blank'. Multiple custom field choice values IDs can be provided by separating them with a semi-colon. The filter supports the following formats:
|
by_custom_currency_value | string Filter by a custom field currency value, represented as a string with the custom field id and the currency value, separated by a colon. Optionally, the currency can be supplied, separted from the currency value with another colon. Multiple custom field currency values an be provided by separating them with a semi-colon. For example, "1:200.2:USD; 2:100". |
by_custom_date_field | string Filter for tasks with custom fields that have a date value within a specified range.
Specify the custom field ID and date range in a colon-separated string, with dates in a YYYY-MM-DD format.
For example, Give multiple custom fields with date values in a semicolon-separated list
(e.g. |
by_custom_date_value | string Filter by a custom field date value, represented as a string with the custom field id, starting date, and ending date, seperated by colons. Both a starting date and ending date can be supplied, or just one can be provided. Multiple custom field date values an be provided by separating them with a semi-colon. For example, "1:2014-12-05:2014-12-25;2:2014-12-05". |
by_custom_number_value | string Filter by a custom field number value, represented as a string with the custom field id and the number value, separated by a colon. Multiple custom field number values an be provided by separating them with a semi-colon. For example, "1:200; 2:101". |
by_custom_text_value | string Filter by a custom field text value, represented as a string with the custom field id and the text value, separated by a colon. Multiple custom field text values an be provided by separating them with a semi-colon. For example, "1:something; 2:else". |
by_status | string Filter for tasks that are in projects with the specified statuses.
Valid values are just the names of project statuses.
Give multiple statuses in a comma-separated list
(e.g. |
by_subtask_count | integer <int32> Filters for parent tasks with the specified number of subtasks. |
by_tag_name | string Include tasks with the exact tags specified.
Give multiple tags in a comma-separated list (e.g. |
by_workspace_group | string Filter for tasks in projects that belong to a Project Group (ID). Give multiple project group IDs in a comma-separated list. |
created_after | string Filter for records created after a specified datetime. |
created_before | string Filter for records created before a specified datetime. |
creators | string Filter for tasks created by the specified user (ID).
Give multiple user IDs in a comma-separated list (e.g. |
due_after | string Filter for tasks that are due after the specified date, in YYYY-MM-DD format. |
due_before | string Filter for tasks that are due before the specified date, in YYYY-MM-DD format. |
due_between | string Filter for tasks with a due date that is within a specified date range. Specify the date range with
a pair of colon-separated dates, in YYYY-MM-DD format. For example, |
due_on | string Filter for tasks that are due on the specified date, in YYYY-MM-DD format. |
exclude_workspace_title_from_search | boolean If set to |
external_reference_external_message | string Filter the objects based on the external message of their associated external references. This is an exact match. |
external_reference_external_status | string Filter by the status of the external object in the external system. |
external_reference_service_model | string Filter by the type of the external object this external reference belongs to. |
external_reference_service_model_ref | integer <int32> Filter by the id of the external object this external reference belongs to. |
external_reference_service_name | string Filter by the name of the provider for integration. |
external_reference_status | string Filter by the status of the integration, this can be successful or fail. |
has_external_references | boolean Filter by whether or not the object has external references. |
has_value_for_custom_field_ids | string Filter by the presence of a custom field value for the specified comma-separated custom field ID(s). |
include | string Any of the below associations can be included in your request by providing the
|
not_assigned_to_resource | integer <int32> Filter for tasks not assigned to the specified resource (ID). |
not_assigned_to_user | integer <int32> Filter for tasks not assigned to the specified user (ID). |
only | string Allows you to request one or more resources directly by ID. Multiple IDs can be supplied
in a comma separated list, like |
only_archived | boolean If set to |
only_deleted | boolean If set to |
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
order | string Default: "updated_at:desc" Supply Valid values: |
page | integer <int32> Default: 1 |
parents_only | boolean Filter for top-level tasks. This does not include subtasks that have other subtasks nested under them. |
per_page | integer <int32> <= 200 Default: 20 |
priority | string Filter for tasks with the specified priorities. Give multiple priorities in a comma-separated list
( |
search | string |
show_archived | boolean Default: false If set to |
show_deleted | boolean Default: false If set to |
show_from_archived_workspaces | boolean Default: false If set to |
starting_between | string Filter for tasks with a start date that is within a specified date range. Specify the date range with
a pair of colon-separated dates, in YYYY-MM-DD format. For example, |
story_type | string Include tasks of the specified type. Valid values: |
story_types | string Filter for tasks of the specified type(s). Give multiple task types in a comma-separated list. |
time_trackable_on_workspace_id | integer <int32> Filter for tasks that time can be tracked against in the specified project (ID). |
uncompleted | boolean If set to |
updated_after | string Filter for records updated after a specified datetime. |
updated_before | string Filter for records updated before a specified datetime. |
with_ancestry_depth | integer <int32> Include subtasks
that are nested at the specified level from the top-level task (e.g. |
with_assignees | string Filter for tasks assigned to the specified users. Give multiple user IDs in a comma-separated list
(e.g. In addition to user IDs, you can also pass |
with_followers | string Filter for tasks with the specified followers. Give multiple user IDs in a comma-separated list. |
with_parent_id | integer <int32> Filter for subtasks that are directly nested under the specified task (ID). |
with_projects | string Include tasks in the specified projects. Give multiple project IDs in a comma-separated list. |
with_root_id | integer <int32> Filter for subtasks that are nested at any level under the specified task (ID). |
with_start_or_due_date | string Filter for tasks with start or due dates. |
without_external_reference_service_name | string Exclude by the existence of an external reference with the specified service name. |
without_past_completed | boolean If set to |
workspace_id | integer <int32> Filter for tasks from the specified project (ID). |
A list of Stories have been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "workspace_resources": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_features": {
- "time_trackable": true,
- "has_time_entry_role_picker": true,
- "project_side_panel": true
}, - "account_id": 0,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "access_level": "string",
- "account_color_id": "string",
- "account_features": {
- "time_trackable": true,
- "has_time_entry_role_picker": true,
- "project_side_panel": true
}, - "account_id": 0,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "assignments": {
- "property1": {
- "allocated_minutes": 0,
- "assignee_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "current": true,
- "estimated_minutes": 0,
- "external_reference_ids": [
- "string"
], - "resource_id": 0,
- "story_allocation_day_ids": [
- "string"
], - "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "allocated_minutes": 0,
- "assignee_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "current": true,
- "estimated_minutes": 0,
- "external_reference_ids": [
- "string"
], - "resource_id": 0,
- "story_allocation_day_ids": [
- "string"
], - "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "story_tasks": {
- "property1": {
- "completed": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "completed_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "position": 0,
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "completed": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "completed_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "position": 0,
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "tags": {
- "property1": {
- "name": "string",
- "status": "string"
}, - "property2": {
- "name": "string",
- "status": "string"
}
}, - "story_state_changes": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "formatted_state": "string",
- "state": "string",
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "formatted_state": "string",
- "state": "string",
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "posts": {
- "property1": {
- "attachment_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "formatted_message": "string",
- "google_document_ids": [
- "string"
], - "has_attachments": true,
- "message": "string",
- "newest_reply_at": "2019-08-24T14:15:22Z",
- "newest_reply_id": "string",
- "newest_reply_user_id": "string",
- "parsed_message": "string",
- "private": true,
- "recipient_ids": [
- "string"
], - "reply": true,
- "reply_count": 0,
- "reply_ids": [
- "string"
], - "story_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_title": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": "string"
}, - "property2": {
- "attachment_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "formatted_message": "string",
- "google_document_ids": [
- "string"
], - "has_attachments": true,
- "message": "string",
- "newest_reply_at": "2019-08-24T14:15:22Z",
- "newest_reply_id": "string",
- "newest_reply_user_id": "string",
- "parsed_message": "string",
- "private": true,
- "recipient_ids": [
- "string"
], - "reply": true,
- "reply_count": 0,
- "reply_ids": [
- "string"
], - "story_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_title": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": "string"
}
}, - "attachments": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "deletable": true,
- "deleted_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "filesize": 0,
- "previewable": true,
- "proof_url": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "view_in_new_tab": true,
- "viewable": true
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "deletable": true,
- "deleted_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "filesize": 0,
- "previewable": true,
- "proof_url": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "view_in_new_tab": true,
- "viewable": true
}
}, - "proofs": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "current_revision_id": "string",
- "download_url": "string",
- "filename": "string",
- "filesize": 0,
- "has_comments": true,
- "review_status": "string",
- "review_url": "string",
- "revision_count": 0,
- "revision_date": "2019-08-24T14:15:22Z",
- "revision_ids": [
- "string"
], - "story_id": "string",
- "title": "string",
- "viewable": true
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "current_revision_id": "string",
- "download_url": "string",
- "filename": "string",
- "filesize": 0,
- "has_comments": true,
- "review_status": "string",
- "review_url": "string",
- "revision_count": 0,
- "revision_date": "2019-08-24T14:15:22Z",
- "revision_ids": [
- "string"
], - "story_id": "string",
- "title": "string",
- "viewable": true
}
}, - "story_dependencies": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "dependency_type": "string",
- "lag": 0,
- "source_id": "string",
- "target_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "dependency_type": "string",
- "lag": 0,
- "source_id": "string",
- "target_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
The maximum number of stories that can be created in a single request is 300.
This endpoint returns structured Story objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the stories
top-level JSON key.
Please see our Response Format section for more information.
Story has been created.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "story": {
- "workspace_id": 0,
- "title": "string",
- "story_type": "task",
- "description": "string",
- "start_date": "2019-08-24",
- "due_date": "2019-08-24",
- "state": "not started",
- "checklist": [
- "string"
], - "parent_id": 0,
- "archived": true,
- "assignee_ids": [
- 0
], - "assignments": {
- "role_id": 0,
- "assignee_id": 0,
- "workspace_resource_id": 0,
- "estimated_minutes": 0
}, - "budget_estimate_in_cents": 0,
- "time_estimate_in_minutes": 0,
- "tag_list": "string",
- "percentage_complete": 0,
- "fixed_fee": true,
- "billable": true,
- "weight": 0,
- "priority": "low",
- "time_trackable": true,
- "external_reference": {
- "service_name": "string",
- "service_model": "string",
- "service_model_ref": "string",
- "status": "string",
- "external_message": "string",
- "external_link": "string",
- "external_status": "string",
- "locked": true
}, - "custom_fields": [
- {
- "custom_field_id": 0,
- "value": "string"
}
], - "attachment_ids": [
- 0
]
}
}
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "workspace_resources": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_features": {
- "time_trackable": true,
- "has_time_entry_role_picker": true,
- "project_side_panel": true
}, - "account_id": 0,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "access_level": "string",
- "account_color_id": "string",
- "account_features": {
- "time_trackable": true,
- "has_time_entry_role_picker": true,
- "project_side_panel": true
}, - "account_id": 0,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [
- "string"
], - "percent_of_budget_used": 0,
- "percentage_complete": 0,
- "permissions": {
- "can_upload_files": true,
- "can_private_message": true,
- "can_join": true,
- "is_participant": true,
- "access_level": "string",
- "team_lead": true,
- "user_is_client": true,
- "can_change_price": true,
- "can_change_story_billable": true,
- "can_post": true,
- "can_edit": true,
- "restricted": true,
- "can_see_financials": true,
- "is_guest_on_project": true
}, - "possible_approver_ids": [
- "string"
], - "posts_require_privacy_decision": true,
- "price": "string",
- "price_in_cents": 0,
- "primary_counterpart_id": "string",
- "primary_maven_id": "string",
- "primary_workspace_group_id": "string",
- "provider_lead_name": "string",
- "rate_card_id": 0,
- "require_expense_approvals": true,
- "require_time_approvals": true,
- "stage": "string",
- "start_date": "2019-08-24",
- "status": {
- "color": "string",
- "key": "string",
- "message": "string"
}, - "status_report_ids": [
- "string"
], - "stories_are_fixed_fee_by_default": true,
- "target_margin": 0,
- "tasks_default_non_billable": true,
- "timesheet_submission_ids": [
- "string"
], - "title": "string",
- "total_expenses_in_cents": 0,
- "total_invoiced": "string",
- "total_minutes_approved": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "workspace_group_ids": [
- "string"
], - "workspace_invoice_preference_id": 0,
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "users": {
- "property1": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}, - "property2": {
- "abbreviated_timezone": "string",
- "account_membership_id": "string",
- "bio": "string",
- "city": "string",
- "classification": "string",
- "country": "string",
- "custom_field_value_ids": [
- "string"
], - "email_address": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "headline": "string",
- "last_site_activity": "2019-08-24T14:15:22Z",
- "photo_path": "string",
- "role_id": "string",
- "skill_ids": [
- "string"
], - "skill_membership_ids": [
- "string"
], - "state": "string",
- "website": "string",
- "work_sample_ids": [
- "string"
]
}
}, - "assignments": {
- "property1": {
- "allocated_minutes": 0,
- "assignee_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "current": true,
- "estimated_minutes": 0,
- "external_reference_ids": [
- "string"
], - "resource_id": 0,
- "story_allocation_day_ids": [
- "string"
], - "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "allocated_minutes": 0,
- "assignee_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "current": true,
- "estimated_minutes": 0,
- "external_reference_ids": [
- "string"
], - "resource_id": 0,
- "story_allocation_day_ids": [
- "string"
], - "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "story_tasks": {
- "property1": {
- "completed": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "completed_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "position": 0,
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "completed": true,
- "completed_at": "2019-08-24T14:15:22Z",
- "completed_by_id": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "name": "string",
- "position": 0,
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "tags": {
- "property1": {
- "name": "string",
- "status": "string"
}, - "property2": {
- "name": "string",
- "status": "string"
}
}, - "story_state_changes": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "formatted_state": "string",
- "state": "string",
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "formatted_state": "string",
- "state": "string",
- "story_id": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string"
}
}, - "posts": {
- "property1": {
- "attachment_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "formatted_message": "string",
- "google_document_ids": [
- "string"
], - "has_attachments": true,
- "message": "string",
- "newest_reply_at": "2019-08-24T14:15:22Z",
- "newest_reply_id": "string",
- "newest_reply_user_id": "string",
- "parsed_message": "string",
- "private": true,
- "recipient_ids": [
- "string"
], - "reply": true,
- "reply_count": 0,
- "reply_ids": [
- "string"
], - "story_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_title": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": "string"
}, - "property2": {
- "attachment_ids": [
- "string"
], - "created_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "formatted_message": "string",
- "google_document_ids": [
- "string"
], - "has_attachments": true,
- "message": "string",
- "newest_reply_at": "2019-08-24T14:15:22Z",
- "newest_reply_id": "string",
- "newest_reply_user_id": "string",
- "parsed_message": "string",
- "private": true,
- "recipient_ids": [
- "string"
], - "reply": true,
- "reply_count": 0,
- "reply_ids": [
- "string"
], - "story_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_title": "string",
- "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": "string"
}
}, - "attachments": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "deletable": true,
- "deleted_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "filesize": 0,
- "previewable": true,
- "proof_url": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "view_in_new_tab": true,
- "viewable": true
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "deletable": true,
- "deleted_at": "2019-08-24T14:15:22Z",
- "filename": "string",
- "filesize": 0,
- "previewable": true,
- "proof_url": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "url": "string",
- "view_in_new_tab": true,
- "viewable": true
}
}, - "proofs": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "current_revision_id": "string",
- "download_url": "string",
- "filename": "string",
- "filesize": 0,
- "has_comments": true,
- "review_status": "string",
- "review_url": "string",
- "revision_count": 0,
- "revision_date": "2019-08-24T14:15:22Z",
- "revision_ids": [
- "string"
], - "story_id": "string",
- "title": "string",
- "viewable": true
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "creator_name": "string",
- "current_revision_id": "string",
- "download_url": "string",
- "filename": "string",
- "filesize": 0,
- "has_comments": true,
- "review_status": "string",
- "review_url": "string",
- "revision_count": 0,
- "revision_date": "2019-08-24T14:15:22Z",
- "revision_ids": [
- "string"
], - "story_id": "string",
- "title": "string",
- "viewable": true
}
}, - "story_dependencies": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "dependency_type": "string",
- "lag": 0,
- "source_id": "string",
- "target_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "dependency_type": "string",
- "lag": 0,
- "source_id": "string",
- "target_id": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "custom_field_values": {
- "property1": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}, - "property2": {
- "account_id": 0,
- "can_edit": true,
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_id": "string",
- "custom_field_name": "string",
- "display_value": "string",
- "external_reference_ids": [
- "string"
], - "selected_choice_ids": [
- "string"
], - "setter_id": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "type": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "value": "string"
}
}, - "roles": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "deleted_at": "2019-08-24T14:15:22Z",
- "external_reference_ids": [
- "string"
], - "name": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}
}
This endpoint returns structured Story objects.
As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results
array
and will be indexed by ID in the stories
top-level JSON key.
Please see our Response Format section for more information.
include | string Any of the below associations can be included in your request by providing the
|
optional_fields | Array of strings Allows you to request one or more optional fields as an array. |
show_deleted | boolean Default: false Returns a deleted story when set to true. |
The Story has been retrieved.
Bad Request
Unauthorized request
Forbidden request
Page Not Found
Unprocessable Entity
Service is unavailable
{- "count": 0,
- "meta": {
- "count": 0,
- "page_count": 0,
- "page_number": 0,
- "page_size": 0
}, - "results": [
- {
- "key": "string",
- "id": "string"
}
], - "stories": {
- "property1": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}, - "property2": {
- "ancestor_ids": [
- "string"
], - "ancestry_depth": 0,
- "archived": true,
- "archived_editable": true,
- "assigned_role_id": "string",
- "assignee_ids": [
- "string"
], - "assignment_timestamped_at": "2019-08-24T14:15:22Z",
- "attachment_ids": [
- "string"
], - "billable": true,
- "budget_estimate_in_cents": 0,
- "budget_used_in_cents": 0,
- "can_align_time": true,
- "can_edit": true,
- "can_post": true,
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "current_assignment_ids": [
- "string"
], - "custom_field_value_ids": [
- "string"
], - "deleted_at": "2019-08-24T14:15:22Z",
- "descendant_ids": [
- "string"
], - "description": "string",
- "due_date": "2019-08-24",
- "external_reference_ids": [
- "string"
], - "fixed_fee": true,
- "follower_ids": [
- "string"
], - "formatted_description": "string",
- "google_document_ids": [
- "string"
], - "has_out_of_bounds_sads": true,
- "has_proofing_access": true,
- "invoiced_balance_in_cents": 0,
- "is_time_trackable_type": true,
- "logged_billable_time_in_minutes": 0,
- "logged_nonbillable_time_in_minutes": 0,
- "parent_id": "string",
- "parsed_description": "string",
- "percentage_complete": 0,
- "position": 0,
- "potential_workspace_resource_ids": [
- "string"
], - "potential_workspace_resources_with_unnamed_ids": [
- "string"
], - "priority": 0,
- "proof_ids": [
- "string"
], - "read_only": true,
- "render_description_markdown": true,
- "reply_ids": [
- "string"
], - "root_id": "string",
- "source_dependency_ids": [
- "string"
], - "start_date": "2019-08-24",
- "state": "string",
- "story_state_change_ids": [
- "string"
], - "story_task_ids": [
- "string"
], - "story_type": "string",
- "sub_stories_billable_time_in_minutes": 0,
- "sub_stories_budget_estimate_in_cents": 0,
- "sub_stories_budget_used_in_cents": 0,
- "sub_stories_time_estimate_in_minutes": 0,
- "sub_story_count": 0,
- "sub_story_ids": [
- "string"
], - "subtree_depth": 0,
- "tag_ids": [
- "string"
], - "target_dependency_ids": [
- "string"
], - "time_estimate_in_minutes": 0,
- "time_trackable": true,
- "title": "string",
- "uninvoiced_balance_in_cents": 0,
- "updated_at": "2019-08-24T14:15:22Z",
- "weight": 0,
- "workspace_id": "string",
- "workspace_resource_ids": [
- "string"
], - "workspace_resources_with_unnamed_ids": [
- "string"
]
}
}, - "external_references": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "external_link": "string",
- "external_message": "string",
- "external_status": "string",
- "last_synced_at": "2019-08-24T14:15:22Z",
- "locked": true,
- "service_model": "string",
- "service_model_ref": "string",
- "service_name": "string",
- "status": "string",
- "subject_id": 0,
- "subject_ref": {
- "key": "string",
- "id": "string"
}, - "subject_type": "string",
- "updated_at": "2019-08-24T14:15:22Z"
}
}, - "workspace_resources": {
- "property1": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}, - "property2": {
- "created_at": "2019-08-24T14:15:22Z",
- "custom_field_value_ids": [
- "string"
], - "display_label": "string",
- "external_reference_ids": [
- "string"
], - "full_name": "string",
- "label": "string",
- "organization_membership_id": "string",
- "participation_id": "string",
- "photo_path": "string",
- "role_id": "string",
- "role_initials": "string",
- "role_name": "string",
- "updated_at": "2019-08-24T14:15:22Z",
- "user_id": "string",
- "workspace_id": 0,
- "workspace_title": "string"
}
}, - "workspaces": {
- "property1": {
- "access_level": "string",
- "account_color_id": "string",
- "account_features": {
- "time_trackable": true,
- "has_time_entry_role_picker": true,
- "project_side_panel": true
}, - "account_id": 0,
- "approver_id": "string",
- "approver_ids": [
- "string"
], - "archived": true,
- "billable_minutes": 0,
- "budget_remaining": "string",
- "budget_used": "string",
- "budget_used_in_cents": 0,
- "budgeted": true,
- "can_create_line_items": true,
- "can_invite": true,
- "change_orders_enabled": true,
- "client_lead_name": "string",
- "client_role_name": "string",
- "consultant_role_name": "string",
- "created_at": "2019-08-24T14:15:22Z",
- "creator_id": "string",
- "currency": "string",
- "currency_base_unit": 0,
- "currency_symbol": "string",
- "current_status_report_id": "string",
- "current_user_participation_id": "string",
- "custom_field_value_ids": [
- "string"
], - "default_rate": "string",
- "description": "string",
- "due_date": "2019-08-24",
- "effective_due_date": "2019-08-24",
- "estimated_minutes": 0,
- "exclude_archived_stories_percent_complete": true,
- "expenses_in_burn_rate": true,
- "external_reference_ids": [
- "string"
], - "financial_viewer_ids": [
- "string"
], - "has_active_expense_report_submissions": true,
- "has_active_timesheet_submissions": true,
- "has_budget_access": true,
- "lock_date": "2019-08-24",
- "minutes_logged": 0,
- "next_uncompleted_milestone_id": "string",
- "non_billable_minutes": 0,
- "over_budget": true,
- "participant_ids": [
- "string"
], - "participation_ids": [