{ "openapi": "3.0.3", "info": { "title": "Shortcut API", "version": "4.0", "description": "Shortcut API" }, "servers": [ { "url": "https://api.app.shortcut.com" } ], "paths": { "/api/v4/whoami": { "get": { "responses": { "200": { "$ref": "#/components/responses/Response5196924" }, "400": { "$ref": "#/components/responses/Response5196925" }, "404": { "$ref": "#/components/responses/Response5196926" }, "422": { "$ref": "#/components/responses/Response5196927" } }, "operationId": "getWhoami", "description": "Returns details about the currently-authenticated member and token authorization.", "summary": "Get Whoami" } }, "/api/v4/schemas/{schema-name}": { "get": { "parameters": [ { "in": "path", "name": "schema-name", "description": "The name of the JSON schema.", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197655" }, "400": { "$ref": "#/components/responses/Response5197656" }, "404": { "$ref": "#/components/responses/Response5197657" }, "422": { "$ref": "#/components/responses/Response5197658" } }, "operationId": "getSchema", "description": "Gets the json-schema for a route.", "summary": "Get Schema" } }, "/api/v4/{workspace-slug}/admin/tokens": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197398" }, "400": { "$ref": "#/components/responses/Response5197399" }, "404": { "$ref": "#/components/responses/Response5197400" }, "422": { "$ref": "#/components/responses/Response5197401" } }, "operationId": "listWorkspaceTokens", "description": "List Workspace Tokens returns a paginated list of all API Tokens in the Workspace. Requires admin role.", "summary": "List Workspace Tokens" } }, "/api/v4/{workspace-slug}/admin/tokens/{token-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "token-public-id", "description": "The unique ID of the Token.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197787" }, "400": { "$ref": "#/components/responses/Response5197788" }, "404": { "$ref": "#/components/responses/Response5197789" }, "422": { "$ref": "#/components/responses/Response5197790" } }, "operationId": "deleteWorkspaceToken", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Workspace Token disables an API Token in the Workspace. Requires admin role.", "summary": "Delete Workspace Token" } }, "/api/v4/{workspace-slug}/branches": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_deleted).", "required": false, "schema": { "type": "string", "enum": [ "exclude_deleted", "include_deleted" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197358" }, "400": { "$ref": "#/components/responses/Response5197359" }, "404": { "$ref": "#/components/responses/Response5197360" }, "422": { "$ref": "#/components/responses/Response5197361" } }, "operationId": "listBranches", "description": "List Branches returns a paginated list of all Branches in the Workspace that have either been associated with a Story, or used in a Pull Request that was associated with a Story.", "summary": "List Branches" } }, "/api/v4/{workspace-slug}/branches/{branch-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branch-public-id", "description": "The ID of the Branch.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197146" }, "400": { "$ref": "#/components/responses/Response5197147" }, "404": { "$ref": "#/components/responses/Response5197148" }, "422": { "$ref": "#/components/responses/Response5197149" } }, "operationId": "getBranch", "description": "Get Branch returns information about a chosen Branch.", "summary": "Get Branch" } }, "/api/v4/{workspace-slug}/branches/{branch-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branch-public-id", "description": "The ID of the Branch.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196980" }, "400": { "$ref": "#/components/responses/Response5196981" }, "404": { "$ref": "#/components/responses/Response5196982" }, "422": { "$ref": "#/components/responses/Response5196983" } }, "operationId": "listBranchStories", "description": "List Branch Stories returns a paginated list of all Stories associated with a Branch in the Workspace.", "summary": "List Branch Stories" } }, "/api/v4/{workspace-slug}/branches/{branch-public-id}/pull-requests": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "branch-public-id", "description": "The ID of the Branch.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :include_closed).", "required": false, "schema": { "type": "string", "enum": [ "exclude_closed", "include_closed" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197330" }, "400": { "$ref": "#/components/responses/Response5197331" }, "404": { "$ref": "#/components/responses/Response5197332" }, "422": { "$ref": "#/components/responses/Response5197333" } }, "operationId": "listBranchPullRequests", "description": "List Branch Pull Requests returns a paginated list of all Pull Requests associated with a Branch in the Workspace.", "summary": "List Branch Pull Requests" } }, "/api/v4/{workspace-slug}/categories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197223" }, "400": { "$ref": "#/components/responses/Response5197224" }, "404": { "$ref": "#/components/responses/Response5197225" }, "422": { "$ref": "#/components/responses/Response5197226" } }, "operationId": "listCategories", "description": "List Categories returns a paginated list of all Categories in the Workspace.", "summary": "List Categories" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197227" }, "400": { "$ref": "#/components/responses/Response5197228" }, "404": { "$ref": "#/components/responses/Response5197229" }, "422": { "$ref": "#/components/responses/Response5197230" } }, "operationId": "createCategory", "requestBody": { "$ref": "#/components/requestBodies/Body5196860" }, "description": "Create Category allows you to create a new Category in Shortcut.", "summary": "Create Category" } }, "/api/v4/{workspace-slug}/categories/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197699" }, "400": { "$ref": "#/components/responses/Response5197700" }, "404": { "$ref": "#/components/responses/Response5197701" }, "422": { "$ref": "#/components/responses/Response5197702" } }, "operationId": "bulkDeleteCategories", "requestBody": { "$ref": "#/components/requestBodies/Body5196907" }, "description": "Bulk Delete Categories deletes multiple Categories.", "summary": "Bulk Delete Categories" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197703" }, "400": { "$ref": "#/components/responses/Response5197704" }, "404": { "$ref": "#/components/responses/Response5197705" }, "422": { "$ref": "#/components/responses/Response5197706" } }, "operationId": "bulkUpdateCategories", "requestBody": { "$ref": "#/components/requestBodies/Body5196908" }, "description": "Bulk Update Categories updates multiple Categories, and returns a paginated list of the updated Categories.", "summary": "Bulk Update Categories" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197707" }, "400": { "$ref": "#/components/responses/Response5197708" }, "404": { "$ref": "#/components/responses/Response5197709" }, "422": { "$ref": "#/components/responses/Response5197710" } }, "operationId": "bulkCreateCategories", "requestBody": { "$ref": "#/components/requestBodies/Body5196909" }, "description": "Bulk Create Categories creates multiple Categories, and returns a paginated list of the created Categories.", "summary": "Bulk Create Categories" } }, "/api/v4/{workspace-slug}/categories/{category-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "category-public-id", "description": "The ID of the Category.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197451" }, "400": { "$ref": "#/components/responses/Response5197452" }, "404": { "$ref": "#/components/responses/Response5197453" }, "422": { "$ref": "#/components/responses/Response5197454" } }, "operationId": "deleteCategory", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Category removes a Category from the Workspace.", "summary": "Delete Category" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "category-public-id", "description": "The ID of the Category.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197455" }, "400": { "$ref": "#/components/responses/Response5197456" }, "404": { "$ref": "#/components/responses/Response5197457" }, "422": { "$ref": "#/components/responses/Response5197458" } }, "operationId": "getCategory", "description": "Get Category returns information about a chosen Category.", "summary": "Get Category" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "category-public-id", "description": "The ID of the Category.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197459" }, "400": { "$ref": "#/components/responses/Response5197460" }, "404": { "$ref": "#/components/responses/Response5197461" }, "422": { "$ref": "#/components/responses/Response5197462" } }, "operationId": "updateCategory", "requestBody": { "$ref": "#/components/requestBodies/Body5196881" }, "description": "Update Category allows you to modify a Category in your Shortcut Workspace.", "summary": "Update Category" } }, "/api/v4/{workspace-slug}/categories/{category-public-id}/objectives": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "category-public-id", "description": "The ID of the Category.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197090" }, "400": { "$ref": "#/components/responses/Response5197091" }, "404": { "$ref": "#/components/responses/Response5197092" }, "422": { "$ref": "#/components/responses/Response5197093" } }, "operationId": "listCategoryObjectives", "description": "List Category Objectives returns a paginated list of all Objectives associated with a Category in the Workspace.", "summary": "List Category Objectives" } }, "/api/v4/{workspace-slug}/commits": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197316" }, "400": { "$ref": "#/components/responses/Response5197317" }, "404": { "$ref": "#/components/responses/Response5197318" }, "422": { "$ref": "#/components/responses/Response5197319" } }, "operationId": "listCommits", "description": "List Commits returns a paginated list of all Commits in the Workspace that have been associated with Stories.", "summary": "List Commits" } }, "/api/v4/{workspace-slug}/commits/{commit-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commit-public-id", "description": "The ID of the Commit.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197004" }, "400": { "$ref": "#/components/responses/Response5197005" }, "404": { "$ref": "#/components/responses/Response5197006" }, "422": { "$ref": "#/components/responses/Response5197007" } }, "operationId": "getCommit", "description": "Get Commit returns information about a chosen Commit.", "summary": "Get Commit" } }, "/api/v4/{workspace-slug}/commits/{commit-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "commit-public-id", "description": "The ID of the Commit.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197463" }, "400": { "$ref": "#/components/responses/Response5197464" }, "404": { "$ref": "#/components/responses/Response5197465" }, "422": { "$ref": "#/components/responses/Response5197466" } }, "operationId": "listCommitStories", "description": "List Commit Stories returns a paginated list of all Stories associated with a Commit in the Workspace.", "summary": "List Commit Stories" } }, "/api/v4/{workspace-slug}/custom-fields": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197296" }, "400": { "$ref": "#/components/responses/Response5197297" }, "404": { "$ref": "#/components/responses/Response5197298" }, "422": { "$ref": "#/components/responses/Response5197299" } }, "operationId": "listCustomFields", "description": "List Custom Fields returns a paginated list of all Custom Fields in the Workspace.", "summary": "List Custom Fields" } }, "/api/v4/{workspace-slug}/custom-fields/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197206" }, "400": { "$ref": "#/components/responses/Response5197207" }, "404": { "$ref": "#/components/responses/Response5197208" }, "422": { "$ref": "#/components/responses/Response5197209" } }, "operationId": "bulkDeleteCustomFields", "requestBody": { "$ref": "#/components/requestBodies/Body5196857" }, "description": "Bulk Delete Custom Fields removes multiple Custom Fields from the Workspace.", "summary": "Bulk Delete Custom Fields" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197210" }, "400": { "$ref": "#/components/responses/Response5197211" }, "404": { "$ref": "#/components/responses/Response5197212" }, "422": { "$ref": "#/components/responses/Response5197213" } }, "operationId": "bulkUpdateCustomFields", "requestBody": { "$ref": "#/components/requestBodies/Body5196858" }, "description": "Bulk Update Custom Fields updates multiple Custom Fields, and returns a paginated list of the updated Custom Fields.", "summary": "Bulk Update Custom Fields" } }, "/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "custom-field-public-id", "description": "The unique ID of the Custom Field.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197045" }, "400": { "$ref": "#/components/responses/Response5197046" }, "404": { "$ref": "#/components/responses/Response5197047" }, "422": { "$ref": "#/components/responses/Response5197048" } }, "operationId": "deleteCustomField", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Custom Field removes a Custom Field from the Workspace.", "summary": "Delete Custom Field" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "custom-field-public-id", "description": "The unique ID of the Custom Field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197049" }, "400": { "$ref": "#/components/responses/Response5197050" }, "404": { "$ref": "#/components/responses/Response5197051" }, "422": { "$ref": "#/components/responses/Response5197052" } }, "operationId": "getCustomField", "description": "Get Custom Field returns information about a chosen Custom Field.", "summary": "Get Custom Field" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "custom-field-public-id", "description": "The unique ID of the Custom Field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197053" }, "400": { "$ref": "#/components/responses/Response5197054" }, "404": { "$ref": "#/components/responses/Response5197055" }, "422": { "$ref": "#/components/responses/Response5197056" } }, "operationId": "updateCustomField", "requestBody": { "$ref": "#/components/requestBodies/Body5196840" }, "description": "Update Custom Field allows you to modify a Custom Field definition in your Shortcut Workspace.", "summary": "Update Custom Field" } }, "/api/v4/{workspace-slug}/custom-fields/{custom-field-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "custom-field-public-id", "description": "The unique ID of the Custom Field.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197499" }, "400": { "$ref": "#/components/responses/Response5197500" }, "404": { "$ref": "#/components/responses/Response5197501" }, "422": { "$ref": "#/components/responses/Response5197502" } }, "operationId": "listCustomFieldStories", "description": "Returns a paginated list of all Stories that have a value set for the specified Custom Field.", "summary": "List Custom Field Stories" } }, "/api/v4/{workspace-slug}/documents": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197320" }, "400": { "$ref": "#/components/responses/Response5197321" }, "403": { "$ref": "#/components/responses/Response5197324" }, "404": { "$ref": "#/components/responses/Response5197322" }, "422": { "$ref": "#/components/responses/Response5197323" } }, "operationId": "listDocs", "description": "List Docs returns a paginated list of all accessible Docs in the Workspace.", "summary": "List Docs" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197325" }, "400": { "$ref": "#/components/responses/Response5197326" }, "403": { "$ref": "#/components/responses/Response5197329" }, "404": { "$ref": "#/components/responses/Response5197327" }, "422": { "$ref": "#/components/responses/Response5197328" } }, "operationId": "createDoc", "requestBody": { "$ref": "#/components/requestBodies/Body5196870" }, "description": "Create Doc allows you to create a new Doc in the Workspace.", "summary": "Create Doc" } }, "/api/v4/{workspace-slug}/documents/bulk": { "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197406" }, "400": { "$ref": "#/components/responses/Response5197407" }, "403": { "$ref": "#/components/responses/Response5197410" }, "404": { "$ref": "#/components/responses/Response5197408" }, "422": { "$ref": "#/components/responses/Response5197409" } }, "operationId": "bulkCreateDocs", "requestBody": { "$ref": "#/components/requestBodies/Body5196876" }, "description": "Bulk Create Docs creates multiple Docs, and returns a paginated list of the created Docs.", "summary": "Bulk Create Docs" } }, "/api/v4/{workspace-slug}/documents/{doc-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "doc-public-id", "description": "The ID of the Doc.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197032" }, "400": { "$ref": "#/components/responses/Response5197033" }, "403": { "$ref": "#/components/responses/Response5197036" }, "404": { "$ref": "#/components/responses/Response5197034" }, "422": { "$ref": "#/components/responses/Response5197035" } }, "operationId": "getDoc", "description": "Get Doc returns information about a chosen Doc. Pass content_format=markdown (default) or content_format=html to include content in the response.", "summary": "Get Doc" } }, "/api/v4/{workspace-slug}/documents/{doc-public-id}/followers": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "doc-public-id", "description": "The ID of the Doc.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197263" }, "400": { "$ref": "#/components/responses/Response5197264" }, "403": { "$ref": "#/components/responses/Response5197267" }, "404": { "$ref": "#/components/responses/Response5197265" }, "422": { "$ref": "#/components/responses/Response5197266" } }, "operationId": "listDocFollowers", "description": "List Doc Followers returns a paginated list of all Members following a Doc in the Workspace.", "summary": "List Doc Followers" } }, "/api/v4/{workspace-slug}/entity-templates": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197579" }, "400": { "$ref": "#/components/responses/Response5197580" }, "404": { "$ref": "#/components/responses/Response5197581" }, "422": { "$ref": "#/components/responses/Response5197582" } }, "operationId": "listEntityTemplates", "description": "List Entity Templates returns a paginated list of all Entity Templates in the Workspace.", "summary": "List Entity Templates" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197583" }, "400": { "$ref": "#/components/responses/Response5197584" }, "404": { "$ref": "#/components/responses/Response5197585" }, "422": { "$ref": "#/components/responses/Response5197586" } }, "operationId": "createEntityTemplate", "requestBody": { "$ref": "#/components/requestBodies/Body5196893" }, "description": "Create Entity Template creates a new Entity Template in your Shortcut Workspace.", "summary": "Create Entity Template" } }, "/api/v4/{workspace-slug}/entity-templates/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197158" }, "400": { "$ref": "#/components/responses/Response5197159" }, "404": { "$ref": "#/components/responses/Response5197160" }, "422": { "$ref": "#/components/responses/Response5197161" } }, "operationId": "bulkDeleteEntityTemplates", "requestBody": { "$ref": "#/components/requestBodies/Body5196850" }, "description": "Bulk Delete Entity Templates removes multiple Entity Templates from the Workspace.", "summary": "Bulk Delete Entity Templates" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197162" }, "400": { "$ref": "#/components/responses/Response5197163" }, "404": { "$ref": "#/components/responses/Response5197164" }, "422": { "$ref": "#/components/responses/Response5197165" } }, "operationId": "bulkUpdateEntityTemplates", "requestBody": { "$ref": "#/components/requestBodies/Body5196851" }, "description": "Bulk Update Entity Templates updates multiple Entity Templates, and returns a paginated list of the updated Entity Templates.", "summary": "Bulk Update Entity Templates" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197166" }, "400": { "$ref": "#/components/responses/Response5197167" }, "404": { "$ref": "#/components/responses/Response5197168" }, "422": { "$ref": "#/components/responses/Response5197169" } }, "operationId": "bulkCreateEntityTemplates", "requestBody": { "$ref": "#/components/requestBodies/Body5196852" }, "description": "Bulk Create Entity Templates creates multiple Entity Templates, and returns a paginated list of the created Entity Templates.", "summary": "Bulk Create Entity Templates" } }, "/api/v4/{workspace-slug}/entity-templates/{entity-template-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "entity-template-public-id", "description": "The unique ID of the entity template.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5196964" }, "400": { "$ref": "#/components/responses/Response5196965" }, "404": { "$ref": "#/components/responses/Response5196966" }, "422": { "$ref": "#/components/responses/Response5196967" } }, "operationId": "deleteEntityTemplate", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Entity Template removes an Entity Template from the Workspace.", "summary": "Delete Entity Template" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "entity-template-public-id", "description": "The unique ID of the entity template.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196968" }, "400": { "$ref": "#/components/responses/Response5196969" }, "404": { "$ref": "#/components/responses/Response5196970" }, "422": { "$ref": "#/components/responses/Response5196971" } }, "operationId": "getEntityTemplate", "description": "Get Entity Template returns information about a given Entity Template.", "summary": "Get Entity Template" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "entity-template-public-id", "description": "The unique ID of the entity template.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196972" }, "400": { "$ref": "#/components/responses/Response5196973" }, "404": { "$ref": "#/components/responses/Response5196974" }, "422": { "$ref": "#/components/responses/Response5196975" } }, "operationId": "updateEntityTemplate", "requestBody": { "$ref": "#/components/requestBodies/Body5196834" }, "description": "Update Entity Template updates an existing Entity Template in your Shortcut Workspace.", "summary": "Update Entity Template" } }, "/api/v4/{workspace-slug}/epic-workflow": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197338" }, "400": { "$ref": "#/components/responses/Response5197339" }, "404": { "$ref": "#/components/responses/Response5197340" }, "422": { "$ref": "#/components/responses/Response5197341" } }, "operationId": "getEpicWorkflow", "description": "Returns the Epic Workflow configuration for the Workspace.", "summary": "Get Epic Workflow" } }, "/api/v4/{workspace-slug}/epic-workflow/states": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197142" }, "400": { "$ref": "#/components/responses/Response5197143" }, "404": { "$ref": "#/components/responses/Response5197144" }, "422": { "$ref": "#/components/responses/Response5197145" } }, "operationId": "listEpicWorkflowStates", "description": "Returns a paginated list of all Epic States in the Workspace's Epic Workflow.", "summary": "List Epic Workflow States" } }, "/api/v4/{workspace-slug}/epics": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197126" }, "400": { "$ref": "#/components/responses/Response5197127" }, "404": { "$ref": "#/components/responses/Response5197128" }, "422": { "$ref": "#/components/responses/Response5197129" } }, "operationId": "listEpics", "description": "List Epics returns a paginated list of all Epics in the Workspace.", "summary": "List Epics" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197130" }, "400": { "$ref": "#/components/responses/Response5197131" }, "404": { "$ref": "#/components/responses/Response5197132" }, "422": { "$ref": "#/components/responses/Response5197133" } }, "operationId": "createEpic", "requestBody": { "$ref": "#/components/requestBodies/Body5196849" }, "description": "Create Epic is used to create a new Epic in your Shortcut Workspace.", "summary": "Create Epic" } }, "/api/v4/{workspace-slug}/epics/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "description": "Forces deletion of the Epics, overriding the check that they are archived.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197178" }, "400": { "$ref": "#/components/responses/Response5197179" }, "404": { "$ref": "#/components/responses/Response5197180" }, "422": { "$ref": "#/components/responses/Response5197181" } }, "operationId": "bulkDeleteEpics", "requestBody": { "$ref": "#/components/requestBodies/Body5196853" }, "description": "Bulk Delete Epics deletes multiple Epics. The Epics must be archived unless `force` is set.", "summary": "Bulk Delete Epics" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197182" }, "400": { "$ref": "#/components/responses/Response5197183" }, "404": { "$ref": "#/components/responses/Response5197184" }, "422": { "$ref": "#/components/responses/Response5197185" } }, "operationId": "bulkUpdateEpics", "requestBody": { "$ref": "#/components/requestBodies/Body5196854" }, "description": "Bulk Update Epics updates multiple Epics, and returns a paginated list of the updated Epics.", "summary": "Bulk Update Epics" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197186" }, "400": { "$ref": "#/components/responses/Response5197187" }, "404": { "$ref": "#/components/responses/Response5197188" }, "422": { "$ref": "#/components/responses/Response5197189" } }, "operationId": "bulkCreateEpics", "requestBody": { "$ref": "#/components/requestBodies/Body5196855" }, "description": "Bulk Create Epics creates multiple Epics, and returns a paginated list of the created Epics.", "summary": "Bulk Create Epics" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "force", "description": "Forces deletion of the Epic, overriding the check that it is archived.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197503" }, "400": { "$ref": "#/components/responses/Response5197504" }, "404": { "$ref": "#/components/responses/Response5197505" }, "422": { "$ref": "#/components/responses/Response5197506" } }, "operationId": "deleteEpic", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Epic removes an Epic from the Workspace. The Epic must be archived unless `force` is set.", "summary": "Delete Epic" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197507" }, "400": { "$ref": "#/components/responses/Response5197508" }, "404": { "$ref": "#/components/responses/Response5197509" }, "422": { "$ref": "#/components/responses/Response5197510" } }, "operationId": "getEpic", "description": "Get Epic returns information about a chosen Epic.", "summary": "Get Epic" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197511" }, "400": { "$ref": "#/components/responses/Response5197512" }, "404": { "$ref": "#/components/responses/Response5197513" }, "422": { "$ref": "#/components/responses/Response5197514" } }, "operationId": "updateEpic", "requestBody": { "$ref": "#/components/requestBodies/Body5196885" }, "description": "Update Epic is used to modify an Epic in your Shortcut Workspace.", "summary": "Update Epic" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197427" }, "400": { "$ref": "#/components/responses/Response5197428" }, "404": { "$ref": "#/components/responses/Response5197429" }, "422": { "$ref": "#/components/responses/Response5197430" } }, "operationId": "listEpicTeams", "description": "List Epic Teams returns a paginated list of all Teams associated with an Epic in the Workspace.", "summary": "List Epic Teams" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/labels": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197839" }, "400": { "$ref": "#/components/responses/Response5197840" }, "404": { "$ref": "#/components/responses/Response5197841" }, "422": { "$ref": "#/components/responses/Response5197842" } }, "operationId": "listEpicLabels", "description": "List Epic Labels returns a paginated list of all Labels for an Epic in the Workspace.", "summary": "List Epic Labels" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/owners": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197342" }, "400": { "$ref": "#/components/responses/Response5197343" }, "404": { "$ref": "#/components/responses/Response5197344" }, "422": { "$ref": "#/components/responses/Response5197345" } }, "operationId": "listEpicOwners", "description": "List Epic Owners returns a paginated list of all Members who own an Epic in the Workspace.", "summary": "List Epic Owners" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197443" }, "400": { "$ref": "#/components/responses/Response5197444" }, "404": { "$ref": "#/components/responses/Response5197445" }, "422": { "$ref": "#/components/responses/Response5197446" } }, "operationId": "listEpicStories", "description": "List Epic Stories returns a paginated list of all Stories associated with an Epic in the Workspace.", "summary": "List Epic Stories" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "ids", "description": "A comma-separated list of ids. If included, only those entities will be considered for listing.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197799" }, "400": { "$ref": "#/components/responses/Response5197800" }, "404": { "$ref": "#/components/responses/Response5197801" }, "422": { "$ref": "#/components/responses/Response5197802" } }, "operationId": "listEpicComments", "description": "List Epic Comments returns a paginated list of all Comments for an Epic in the Workspace. Note that deleted comments will also be returned, but will have minimal information. The deleted comments are included as they may be parents to other comments.", "summary": "List Epic Comments" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197803" }, "400": { "$ref": "#/components/responses/Response5197804" }, "404": { "$ref": "#/components/responses/Response5197805" }, "422": { "$ref": "#/components/responses/Response5197806" } }, "operationId": "createEpicComment", "requestBody": { "$ref": "#/components/requestBodies/Body5196917" }, "description": "Create Epic Comment is used to add a new Comment to an Epic. To reply to an existing Comment, provide a parent_comment_id.", "summary": "Create Epic Comment" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/followers": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197114" }, "400": { "$ref": "#/components/responses/Response5197115" }, "404": { "$ref": "#/components/responses/Response5197116" }, "422": { "$ref": "#/components/responses/Response5197117" } }, "operationId": "listEpicFollowers", "description": "List Epic Followers returns a paginated list of all Members who are following an Epic in the Workspace.", "summary": "List Epic Followers" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/objectives": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197627" }, "400": { "$ref": "#/components/responses/Response5197628" }, "404": { "$ref": "#/components/responses/Response5197629" }, "422": { "$ref": "#/components/responses/Response5197630" } }, "operationId": "listEpicObjectives", "description": "List Epic Objectives returns a paginated list of all Objectives associated with an Epic in the Workspace.", "summary": "List Epic Objectives" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/epic-healths": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197284" }, "400": { "$ref": "#/components/responses/Response5197285" }, "404": { "$ref": "#/components/responses/Response5197286" }, "422": { "$ref": "#/components/responses/Response5197287" } }, "operationId": "listEpicHealths", "description": "Returns a paginated list of Health updates for the specified Epic.", "summary": "List Epic Healths" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197288" }, "400": { "$ref": "#/components/responses/Response5197289" }, "404": { "$ref": "#/components/responses/Response5197290" }, "422": { "$ref": "#/components/responses/Response5197291" } }, "operationId": "createEpicHealth", "requestBody": { "$ref": "#/components/requestBodies/Body5196867" }, "description": "Creates a new Health update for the specified Epic.", "summary": "Create Epic Health" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197643" }, "400": { "$ref": "#/components/responses/Response5197644" }, "404": { "$ref": "#/components/responses/Response5197645" }, "422": { "$ref": "#/components/responses/Response5197646" } }, "operationId": "bulkDeleteEpicComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196900" }, "description": "Bulk Delete Epic Comments deletes multiple Comments from an Epic.", "summary": "Bulk Delete Epic Comments" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197647" }, "400": { "$ref": "#/components/responses/Response5197648" }, "404": { "$ref": "#/components/responses/Response5197649" }, "422": { "$ref": "#/components/responses/Response5197650" } }, "operationId": "bulkUpdateEpicComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196901" }, "description": "Bulk Update Epic Comments updates multiple Comments on an Epic, and returns a paginated list of the updated Comments.", "summary": "Bulk Update Epic Comments" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197651" }, "400": { "$ref": "#/components/responses/Response5197652" }, "404": { "$ref": "#/components/responses/Response5197653" }, "422": { "$ref": "#/components/responses/Response5197654" } }, "operationId": "bulkCreateEpicComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196902" }, "description": "Bulk Create Epic Comments creates multiple Comments on an Epic, and returns a paginated list of the created Comments.", "summary": "Bulk Create Epic Comments" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197334" }, "400": { "$ref": "#/components/responses/Response5197335" }, "404": { "$ref": "#/components/responses/Response5197336" }, "422": { "$ref": "#/components/responses/Response5197337" } }, "operationId": "listEpicMentionedTeams", "description": "List Epic Mentioned Teams returns a paginated list of all Teams mentioned in an Epic in the Workspace.", "summary": "List Epic Mentioned Teams" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197280" }, "400": { "$ref": "#/components/responses/Response5197281" }, "404": { "$ref": "#/components/responses/Response5197282" }, "422": { "$ref": "#/components/responses/Response5197283" } }, "operationId": "listEpicMentionedMembers", "description": "List Epic Mentioned Members returns a paginated list of all Members mentioned in an Epic in the Workspace.", "summary": "List Epic Mentioned Members" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197555" }, "400": { "$ref": "#/components/responses/Response5197556" }, "404": { "$ref": "#/components/responses/Response5197557" }, "422": { "$ref": "#/components/responses/Response5197558" } }, "operationId": "deleteEpicComment", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete a Comment from an Epic.", "summary": "Delete Epic Comment" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197559" }, "400": { "$ref": "#/components/responses/Response5197560" }, "404": { "$ref": "#/components/responses/Response5197561" }, "422": { "$ref": "#/components/responses/Response5197562" } }, "operationId": "getEpicComment", "description": "Get Epic Comment returns information about a chosen Epic Comment.", "summary": "Get Epic Comment" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197563" }, "400": { "$ref": "#/components/responses/Response5197564" }, "404": { "$ref": "#/components/responses/Response5197565" }, "422": { "$ref": "#/components/responses/Response5197566" } }, "operationId": "updateEpicComment", "requestBody": { "$ref": "#/components/requestBodies/Body5196891" }, "description": "Update Epic Comment is used to modify an existing Epic Comment.", "summary": "Update Epic Comment" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/epic-healths/{epic-health-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "epic-health-public-id", "description": "The unique ID of the Health.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197807" }, "400": { "$ref": "#/components/responses/Response5197808" }, "404": { "$ref": "#/components/responses/Response5197809" }, "422": { "$ref": "#/components/responses/Response5197810" } }, "operationId": "getEpicHealth", "description": "Returns a Health for the specified Epic.", "summary": "Get Epic Health" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/comments": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197631" }, "400": { "$ref": "#/components/responses/Response5197632" }, "404": { "$ref": "#/components/responses/Response5197633" }, "422": { "$ref": "#/components/responses/Response5197634" } }, "operationId": "listEpicCommentComments", "description": "List Epic Comment Comments returns a paginated list of all threaded reply Comments for an Epic Comment in the Workspace.", "summary": "List Epic Comment Comments" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196952" }, "400": { "$ref": "#/components/responses/Response5196953" }, "404": { "$ref": "#/components/responses/Response5196954" }, "422": { "$ref": "#/components/responses/Response5196955" } }, "operationId": "listEpicCommentMentionedTeams", "description": "List Epic Comment Mentioned Teams returns a paginated list of all Teams mentioned in an Epic Comment in the Workspace.", "summary": "List Epic Comment Mentioned Teams" } }, "/api/v4/{workspace-slug}/epics/{epic-public-id}/comments/{comment-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "epic-public-id", "description": "The ID of the Epic.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197366" }, "400": { "$ref": "#/components/responses/Response5197367" }, "404": { "$ref": "#/components/responses/Response5197368" }, "422": { "$ref": "#/components/responses/Response5197369" } }, "operationId": "listEpicCommentMentionedMembers", "description": "List Epic Comment Mentioned Members returns a paginated list of all Members mentioned in an Epic Comment in the Workspace.", "summary": "List Epic Comment Mentioned Members" } }, "/api/v4/{workspace-slug}/files": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197587" }, "400": { "$ref": "#/components/responses/Response5197588" }, "404": { "$ref": "#/components/responses/Response5197589" }, "422": { "$ref": "#/components/responses/Response5197590" } }, "operationId": "listFiles", "description": "List Files returns a paginated list of all Files in the Workspace.", "summary": "List Files" }, "post": { "responses": { "201": { "$ref": "#/components/responses/Response5197591" }, "400": { "$ref": "#/components/responses/Response5197592" }, "404": { "$ref": "#/components/responses/Response5197593" }, "422": { "$ref": "#/components/responses/Response5197594" } }, "operationId": "uploadFiles", "requestBody": { "$ref": "#/components/requestBodies/Body5196894" }, "description": "Upload Files uploads one or more files and optionally associates them with a Story.\n Use the multipart/form-data content-type to upload.\n Each `file` key should contain a separate file.", "summary": "Upload Files" } }, "/api/v4/{workspace-slug}/files/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197419" }, "400": { "$ref": "#/components/responses/Response5197420" }, "404": { "$ref": "#/components/responses/Response5197421" }, "422": { "$ref": "#/components/responses/Response5197422" } }, "operationId": "bulkDeleteFiles", "requestBody": { "$ref": "#/components/requestBodies/Body5196878" }, "description": "Bulk Delete Files deletes multiple Files from the Workspace.", "summary": "Bulk Delete Files" } }, "/api/v4/{workspace-slug}/files/{file-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file-public-id", "description": "The ID of the File.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197687" }, "400": { "$ref": "#/components/responses/Response5197688" }, "404": { "$ref": "#/components/responses/Response5197689" }, "422": { "$ref": "#/components/responses/Response5197690" } }, "operationId": "deleteFile", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete File removes a previously uploaded File from the Workspace.", "summary": "Delete File" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file-public-id", "description": "The ID of the File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197691" }, "400": { "$ref": "#/components/responses/Response5197692" }, "404": { "$ref": "#/components/responses/Response5197693" }, "422": { "$ref": "#/components/responses/Response5197694" } }, "operationId": "getFile", "description": "Get File returns information about the chosen File.", "summary": "Get File" } }, "/api/v4/{workspace-slug}/files/{file-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file-public-id", "description": "The ID of the File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197843" }, "400": { "$ref": "#/components/responses/Response5197844" }, "404": { "$ref": "#/components/responses/Response5197845" }, "422": { "$ref": "#/components/responses/Response5197846" } }, "operationId": "listFileStories", "description": "List File Stories returns a paginated list of all Stories associated with a File in the Workspace.", "summary": "List File Stories" } }, "/api/v4/{workspace-slug}/files/{file-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file-public-id", "description": "The ID of the File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197423" }, "400": { "$ref": "#/components/responses/Response5197424" }, "404": { "$ref": "#/components/responses/Response5197425" }, "422": { "$ref": "#/components/responses/Response5197426" } }, "operationId": "listFileMentionedTeams", "description": "List File Mentioned Teams returns a paginated list of all Teams mentioned in a File in the Workspace.", "summary": "List File Mentioned Teams" } }, "/api/v4/{workspace-slug}/files/{file-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "file-public-id", "description": "The ID of the File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197659" }, "400": { "$ref": "#/components/responses/Response5197660" }, "404": { "$ref": "#/components/responses/Response5197661" }, "422": { "$ref": "#/components/responses/Response5197662" } }, "operationId": "listFileMentionedMembers", "description": "List File Mentioned Members returns a paginated list of all Members mentioned in a File in the Workspace.", "summary": "List File Mentioned Members" } }, "/api/v4/{workspace-slug}/iterations": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "start_date" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196984" }, "400": { "$ref": "#/components/responses/Response5196985" }, "404": { "$ref": "#/components/responses/Response5196986" }, "422": { "$ref": "#/components/responses/Response5196987" } }, "operationId": "listIterations", "description": "List Iterations returns a paginated list of all Iterations in the Workspace.", "summary": "List Iterations" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5196988" }, "400": { "$ref": "#/components/responses/Response5196989" }, "404": { "$ref": "#/components/responses/Response5196990" }, "422": { "$ref": "#/components/responses/Response5196991" } }, "operationId": "createIteration", "requestBody": { "$ref": "#/components/requestBodies/Body5196835" }, "description": "Create Iteration is used to create a new Iteration in your Shortcut Workspace.", "summary": "Create Iteration" } }, "/api/v4/{workspace-slug}/iterations/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197663" }, "400": { "$ref": "#/components/responses/Response5197664" }, "404": { "$ref": "#/components/responses/Response5197665" }, "422": { "$ref": "#/components/responses/Response5197666" } }, "operationId": "bulkDeleteIterations", "requestBody": { "$ref": "#/components/requestBodies/Body5196903" }, "description": "Bulk Delete Iterations deletes multiple Iterations.", "summary": "Bulk Delete Iterations" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "start_date" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197667" }, "400": { "$ref": "#/components/responses/Response5197668" }, "404": { "$ref": "#/components/responses/Response5197669" }, "422": { "$ref": "#/components/responses/Response5197670" } }, "operationId": "bulkUpdateIterations", "requestBody": { "$ref": "#/components/requestBodies/Body5196904" }, "description": "Bulk Update Iterations updates multiple Iterations, and returns a paginated list of the updated Iterations.", "summary": "Bulk Update Iterations" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "start_date" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197671" }, "400": { "$ref": "#/components/responses/Response5197672" }, "404": { "$ref": "#/components/responses/Response5197673" }, "422": { "$ref": "#/components/responses/Response5197674" } }, "operationId": "bulkCreateIterations", "requestBody": { "$ref": "#/components/requestBodies/Body5196905" }, "description": "Bulk Create Iterations creates multiple Iterations, and returns a paginated list of the created Iterations.", "summary": "Bulk Create Iterations" } }, "/api/v4/{workspace-slug}/iterations/current": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "start_date" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197619" }, "400": { "$ref": "#/components/responses/Response5197620" }, "404": { "$ref": "#/components/responses/Response5197621" }, "422": { "$ref": "#/components/responses/Response5197622" } }, "operationId": "getCurrentIterations", "description": "Returns all currently started iterations for the authenticated user based on their team memberships. The 'current' iterations are determined by finding started iterations associated with teams the user belongs to. If multiple iterations match, all are returned sorted by start date (ascending), then end date (ascending), then ID (ascending).", "summary": "Get Current Iterations" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197543" }, "400": { "$ref": "#/components/responses/Response5197544" }, "404": { "$ref": "#/components/responses/Response5197545" }, "422": { "$ref": "#/components/responses/Response5197546" } }, "operationId": "deleteIteration", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Iteration removes an Iteration from the Workspace.", "summary": "Delete Iteration" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197547" }, "400": { "$ref": "#/components/responses/Response5197548" }, "404": { "$ref": "#/components/responses/Response5197549" }, "422": { "$ref": "#/components/responses/Response5197550" } }, "operationId": "getIteration", "description": "Get Iteration returns information about a chosen Iteration.", "summary": "Get Iteration" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197551" }, "400": { "$ref": "#/components/responses/Response5197552" }, "404": { "$ref": "#/components/responses/Response5197553" }, "422": { "$ref": "#/components/responses/Response5197554" } }, "operationId": "updateIteration", "requestBody": { "$ref": "#/components/requestBodies/Body5196889" }, "description": "Update Iteration is used to modify an Iteration in your Shortcut Workspace.", "summary": "Update Iteration" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197074" }, "400": { "$ref": "#/components/responses/Response5197075" }, "404": { "$ref": "#/components/responses/Response5197076" }, "422": { "$ref": "#/components/responses/Response5197077" } }, "operationId": "listIterationTeams", "description": "List Iteration Teams returns a paginated list of all Teams directly associated with an Iteration in the Workspace.", "summary": "List Iteration Teams" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/labels": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197390" }, "400": { "$ref": "#/components/responses/Response5197391" }, "404": { "$ref": "#/components/responses/Response5197392" }, "422": { "$ref": "#/components/responses/Response5197393" } }, "operationId": "listIterationLabels", "description": "List Iteration Labels returns a paginated list of all Labels for an Iteration in the Workspace.", "summary": "List Iteration Labels" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197467" }, "400": { "$ref": "#/components/responses/Response5197468" }, "404": { "$ref": "#/components/responses/Response5197469" }, "422": { "$ref": "#/components/responses/Response5197470" } }, "operationId": "listIterationStories", "description": "List Iteration Stories returns a paginated list of all Stories in an Iteration in the Workspace.", "summary": "List Iteration Stories" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/followers": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197675" }, "400": { "$ref": "#/components/responses/Response5197676" }, "404": { "$ref": "#/components/responses/Response5197677" }, "422": { "$ref": "#/components/responses/Response5197678" } }, "operationId": "listIterationFollowers", "description": "List Iteration Followers returns a paginated list of all Members who are following an Iteration in the Workspace.", "summary": "List Iteration Followers" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197028" }, "400": { "$ref": "#/components/responses/Response5197029" }, "404": { "$ref": "#/components/responses/Response5197030" }, "422": { "$ref": "#/components/responses/Response5197031" } }, "operationId": "listIterationMentionedTeams", "description": "List Iteration Mentioned Teams returns a paginated list of all Teams mentioned in an Iteration in the Workspace.", "summary": "List Iteration Mentioned Teams" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/associated-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197683" }, "400": { "$ref": "#/components/responses/Response5197684" }, "404": { "$ref": "#/components/responses/Response5197685" }, "422": { "$ref": "#/components/responses/Response5197686" } }, "operationId": "listIterationAssociatedTeams", "description": "List Iteration Associated Teams returns a paginated list of all Teams that own Stories in an Iteration but are not directly associated with the Iteration.", "summary": "List Iteration Associated Teams" } }, "/api/v4/{workspace-slug}/iterations/{iteration-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "iteration-public-id", "description": "The unique ID of the Iteration.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197623" }, "400": { "$ref": "#/components/responses/Response5197624" }, "404": { "$ref": "#/components/responses/Response5197625" }, "422": { "$ref": "#/components/responses/Response5197626" } }, "operationId": "listIterationMentionedMembers", "description": "List Iteration Mentioned Members returns a paginated list of all Members mentioned in an Iteration in the Workspace.", "summary": "List Iteration Mentioned Members" } }, "/api/v4/{workspace-slug}/key-results": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197134" }, "400": { "$ref": "#/components/responses/Response5197135" }, "404": { "$ref": "#/components/responses/Response5197136" }, "422": { "$ref": "#/components/responses/Response5197137" } }, "operationId": "listKeyResults", "description": "Returns a paginated list of all Key Results in the Workspace.", "summary": "List Key Results" } }, "/api/v4/{workspace-slug}/key-results/{key-result-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key-result-public-id", "description": "The unique ID of the Key Result.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197370" }, "400": { "$ref": "#/components/responses/Response5197371" }, "404": { "$ref": "#/components/responses/Response5197372" }, "422": { "$ref": "#/components/responses/Response5197373" } }, "operationId": "getKeyResult", "description": "Returns the specified Key Result.", "summary": "Get Key Result" }, "put": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "key-result-public-id", "description": "The unique ID of the Key Result.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197374" }, "400": { "$ref": "#/components/responses/Response5197375" }, "404": { "$ref": "#/components/responses/Response5197376" }, "422": { "$ref": "#/components/responses/Response5197377" } }, "operationId": "updateKeyResult", "requestBody": { "$ref": "#/components/requestBodies/Body5196873" }, "description": "Updates the specified Key Result.", "summary": "Update Key Result" } }, "/api/v4/{workspace-slug}/labels": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197020" }, "400": { "$ref": "#/components/responses/Response5197021" }, "404": { "$ref": "#/components/responses/Response5197022" }, "422": { "$ref": "#/components/responses/Response5197023" } }, "operationId": "listLabels", "description": "List Labels returns a paginated list of all Labels in the Workspace.", "summary": "List Labels" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197024" }, "400": { "$ref": "#/components/responses/Response5197025" }, "404": { "$ref": "#/components/responses/Response5197026" }, "422": { "$ref": "#/components/responses/Response5197027" } }, "operationId": "createLabel", "requestBody": { "$ref": "#/components/requestBodies/Body5196838" }, "description": "Create Label allows you to create a new Label in Shortcut.", "summary": "Create Label" } }, "/api/v4/{workspace-slug}/labels/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197251" }, "400": { "$ref": "#/components/responses/Response5197252" }, "404": { "$ref": "#/components/responses/Response5197253" }, "422": { "$ref": "#/components/responses/Response5197254" } }, "operationId": "bulkDeleteLabels", "requestBody": { "$ref": "#/components/requestBodies/Body5196864" }, "description": "Bulk Delete Labels deletes multiple Labels.", "summary": "Bulk Delete Labels" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197255" }, "400": { "$ref": "#/components/responses/Response5197256" }, "404": { "$ref": "#/components/responses/Response5197257" }, "422": { "$ref": "#/components/responses/Response5197258" } }, "operationId": "bulkUpdateLabels", "requestBody": { "$ref": "#/components/requestBodies/Body5196865" }, "description": "Bulk Update Labels updates multiple Labels, and returns a paginated list of the updated Labels.", "summary": "Bulk Update Labels" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197259" }, "400": { "$ref": "#/components/responses/Response5197260" }, "404": { "$ref": "#/components/responses/Response5197261" }, "422": { "$ref": "#/components/responses/Response5197262" } }, "operationId": "bulkCreateLabels", "requestBody": { "$ref": "#/components/requestBodies/Body5196866" }, "description": "Bulk Create Labels creates multiple Labels, and returns a paginated list of the created Labels.", "summary": "Bulk Create Labels" } }, "/api/v4/{workspace-slug}/labels/{label-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "label-public-id", "description": "The ID of the Label.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197304" }, "400": { "$ref": "#/components/responses/Response5197305" }, "404": { "$ref": "#/components/responses/Response5197306" }, "422": { "$ref": "#/components/responses/Response5197307" } }, "operationId": "deleteLabel", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Label removes a Label from the Workspace.", "summary": "Delete Label" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "label-public-id", "description": "The ID of the Label.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197308" }, "400": { "$ref": "#/components/responses/Response5197309" }, "404": { "$ref": "#/components/responses/Response5197310" }, "422": { "$ref": "#/components/responses/Response5197311" } }, "operationId": "getLabel", "description": "Get Label returns information about a chosen Label.", "summary": "Get Label" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "label-public-id", "description": "The ID of the Label.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197312" }, "400": { "$ref": "#/components/responses/Response5197313" }, "404": { "$ref": "#/components/responses/Response5197314" }, "422": { "$ref": "#/components/responses/Response5197315" } }, "operationId": "updateLabel", "requestBody": { "$ref": "#/components/requestBodies/Body5196869" }, "description": "Update Label allows you to modify a Label in your Shortcut Workspace.", "summary": "Update Label" } }, "/api/v4/{workspace-slug}/labels/{label-public-id}/epics": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "label-public-id", "description": "The ID of the Label.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197138" }, "400": { "$ref": "#/components/responses/Response5197139" }, "404": { "$ref": "#/components/responses/Response5197140" }, "422": { "$ref": "#/components/responses/Response5197141" } }, "operationId": "listLabelEpics", "description": "List Label Epics returns a paginated list of all Epics that have a given Label.", "summary": "List Label Epics" } }, "/api/v4/{workspace-slug}/labels/{label-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "label-public-id", "description": "The ID of the Label.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197170" }, "400": { "$ref": "#/components/responses/Response5197171" }, "404": { "$ref": "#/components/responses/Response5197172" }, "422": { "$ref": "#/components/responses/Response5197173" } }, "operationId": "listLabelStories", "description": "List Label Stories returns a paginated list of all Stories that have a given Label.", "summary": "List Label Stories" } }, "/api/v4/{workspace-slug}/linked-files": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197567" }, "400": { "$ref": "#/components/responses/Response5197568" }, "404": { "$ref": "#/components/responses/Response5197569" }, "422": { "$ref": "#/components/responses/Response5197570" } }, "operationId": "listLinkedFiles", "description": "List Linked Files returns a paginated list of all Linked Files in the Workspace.", "summary": "List Linked Files" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197571" }, "400": { "$ref": "#/components/responses/Response5197572" }, "404": { "$ref": "#/components/responses/Response5197573" }, "422": { "$ref": "#/components/responses/Response5197574" } }, "operationId": "createLinkedFile", "requestBody": { "$ref": "#/components/requestBodies/Body5196892" }, "description": "Create Linked File is used to add a new Linked File to your Shortcut Workspace.", "summary": "Create Linked File" } }, "/api/v4/{workspace-slug}/linked-files/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197062" }, "400": { "$ref": "#/components/responses/Response5197063" }, "404": { "$ref": "#/components/responses/Response5197064" }, "422": { "$ref": "#/components/responses/Response5197065" } }, "operationId": "bulkDeleteLinkedFiles", "requestBody": { "$ref": "#/components/requestBodies/Body5196842" }, "description": "Bulk Delete Linked Files deletes multiple Linked Files.", "summary": "Bulk Delete Linked Files" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197066" }, "400": { "$ref": "#/components/responses/Response5197067" }, "404": { "$ref": "#/components/responses/Response5197068" }, "422": { "$ref": "#/components/responses/Response5197069" } }, "operationId": "bulkUpdateLinkedFiles", "requestBody": { "$ref": "#/components/requestBodies/Body5196843" }, "description": "Bulk Update Linked Files updates multiple Linked Files, and returns a paginated list of the updated Linked Files.", "summary": "Bulk Update Linked Files" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197070" }, "400": { "$ref": "#/components/responses/Response5197071" }, "404": { "$ref": "#/components/responses/Response5197072" }, "422": { "$ref": "#/components/responses/Response5197073" } }, "operationId": "bulkCreateLinkedFiles", "requestBody": { "$ref": "#/components/requestBodies/Body5196844" }, "description": "Bulk Create Linked Files creates multiple Linked Files, and returns a paginated list of the created Linked Files.", "summary": "Bulk Create Linked Files" } }, "/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197346" }, "400": { "$ref": "#/components/responses/Response5197347" }, "404": { "$ref": "#/components/responses/Response5197348" }, "422": { "$ref": "#/components/responses/Response5197349" } }, "operationId": "deleteLinkedFile", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Linked File removes a Linked File from the Workspace.", "summary": "Delete Linked File" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197350" }, "400": { "$ref": "#/components/responses/Response5197351" }, "404": { "$ref": "#/components/responses/Response5197352" }, "422": { "$ref": "#/components/responses/Response5197353" } }, "operationId": "getLinkedFile", "description": "Get Linked File returns information about the chosen Linked File.", "summary": "Get Linked File" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197354" }, "400": { "$ref": "#/components/responses/Response5197355" }, "404": { "$ref": "#/components/responses/Response5197356" }, "422": { "$ref": "#/components/responses/Response5197357" } }, "operationId": "updateLinkedFile", "requestBody": { "$ref": "#/components/requestBodies/Body5196872" }, "description": "Update Linked File is used to update an existing Linked File in your Shortcut Workspace.", "summary": "Update Linked File" } }, "/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197272" }, "400": { "$ref": "#/components/responses/Response5197273" }, "404": { "$ref": "#/components/responses/Response5197274" }, "422": { "$ref": "#/components/responses/Response5197275" } }, "operationId": "listLinkedFileStories", "description": "List Linked File Stories returns a paginated list of all Stories associated with a Linked File in the Workspace.", "summary": "List Linked File Stories" } }, "/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197791" }, "400": { "$ref": "#/components/responses/Response5197792" }, "404": { "$ref": "#/components/responses/Response5197793" }, "422": { "$ref": "#/components/responses/Response5197794" } }, "operationId": "listLinkedFileMentionedTeams", "description": "List Linked File Mentioned Teams returns a paginated list of all Teams mentioned in a Linked File in the Workspace.", "summary": "List Linked File Mentioned Teams" } }, "/api/v4/{workspace-slug}/linked-files/{linked-file-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "linked-file-public-id", "description": "The ID of the Linked File.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197198" }, "400": { "$ref": "#/components/responses/Response5197199" }, "404": { "$ref": "#/components/responses/Response5197200" }, "422": { "$ref": "#/components/responses/Response5197201" } }, "operationId": "listLinkedFileMentionedMembers", "description": "List Linked File Mentioned Members returns a paginated list of all Members mentioned in a Linked File in the Workspace.", "summary": "List Linked File Mentioned Members" } }, "/api/v4/{workspace-slug}/members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197300" }, "400": { "$ref": "#/components/responses/Response5197301" }, "404": { "$ref": "#/components/responses/Response5197302" }, "422": { "$ref": "#/components/responses/Response5197303" } }, "operationId": "listMembers", "description": "List Members returns a paginated list of all Members in the Workspace.", "summary": "List Members" } }, "/api/v4/{workspace-slug}/members/bulk": { "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197057" }, "400": { "$ref": "#/components/responses/Response5197058" }, "403": { "$ref": "#/components/responses/Response5197061" }, "404": { "$ref": "#/components/responses/Response5197059" }, "422": { "$ref": "#/components/responses/Response5197060" } }, "operationId": "bulkUpdateMembers", "requestBody": { "$ref": "#/components/requestBodies/Body5196841" }, "description": "Bulk Update Members updates multiple Members and returns a paginated list of the updated Members.", "summary": "Bulk Update Members" } }, "/api/v4/{workspace-slug}/members/{member-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member-public-id", "description": "The unique ID of the Member.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197214" }, "400": { "$ref": "#/components/responses/Response5197215" }, "404": { "$ref": "#/components/responses/Response5197216" }, "422": { "$ref": "#/components/responses/Response5197217" } }, "operationId": "getMember", "description": "Get Member returns information about a Member of the Workspace.", "summary": "Get Member" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member-public-id", "description": "The unique ID of the Member.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197218" }, "400": { "$ref": "#/components/responses/Response5197219" }, "403": { "$ref": "#/components/responses/Response5197222" }, "404": { "$ref": "#/components/responses/Response5197220" }, "422": { "$ref": "#/components/responses/Response5197221" } }, "operationId": "updateMember", "requestBody": { "$ref": "#/components/requestBodies/Body5196859" }, "description": "Update Member modifies a Member's role or disabled status in the Workspace.", "summary": "Update Member" } }, "/api/v4/{workspace-slug}/members/{member-public-id}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member-public-id", "description": "The unique ID of the Member.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197795" }, "400": { "$ref": "#/components/responses/Response5197796" }, "404": { "$ref": "#/components/responses/Response5197797" }, "422": { "$ref": "#/components/responses/Response5197798" } }, "operationId": "listMemberTeams", "description": "Returns a paginated list of all Teams the Member belongs to.", "summary": "List Member Teams" } }, "/api/v4/{workspace-slug}/members/{member-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "member-public-id", "description": "The unique ID of the Member.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197247" }, "400": { "$ref": "#/components/responses/Response5197248" }, "404": { "$ref": "#/components/responses/Response5197249" }, "422": { "$ref": "#/components/responses/Response5197250" } }, "operationId": "listMemberStories", "description": "Returns a paginated list of all Stories owned by the specified Member.", "summary": "List Member Stories" } }, "/api/v4/{workspace-slug}/objectives": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197082" }, "400": { "$ref": "#/components/responses/Response5197083" }, "404": { "$ref": "#/components/responses/Response5197084" }, "422": { "$ref": "#/components/responses/Response5197085" } }, "operationId": "listObjectives", "description": "List Objectives returns a paginated list of all Objectives in the Workspace.", "summary": "List Objectives" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197086" }, "400": { "$ref": "#/components/responses/Response5197087" }, "404": { "$ref": "#/components/responses/Response5197088" }, "422": { "$ref": "#/components/responses/Response5197089" } }, "operationId": "createObjective", "requestBody": { "$ref": "#/components/requestBodies/Body5196845" }, "description": "Create Objective is used to create a new Objective in your Shortcut Workspace.", "summary": "Create Objective" } }, "/api/v4/{workspace-slug}/objectives/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197607" }, "400": { "$ref": "#/components/responses/Response5197608" }, "404": { "$ref": "#/components/responses/Response5197609" }, "422": { "$ref": "#/components/responses/Response5197610" } }, "operationId": "bulkDeleteObjectives", "requestBody": { "$ref": "#/components/requestBodies/Body5196897" }, "description": "Bulk Delete Objectives deletes multiple Objectives.", "summary": "Bulk Delete Objectives" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197611" }, "400": { "$ref": "#/components/responses/Response5197612" }, "404": { "$ref": "#/components/responses/Response5197613" }, "422": { "$ref": "#/components/responses/Response5197614" } }, "operationId": "bulkUpdateObjectives", "requestBody": { "$ref": "#/components/requestBodies/Body5196898" }, "description": "Bulk Update Objectives updates multiple Objectives, and returns a paginated list of the updated Objectives.", "summary": "Bulk Update Objectives" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197615" }, "400": { "$ref": "#/components/responses/Response5197616" }, "404": { "$ref": "#/components/responses/Response5197617" }, "422": { "$ref": "#/components/responses/Response5197618" } }, "operationId": "bulkCreateObjectives", "requestBody": { "$ref": "#/components/requestBodies/Body5196899" }, "description": "Bulk Create Objectives creates multiple Objectives, and returns a paginated list of the created Objectives.", "summary": "Bulk Create Objectives" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197378" }, "400": { "$ref": "#/components/responses/Response5197379" }, "404": { "$ref": "#/components/responses/Response5197380" }, "422": { "$ref": "#/components/responses/Response5197381" } }, "operationId": "deleteObjective", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Objective removes an Objective from the Workspace.", "summary": "Delete Objective" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197382" }, "400": { "$ref": "#/components/responses/Response5197383" }, "404": { "$ref": "#/components/responses/Response5197384" }, "422": { "$ref": "#/components/responses/Response5197385" } }, "operationId": "getObjective", "description": "Get Objective returns information about a chosen Objective.", "summary": "Get Objective" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197386" }, "400": { "$ref": "#/components/responses/Response5197387" }, "404": { "$ref": "#/components/responses/Response5197388" }, "422": { "$ref": "#/components/responses/Response5197389" } }, "operationId": "updateObjective", "requestBody": { "$ref": "#/components/requestBodies/Body5196875" }, "description": "Update Objective is used to modify an Objective in your Shortcut Workspace.", "summary": "Update Objective" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/epics": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197783" }, "400": { "$ref": "#/components/responses/Response5197784" }, "404": { "$ref": "#/components/responses/Response5197785" }, "422": { "$ref": "#/components/responses/Response5197786" } }, "operationId": "listObjectiveEpics", "description": "List Objective Epics returns a paginated list of all Epics associated with an Objective in the Workspace.", "summary": "List Objective Epics" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197292" }, "400": { "$ref": "#/components/responses/Response5197293" }, "404": { "$ref": "#/components/responses/Response5197294" }, "422": { "$ref": "#/components/responses/Response5197295" } }, "operationId": "listObjectiveTeams", "description": "List Objective Teams returns a paginated list of all Teams associated with an Objective in the Workspace.", "summary": "List Objective Teams" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/owners": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197495" }, "400": { "$ref": "#/components/responses/Response5197496" }, "404": { "$ref": "#/components/responses/Response5197497" }, "422": { "$ref": "#/components/responses/Response5197498" } }, "operationId": "listObjectiveOwners", "description": "List Objective Owners returns a paginated list of all Members who own an Objective in the Workspace.", "summary": "List Objective Owners" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/categories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197603" }, "400": { "$ref": "#/components/responses/Response5197604" }, "404": { "$ref": "#/components/responses/Response5197605" }, "422": { "$ref": "#/components/responses/Response5197606" } }, "operationId": "listObjectiveCategories", "description": "List Objective Categories returns a paginated list of all Categories associated with an Objective in the Workspace.", "summary": "List Objective Categories" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/key-results": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197439" }, "400": { "$ref": "#/components/responses/Response5197440" }, "404": { "$ref": "#/components/responses/Response5197441" }, "422": { "$ref": "#/components/responses/Response5197442" } }, "operationId": "listObjectiveKeyResults", "description": "List Objective Key Results returns a paginated list of all Key Results associated with an Objective in the Workspace.", "summary": "List Objective Key Results" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/objective-healths": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197519" }, "400": { "$ref": "#/components/responses/Response5197520" }, "404": { "$ref": "#/components/responses/Response5197521" }, "422": { "$ref": "#/components/responses/Response5197522" } }, "operationId": "listObjectiveHealths", "description": "Returns a paginated list of Health updates for the specified Objective.", "summary": "List Objective Healths" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197523" }, "400": { "$ref": "#/components/responses/Response5197524" }, "404": { "$ref": "#/components/responses/Response5197525" }, "422": { "$ref": "#/components/responses/Response5197526" } }, "operationId": "createObjectiveHealth", "requestBody": { "$ref": "#/components/requestBodies/Body5196886" }, "description": "Creates a new Health update for the specified Objective.", "summary": "Create Objective Health" } }, "/api/v4/{workspace-slug}/objectives/{objective-public-id}/objective-healths/{objective-health-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "objective-public-id", "description": "The ID of the Objective.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "objective-health-public-id", "description": "The unique ID of the Health.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197394" }, "400": { "$ref": "#/components/responses/Response5197395" }, "404": { "$ref": "#/components/responses/Response5197396" }, "422": { "$ref": "#/components/responses/Response5197397" } }, "operationId": "getObjectiveHealth", "description": "Returns a Health for the specified Objective.", "summary": "Get Objective Health" } }, "/api/v4/{workspace-slug}/projects": { "get": { "description": "List Projects returns a paginated list of all Projects in the Workspace. Projects are a deprecated feature.", "summary": "List Projects", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5197118" }, "400": { "$ref": "#/components/responses/Response5197119" }, "404": { "$ref": "#/components/responses/Response5197120" }, "422": { "$ref": "#/components/responses/Response5197121" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "listProjects" }, "post": { "description": "Create Project allows you to create a new Project in Shortcut. Projects are a deprecated feature.", "requestBody": { "$ref": "#/components/requestBodies/Body5196848" }, "summary": "Create Project", "deprecated": true, "responses": { "201": { "$ref": "#/components/responses/Response5197122" }, "400": { "$ref": "#/components/responses/Response5197123" }, "404": { "$ref": "#/components/responses/Response5197124" }, "422": { "$ref": "#/components/responses/Response5197125" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "createProject" } }, "/api/v4/{workspace-slug}/projects/{project-public-id}": { "delete": { "description": "Delete Project can be used to delete any Project. Projects are a deprecated feature.", "requestBody": { "$ref": "#/components/requestBodies/" }, "summary": "Delete Project", "deprecated": true, "responses": { "204": { "$ref": "#/components/responses/Response5196940" }, "400": { "$ref": "#/components/responses/Response5196941" }, "404": { "$ref": "#/components/responses/Response5196942" }, "422": { "$ref": "#/components/responses/Response5196943" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project-public-id", "description": "The unique ID of the Project.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "operationId": "deleteProject" }, "get": { "description": "Get Project returns information about the chosen Project. Projects are a deprecated feature.", "summary": "Get Project", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5196944" }, "400": { "$ref": "#/components/responses/Response5196945" }, "404": { "$ref": "#/components/responses/Response5196946" }, "422": { "$ref": "#/components/responses/Response5196947" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project-public-id", "description": "The unique ID of the Project.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "getProject" }, "patch": { "description": "Update Project can be used to update Project properties. Projects are a deprecated feature.", "requestBody": { "$ref": "#/components/requestBodies/Body5196831" }, "summary": "Update Project", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5196948" }, "400": { "$ref": "#/components/responses/Response5196949" }, "404": { "$ref": "#/components/responses/Response5196950" }, "422": { "$ref": "#/components/responses/Response5196951" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project-public-id", "description": "The unique ID of the Project.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "updateProject" } }, "/api/v4/{workspace-slug}/projects/{project-public-id}/stories": { "get": { "description": "List Project Stories returns a paginated list of all Stories associated with a Project. Projects are a deprecated feature.", "summary": "List Project Stories", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5197154" }, "400": { "$ref": "#/components/responses/Response5197155" }, "404": { "$ref": "#/components/responses/Response5197156" }, "422": { "$ref": "#/components/responses/Response5197157" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project-public-id", "description": "The unique ID of the Project.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "listProjectStories" } }, "/api/v4/{workspace-slug}/projects/{project-public-id}/followers": { "get": { "description": "List Project Followers returns a paginated list of all Members following a Project. Projects are a deprecated feature.", "summary": "List Project Followers", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5197078" }, "400": { "$ref": "#/components/responses/Response5197079" }, "404": { "$ref": "#/components/responses/Response5197080" }, "422": { "$ref": "#/components/responses/Response5197081" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "project-public-id", "description": "The unique ID of the Project.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "listProjectFollowers" } }, "/api/v4/{workspace-slug}/pull-requests": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :include_closed).", "required": false, "schema": { "type": "string", "enum": [ "exclude_closed", "include_closed" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197094" }, "400": { "$ref": "#/components/responses/Response5197095" }, "404": { "$ref": "#/components/responses/Response5197096" }, "422": { "$ref": "#/components/responses/Response5197097" } }, "operationId": "listPullRequests", "description": "List Pull Requests returns a paginated list of all Pull Requests in the Workspace that have been associated with a Story.", "summary": "List Pull Requests" } }, "/api/v4/{workspace-slug}/pull-requests/{pull-request-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pull-request-public-id", "description": "The ID of the Pull Request.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197276" }, "400": { "$ref": "#/components/responses/Response5197277" }, "404": { "$ref": "#/components/responses/Response5197278" }, "422": { "$ref": "#/components/responses/Response5197279" } }, "operationId": "getPullRequest", "description": "Get Pull Request returns information about a chosen Pull Request.", "summary": "Get Pull Request" } }, "/api/v4/{workspace-slug}/pull-requests/{pull-request-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "pull-request-public-id", "description": "The ID of the Pull Request.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197539" }, "400": { "$ref": "#/components/responses/Response5197540" }, "404": { "$ref": "#/components/responses/Response5197541" }, "422": { "$ref": "#/components/responses/Response5197542" } }, "operationId": "listPullRequestStories", "description": "List Pull Request Stories returns a paginated list of all Stories associated with a Pull Request in the Workspace.", "summary": "List Pull Request Stories" } }, "/api/v4/{workspace-slug}/repositories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197362" }, "400": { "$ref": "#/components/responses/Response5197363" }, "404": { "$ref": "#/components/responses/Response5197364" }, "422": { "$ref": "#/components/responses/Response5197365" } }, "operationId": "listRepositories", "description": "List Repositories returns a paginated list of all connected Repositories in the Workspace.", "summary": "List Repositories" } }, "/api/v4/{workspace-slug}/repositories/{repository-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository-public-id", "description": "The ID of the Repository.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197779" }, "400": { "$ref": "#/components/responses/Response5197780" }, "404": { "$ref": "#/components/responses/Response5197781" }, "422": { "$ref": "#/components/responses/Response5197782" } }, "operationId": "getRepository", "description": "Get Repository returns information about a connected Repository.", "summary": "Get Repository" } }, "/api/v4/{workspace-slug}/repositories/{repository-public-id}/commits": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository-public-id", "description": "The ID of the Repository.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196976" }, "400": { "$ref": "#/components/responses/Response5196977" }, "404": { "$ref": "#/components/responses/Response5196978" }, "422": { "$ref": "#/components/responses/Response5196979" } }, "operationId": "listRepositoryCommits", "description": "List Repository Commits returns a paginated list of all Commits associated with a Repository in the Workspace.", "summary": "List Repository Commits" } }, "/api/v4/{workspace-slug}/repositories/{repository-public-id}/branches": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository-public-id", "description": "The ID of the Repository.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_deleted).", "required": false, "schema": { "type": "string", "enum": [ "exclude_deleted", "include_deleted" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197174" }, "400": { "$ref": "#/components/responses/Response5197175" }, "404": { "$ref": "#/components/responses/Response5197176" }, "422": { "$ref": "#/components/responses/Response5197177" } }, "operationId": "listRepositoryBranches", "description": "List Repository Branches returns a paginated list of all Branches associated with a Repository in the Workspace.", "summary": "List Repository Branches" } }, "/api/v4/{workspace-slug}/repositories/{repository-public-id}/pull-requests": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "repository-public-id", "description": "The ID of the Repository.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :include_closed).", "required": false, "schema": { "type": "string", "enum": [ "exclude_closed", "include_closed" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197695" }, "400": { "$ref": "#/components/responses/Response5197696" }, "404": { "$ref": "#/components/responses/Response5197697" }, "422": { "$ref": "#/components/responses/Response5197698" } }, "operationId": "listRepositoryPullRequests", "description": "List Repository Pull Requests returns a paginated list of all Pull Requests associated with a Repository in the Workspace.", "summary": "List Repository Pull Requests" } }, "/api/v4/{workspace-slug}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "ids", "description": "A comma-separated list of ids. If included, only those entities will be considered for listing.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197595" }, "400": { "$ref": "#/components/responses/Response5197596" }, "404": { "$ref": "#/components/responses/Response5197597" }, "422": { "$ref": "#/components/responses/Response5197598" } }, "operationId": "listStories", "description": "List Stories returns a paginated list of all Stories in the Workspace.", "summary": "List Stories" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197599" }, "400": { "$ref": "#/components/responses/Response5197600" }, "404": { "$ref": "#/components/responses/Response5197601" }, "422": { "$ref": "#/components/responses/Response5197602" } }, "operationId": "createStory", "requestBody": { "$ref": "#/components/requestBodies/Body5196896" }, "description": "Create Story is used to add a new Story to your Shortcut Workspace.", "summary": "Create Story" } }, "/api/v4/{workspace-slug}/stories/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "force", "description": "Forces deletion of the Stories, overriding the check that they are archived.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197759" }, "400": { "$ref": "#/components/responses/Response5197760" }, "404": { "$ref": "#/components/responses/Response5197761" }, "422": { "$ref": "#/components/responses/Response5197762" } }, "operationId": "bulkDeleteStories", "requestBody": { "$ref": "#/components/requestBodies/Body5196913" }, "description": "Bulk Delete Stories deletes multiple Stories. The Stories must be archived unless `force` is set.", "summary": "Bulk Delete Stories" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197763" }, "400": { "$ref": "#/components/responses/Response5197764" }, "404": { "$ref": "#/components/responses/Response5197765" }, "422": { "$ref": "#/components/responses/Response5197766" } }, "operationId": "bulkUpdateStories", "requestBody": { "$ref": "#/components/requestBodies/Body5196914" }, "description": "Bulk Update Stories updates multiple Stories, and returns a paginated list of the updated Stories.", "summary": "Bulk Update Stories" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197767" }, "400": { "$ref": "#/components/responses/Response5197768" }, "404": { "$ref": "#/components/responses/Response5197769" }, "422": { "$ref": "#/components/responses/Response5197770" } }, "operationId": "bulkCreateStories", "requestBody": { "$ref": "#/components/requestBodies/Body5196915" }, "description": "Bulk Create Stories creates multiple Stories, and returns a paginated list of the created Stories.", "summary": "Bulk Create Stories" } }, "/api/v4/{workspace-slug}/stories/search": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "query", "description": "The search query. Required if `cursor` is not sent. See our help center article on [search operators](https://help.shortcut.com/hc/en-us/articles/360000046646-Search-Operators).", "required": false, "schema": { "minLength": 1, "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197447" }, "400": { "$ref": "#/components/responses/Response5197448" }, "404": { "$ref": "#/components/responses/Response5197449" }, "422": { "$ref": "#/components/responses/Response5197450" } }, "operationId": "searchStories", "description": "Search Stories lets you search Stories based on a query.", "summary": "Search Stories" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "force", "description": "Forces deletion of the Story, overriding the check that it is archived.", "required": false, "schema": { "type": "boolean" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197008" }, "400": { "$ref": "#/components/responses/Response5197009" }, "404": { "$ref": "#/components/responses/Response5197010" }, "422": { "$ref": "#/components/responses/Response5197011" } }, "operationId": "deleteStory", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Story can be used to delete a Story. The Story must be archived unless `force` is set.", "summary": "Delete Story" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197012" }, "400": { "$ref": "#/components/responses/Response5197013" }, "404": { "$ref": "#/components/responses/Response5197014" }, "422": { "$ref": "#/components/responses/Response5197015" } }, "operationId": "getStory", "description": "Get Story returns information about a chosen Story.", "summary": "Get Story" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197016" }, "400": { "$ref": "#/components/responses/Response5197017" }, "404": { "$ref": "#/components/responses/Response5197018" }, "422": { "$ref": "#/components/responses/Response5197019" } }, "operationId": "updateStory", "requestBody": { "$ref": "#/components/requestBodies/Body5196837" }, "description": "Update Story is used to modify a Story in your Shortcut Workspace.", "summary": "Update Story" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/files": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197475" }, "400": { "$ref": "#/components/responses/Response5197476" }, "404": { "$ref": "#/components/responses/Response5197477" }, "422": { "$ref": "#/components/responses/Response5197478" } }, "operationId": "listStoryFiles", "description": "List Story Files returns a paginated list of all Files attached to a Story in the Workspace.", "summary": "List Story Files" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/labels": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197711" }, "400": { "$ref": "#/components/responses/Response5197712" }, "404": { "$ref": "#/components/responses/Response5197713" }, "422": { "$ref": "#/components/responses/Response5197714" } }, "operationId": "listStoryLabels", "description": "List Story Labels returns a paginated list of all Labels for a Story in the Workspace.", "summary": "List Story Labels" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/owners": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197202" }, "400": { "$ref": "#/components/responses/Response5197203" }, "404": { "$ref": "#/components/responses/Response5197204" }, "422": { "$ref": "#/components/responses/Response5197205" } }, "operationId": "listStoryOwners", "description": "List Story Owners returns a paginated list of all Members who own a Story in the Workspace.", "summary": "List Story Owners" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/commits": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197231" }, "400": { "$ref": "#/components/responses/Response5197232" }, "404": { "$ref": "#/components/responses/Response5197233" }, "422": { "$ref": "#/components/responses/Response5197234" } }, "operationId": "listStoryCommits", "description": "List Story Commits returns a paginated list of all Commits associated with a Story in the Workspace.", "summary": "List Story Commits" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/branches": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_deleted).", "required": false, "schema": { "type": "string", "enum": [ "exclude_deleted", "include_deleted" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197479" }, "400": { "$ref": "#/components/responses/Response5197480" }, "404": { "$ref": "#/components/responses/Response5197481" }, "422": { "$ref": "#/components/responses/Response5197482" } }, "operationId": "listStoryBranches", "description": "List Story Branches returns a paginated list of all Branches for a Story in the Workspace.", "summary": "List Story Branches" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "ids", "description": "A comma-separated list of ids. If included, only those entities will be considered for listing.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197743" }, "400": { "$ref": "#/components/responses/Response5197744" }, "404": { "$ref": "#/components/responses/Response5197745" }, "422": { "$ref": "#/components/responses/Response5197746" } }, "operationId": "listStoryComments", "description": "List Story Comments returns a paginated list of all Comments for a Story in the Workspace. Note that deleted comments will also be returned, but will have minimal information. The deleted comments are included as they may be parents to other comments.", "summary": "List Story Comments" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197747" }, "400": { "$ref": "#/components/responses/Response5197748" }, "404": { "$ref": "#/components/responses/Response5197749" }, "422": { "$ref": "#/components/responses/Response5197750" } }, "operationId": "createStoryComment", "requestBody": { "$ref": "#/components/requestBodies/Body5196912" }, "description": "Create Story is used to add a new Comment to a Story.", "summary": "Create Story Comment" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/followers": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197723" }, "400": { "$ref": "#/components/responses/Response5197724" }, "404": { "$ref": "#/components/responses/Response5197725" }, "422": { "$ref": "#/components/responses/Response5197726" } }, "operationId": "listStoryFollowers", "description": "List Story Followers returns a paginated list of all Members who are following a Story in the Workspace.", "summary": "List Story Followers" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/iterations": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "start_date" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197639" }, "400": { "$ref": "#/components/responses/Response5197640" }, "404": { "$ref": "#/components/responses/Response5197641" }, "422": { "$ref": "#/components/responses/Response5197642" } }, "operationId": "listStoryIterations", "description": "List Story Iterations returns a paginated list of all Iterations associated with a Story in the Workspace.", "summary": "List Story Iterations" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/story-links": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197727" }, "400": { "$ref": "#/components/responses/Response5197728" }, "404": { "$ref": "#/components/responses/Response5197729" }, "422": { "$ref": "#/components/responses/Response5197730" } }, "operationId": "listStoryStoryLinks", "description": "List Story Story Links returns a paginated list of all Story Links associated with a Story in the Workspace. This includes links where the Story is either the subject or the object of the relationship.", "summary": "List Story Story Links" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/linked-files": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197268" }, "400": { "$ref": "#/components/responses/Response5197269" }, "404": { "$ref": "#/components/responses/Response5197270" }, "422": { "$ref": "#/components/responses/Response5197271" } }, "operationId": "listStoryLinkedFiles", "description": "List Story Linked Files returns a paginated list of all Linked Files attached to a Story in the Workspace.", "summary": "List Story Linked Files" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197815" }, "400": { "$ref": "#/components/responses/Response5197816" }, "404": { "$ref": "#/components/responses/Response5197817" }, "422": { "$ref": "#/components/responses/Response5197818" } }, "operationId": "bulkDeleteStoryComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196918" }, "description": "Bulk Delete Story Comments deletes multiple Comments from a Story.", "summary": "Bulk Delete Story Comments" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197819" }, "400": { "$ref": "#/components/responses/Response5197820" }, "404": { "$ref": "#/components/responses/Response5197821" }, "422": { "$ref": "#/components/responses/Response5197822" } }, "operationId": "bulkUpdateStoryComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196919" }, "description": "Bulk Update Story Comments updates multiple Comments on a Story, and returns a paginated list of the updated Comments.", "summary": "Bulk Update Story Comments" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197823" }, "400": { "$ref": "#/components/responses/Response5197824" }, "404": { "$ref": "#/components/responses/Response5197825" }, "422": { "$ref": "#/components/responses/Response5197826" } }, "operationId": "bulkCreateStoryComments", "requestBody": { "$ref": "#/components/requestBodies/Body5196920" }, "description": "Bulk Create Story Comments creates multiple Comments on a Story, and returns a paginated list of the created Comments.", "summary": "Bulk Create Story Comments" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/pull-requests": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :include_closed).", "required": false, "schema": { "type": "string", "enum": [ "exclude_closed", "include_closed" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196992" }, "400": { "$ref": "#/components/responses/Response5196993" }, "404": { "$ref": "#/components/responses/Response5196994" }, "422": { "$ref": "#/components/responses/Response5196995" } }, "operationId": "listStoryPullRequests", "description": "List Story Pull Requests returns a paginated list of all Pull Requests associated with a Story in the Workspace.", "summary": "List Story Pull Requests" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/external-links": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "value" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197719" }, "400": { "$ref": "#/components/responses/Response5197720" }, "404": { "$ref": "#/components/responses/Response5197721" }, "422": { "$ref": "#/components/responses/Response5197722" } }, "operationId": "listStoryExternalLinks", "description": "List Story External Links returns a paginated list of all External Links for a Story in the Workspace.", "summary": "List Story External Links" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "ids", "description": "A comma-separated list of ids. If included, only those entities will be considered for listing.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197411" }, "400": { "$ref": "#/components/responses/Response5197412" }, "404": { "$ref": "#/components/responses/Response5197413" }, "422": { "$ref": "#/components/responses/Response5197414" } }, "operationId": "listStoryChecklistItems", "description": "List Story Checklist Items returns a paginated list of all Checklist Items for a Story in the Workspace.", "summary": "List Story Checklist Items" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197415" }, "400": { "$ref": "#/components/responses/Response5197416" }, "404": { "$ref": "#/components/responses/Response5197417" }, "422": { "$ref": "#/components/responses/Response5197418" } }, "operationId": "createStoryChecklistItem", "requestBody": { "$ref": "#/components/requestBodies/Body5196877" }, "description": "Create Story Checklist Item is used to add a new Checklist Item to a Story.", "summary": "Create Story Checklist Item" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197835" }, "400": { "$ref": "#/components/responses/Response5197836" }, "404": { "$ref": "#/components/responses/Response5197837" }, "422": { "$ref": "#/components/responses/Response5197838" } }, "operationId": "listStoryMentionedTeams", "description": "List Story Mentioned Teams returns a paginated list of all Teams mentioned in a Story in the Workspace.", "summary": "List Story Mentioned Teams" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/sub-task-stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197575" }, "400": { "$ref": "#/components/responses/Response5197576" }, "404": { "$ref": "#/components/responses/Response5197577" }, "422": { "$ref": "#/components/responses/Response5197578" } }, "operationId": "listStorySubTaskStories", "description": "List Story Sub-Task Stories returns a paginated list of all Sub-Task Stories for a Story in the Workspace.", "summary": "List Story Sub-Task Stories" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197679" }, "400": { "$ref": "#/components/responses/Response5197680" }, "404": { "$ref": "#/components/responses/Response5197681" }, "422": { "$ref": "#/components/responses/Response5197682" } }, "operationId": "listStoryMentionedMembers", "description": "List Story Mentioned Members returns a paginated list of all Members mentioned in a Story in the Workspace.", "summary": "List Story Mentioned Members" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/custom-field-values": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "field_name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197000" }, "400": { "$ref": "#/components/responses/Response5197001" }, "404": { "$ref": "#/components/responses/Response5197002" }, "422": { "$ref": "#/components/responses/Response5197003" } }, "operationId": "listStoryCustomFieldValues", "description": "List Story Custom Field Values returns a paginated list of all Custom Field Values for a Story in the Workspace.", "summary": "List Story Custom Field Values" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5196928" }, "400": { "$ref": "#/components/responses/Response5196929" }, "404": { "$ref": "#/components/responses/Response5196930" }, "422": { "$ref": "#/components/responses/Response5196931" } }, "operationId": "bulkDeleteStoryChecklistItems", "requestBody": { "$ref": "#/components/requestBodies/Body5196827" }, "description": "Bulk Delete Story Checklist Items deletes multiple Checklist Items from a Story.", "summary": "Bulk Delete Story Checklist Items" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196932" }, "400": { "$ref": "#/components/responses/Response5196933" }, "404": { "$ref": "#/components/responses/Response5196934" }, "422": { "$ref": "#/components/responses/Response5196935" } }, "operationId": "bulkUpdateStoryChecklistItems", "requestBody": { "$ref": "#/components/requestBodies/Body5196828" }, "description": "Bulk Update Story Checklist Items updates multiple Checklist Items on a Story, and returns a paginated list of the updated Checklist Items.", "summary": "Bulk Update Story Checklist Items" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5196936" }, "400": { "$ref": "#/components/responses/Response5196937" }, "404": { "$ref": "#/components/responses/Response5196938" }, "422": { "$ref": "#/components/responses/Response5196939" } }, "operationId": "bulkCreateStoryChecklistItems", "requestBody": { "$ref": "#/components/requestBodies/Body5196829" }, "description": "Bulk Create Story Checklist Items creates multiple Checklist Items on a Story, and returns a paginated list of the created Checklist Items.", "summary": "Bulk Create Story Checklist Items" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197731" }, "400": { "$ref": "#/components/responses/Response5197732" }, "404": { "$ref": "#/components/responses/Response5197733" }, "422": { "$ref": "#/components/responses/Response5197734" } }, "operationId": "deleteStoryComment", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete a Comment from a Story.", "summary": "Delete Story Comment" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197735" }, "400": { "$ref": "#/components/responses/Response5197736" }, "404": { "$ref": "#/components/responses/Response5197737" }, "422": { "$ref": "#/components/responses/Response5197738" } }, "operationId": "getStoryComment", "description": "Get Story Comment returns information about a chosen Story Comment.", "summary": "Get Story Comment" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197739" }, "400": { "$ref": "#/components/responses/Response5197740" }, "404": { "$ref": "#/components/responses/Response5197741" }, "422": { "$ref": "#/components/responses/Response5197742" } }, "operationId": "updateStoryComment", "requestBody": { "$ref": "#/components/requestBodies/Body5196911" }, "description": "Update Story Comment is used to modify a Story Comment.", "summary": "Update Story Comment" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/comments": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197098" }, "400": { "$ref": "#/components/responses/Response5197099" }, "404": { "$ref": "#/components/responses/Response5197100" }, "422": { "$ref": "#/components/responses/Response5197101" } }, "operationId": "listStoryCommentComments", "description": "List Story Comment Comments returns a paginated list of all threaded reply Comments for a Story Comment in the Workspace.", "summary": "List Story Comment Comments" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/reactions": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "created_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197190" }, "400": { "$ref": "#/components/responses/Response5197191" }, "404": { "$ref": "#/components/responses/Response5197192" }, "422": { "$ref": "#/components/responses/Response5197193" } }, "operationId": "listStoryCommentReactions", "description": "List Story Comment Reactions returns a paginated list of all Reactions to a Story Comment in the Workspace.", "summary": "List Story Comment Reactions" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197194" }, "400": { "$ref": "#/components/responses/Response5197195" }, "404": { "$ref": "#/components/responses/Response5197196" }, "422": { "$ref": "#/components/responses/Response5197197" } }, "operationId": "createStoryCommentReaction", "requestBody": { "$ref": "#/components/requestBodies/Body5196856" }, "description": "Create a Reaction to a Story Comment.", "summary": "Create Story Comment Reaction" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "checklist-item-public-id", "description": "The ID of the Checklist Item.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197483" }, "400": { "$ref": "#/components/responses/Response5197484" }, "404": { "$ref": "#/components/responses/Response5197485" }, "422": { "$ref": "#/components/responses/Response5197486" } }, "operationId": "deleteStoryChecklistItem", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete a Checklist Item from a Story.", "summary": "Delete Story Checklist Item" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "checklist-item-public-id", "description": "The ID of the Checklist Item.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197487" }, "400": { "$ref": "#/components/responses/Response5197488" }, "404": { "$ref": "#/components/responses/Response5197489" }, "422": { "$ref": "#/components/responses/Response5197490" } }, "operationId": "getStoryChecklistItem", "description": "Get Story Checklist Item returns information about a chosen Checklist Item for a Story.", "summary": "Get Story Checklist Item" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "checklist-item-public-id", "description": "The ID of the Checklist Item.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197491" }, "400": { "$ref": "#/components/responses/Response5197492" }, "404": { "$ref": "#/components/responses/Response5197493" }, "422": { "$ref": "#/components/responses/Response5197494" } }, "operationId": "updateStoryChecklistItem", "requestBody": { "$ref": "#/components/requestBodies/Body5196883" }, "description": "Update Story Checklist Item is used to modify a Checklist Item on a Story.", "summary": "Update Story Checklist Item" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197150" }, "400": { "$ref": "#/components/responses/Response5197151" }, "404": { "$ref": "#/components/responses/Response5197152" }, "422": { "$ref": "#/components/responses/Response5197153" } }, "operationId": "listStoryCommentMentionedTeams", "description": "List Story Comment Mentioned Teams returns a paginated list of all Teams mentioned in a Story Comment in the Workspace.", "summary": "List Story Comment Mentioned Teams" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196956" }, "400": { "$ref": "#/components/responses/Response5196957" }, "404": { "$ref": "#/components/responses/Response5196958" }, "422": { "$ref": "#/components/responses/Response5196959" } }, "operationId": "listStoryCommentMentionedMembers", "description": "List Story Comment Mentioned Members returns a paginated list of all Members mentioned in a Story Comment in the Workspace.", "summary": "List Story Comment Mentioned Members" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}/mentioned-teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "checklist-item-public-id", "description": "The ID of the Checklist Item.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5196996" }, "400": { "$ref": "#/components/responses/Response5196997" }, "404": { "$ref": "#/components/responses/Response5196998" }, "422": { "$ref": "#/components/responses/Response5196999" } }, "operationId": "listStoryChecklistItemMentionedTeams", "description": "List Story Checklist Item Mentioned Teams returns a paginated list of all Teams mentioned in a Story Checklist Item in the Workspace.", "summary": "List Story Checklist Item Mentioned Teams" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/comments/{comment-public-id}/reactions/{reaction-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "comment-public-id", "description": "The ID of the Comment.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "reaction-public-id", "description": "The ID of the Reaction.", "required": true, "schema": { "type": "string", "format": "uuid" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5196960" }, "400": { "$ref": "#/components/responses/Response5196961" }, "404": { "$ref": "#/components/responses/Response5196962" }, "422": { "$ref": "#/components/responses/Response5196963" } }, "operationId": "deleteStoryCommentReaction", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete a Reaction from a Story Comment.", "summary": "Delete Story Comment Reaction" } }, "/api/v4/{workspace-slug}/stories/{story-public-id}/checklist-items/{checklist-item-public-id}/mentioned-members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-public-id", "description": "The ID of the Story.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "path", "name": "checklist-item-public-id", "description": "The ID of the Checklist Item.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197515" }, "400": { "$ref": "#/components/responses/Response5197516" }, "404": { "$ref": "#/components/responses/Response5197517" }, "422": { "$ref": "#/components/responses/Response5197518" } }, "operationId": "listStoryChecklistItemMentionedMembers", "description": "List Story Checklist Item Mentioned Members returns a paginated list of all Members mentioned in a Story Checklist Item in the Workspace.", "summary": "List Story Checklist Item Mentioned Members" } }, "/api/v4/{workspace-slug}/story-links": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197527" }, "400": { "$ref": "#/components/responses/Response5197528" }, "404": { "$ref": "#/components/responses/Response5197529" }, "422": { "$ref": "#/components/responses/Response5197530" } }, "operationId": "listStoryLinks", "description": "List Story Links returns a paginated list of all Story Links in the Workspace.", "summary": "List Story Links" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197531" }, "400": { "$ref": "#/components/responses/Response5197532" }, "404": { "$ref": "#/components/responses/Response5197533" }, "422": { "$ref": "#/components/responses/Response5197534" } }, "operationId": "createStoryLink", "requestBody": { "$ref": "#/components/requestBodies/Body5196887" }, "description": "Create Story Link is used to create a semantic relationship between two Stories. The subject Story acts on the object Story. For example, \"Story A blocks Story B\".", "summary": "Create Story Link" } }, "/api/v4/{workspace-slug}/story-links/bulk": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197235" }, "400": { "$ref": "#/components/responses/Response5197236" }, "404": { "$ref": "#/components/responses/Response5197237" }, "422": { "$ref": "#/components/responses/Response5197238" } }, "operationId": "bulkDeleteStoryLinks", "requestBody": { "$ref": "#/components/requestBodies/Body5196861" }, "description": "Bulk Delete Story Links deletes multiple Story Links.", "summary": "Bulk Delete Story Links" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197239" }, "400": { "$ref": "#/components/responses/Response5197240" }, "404": { "$ref": "#/components/responses/Response5197241" }, "422": { "$ref": "#/components/responses/Response5197242" } }, "operationId": "bulkUpdateStoryLinks", "requestBody": { "$ref": "#/components/requestBodies/Body5196862" }, "description": "Bulk Update Story Links updates multiple Story Links, and returns a paginated list of the updated Story Links.", "summary": "Bulk Update Story Links" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197243" }, "400": { "$ref": "#/components/responses/Response5197244" }, "404": { "$ref": "#/components/responses/Response5197245" }, "422": { "$ref": "#/components/responses/Response5197246" } }, "operationId": "bulkCreateStoryLinks", "requestBody": { "$ref": "#/components/requestBodies/Body5196863" }, "description": "Bulk Create Story Links creates multiple Story Links, and returns a paginated list of the created Story Links.", "summary": "Bulk Create Story Links" } }, "/api/v4/{workspace-slug}/story-links/{story-link-public-id}": { "delete": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-link-public-id", "description": "The ID of the Story Link.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "204": { "$ref": "#/components/responses/Response5197102" }, "400": { "$ref": "#/components/responses/Response5197103" }, "404": { "$ref": "#/components/responses/Response5197104" }, "422": { "$ref": "#/components/responses/Response5197105" } }, "operationId": "deleteStoryLink", "requestBody": { "$ref": "#/components/requestBodies/" }, "description": "Delete Story Link removes the relationship between the Stories for the given Story Link.", "summary": "Delete Story Link" }, "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-link-public-id", "description": "The ID of the Story Link.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197106" }, "400": { "$ref": "#/components/responses/Response5197107" }, "404": { "$ref": "#/components/responses/Response5197108" }, "422": { "$ref": "#/components/responses/Response5197109" } }, "operationId": "getStoryLink", "description": "Get Story Link returns information about a chosen Story Link.", "summary": "Get Story Link" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "story-link-public-id", "description": "The ID of the Story Link.", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197110" }, "400": { "$ref": "#/components/responses/Response5197111" }, "404": { "$ref": "#/components/responses/Response5197112" }, "422": { "$ref": "#/components/responses/Response5197113" } }, "operationId": "updateStoryLink", "requestBody": { "$ref": "#/components/requestBodies/Body5196847" }, "description": "Update Story Link is used to modify the stories or verb of an existing Story Link.", "summary": "Update Story Link" } }, "/api/v4/{workspace-slug}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197847" }, "400": { "$ref": "#/components/responses/Response5197848" }, "404": { "$ref": "#/components/responses/Response5197849" }, "422": { "$ref": "#/components/responses/Response5197850" } }, "operationId": "listTeams", "description": "Returns a paginated list of all Teams in the Workspace.", "summary": "List Teams" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197851" }, "400": { "$ref": "#/components/responses/Response5197852" }, "404": { "$ref": "#/components/responses/Response5197853" }, "422": { "$ref": "#/components/responses/Response5197854" } }, "operationId": "createTeam", "requestBody": { "$ref": "#/components/requestBodies/Body5196923" }, "description": "Creates a new Team in the Workspace.", "summary": "Create Team" } }, "/api/v4/{workspace-slug}/teams/bulk": { "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197827" }, "400": { "$ref": "#/components/responses/Response5197828" }, "404": { "$ref": "#/components/responses/Response5197829" }, "422": { "$ref": "#/components/responses/Response5197830" } }, "operationId": "bulkUpdateTeams", "requestBody": { "$ref": "#/components/requestBodies/Body5196921" }, "description": "Updates multiple Teams and returns a paginated list of the updated Teams.", "summary": "Bulk Update Teams" }, "post": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "201": { "$ref": "#/components/responses/Response5197831" }, "400": { "$ref": "#/components/responses/Response5197832" }, "404": { "$ref": "#/components/responses/Response5197833" }, "422": { "$ref": "#/components/responses/Response5197834" } }, "operationId": "bulkCreateTeams", "requestBody": { "$ref": "#/components/requestBodies/Body5196922" }, "description": "Creates multiple Teams and returns a paginated list of the created Teams.", "summary": "Bulk Create Teams" } }, "/api/v4/{workspace-slug}/teams/{team-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "team-public-id", "description": "The UUID of the Team.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197431" }, "400": { "$ref": "#/components/responses/Response5197432" }, "404": { "$ref": "#/components/responses/Response5197433" }, "422": { "$ref": "#/components/responses/Response5197434" } }, "operationId": "getTeam", "description": "Returns the specified Team.", "summary": "Get Team" }, "patch": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "team-public-id", "description": "The UUID of the Team.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197435" }, "400": { "$ref": "#/components/responses/Response5197436" }, "404": { "$ref": "#/components/responses/Response5197437" }, "422": { "$ref": "#/components/responses/Response5197438" } }, "operationId": "updateTeam", "requestBody": { "$ref": "#/components/requestBodies/Body5196879" }, "description": "Updates the specified Team.", "summary": "Update Team" } }, "/api/v4/{workspace-slug}/teams/{team-public-id}/members": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "team-public-id", "description": "The UUID of the Team.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_disabled).", "required": false, "schema": { "type": "string", "enum": [ "exclude_disabled", "include_disabled" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197041" }, "400": { "$ref": "#/components/responses/Response5197042" }, "404": { "$ref": "#/components/responses/Response5197043" }, "422": { "$ref": "#/components/responses/Response5197044" } }, "operationId": "listTeamMembers", "description": "Returns a paginated list of all Members for the specified Team.", "summary": "List Team Members" } }, "/api/v4/{workspace-slug}/teams/{team-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "team-public-id", "description": "The UUID of the Team.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197811" }, "400": { "$ref": "#/components/responses/Response5197812" }, "404": { "$ref": "#/components/responses/Response5197813" }, "422": { "$ref": "#/components/responses/Response5197814" } }, "operationId": "listTeamStories", "description": "Returns a paginated list of all Stories assigned to the specified Team.", "summary": "List Team Stories" } }, "/api/v4/{workspace-slug}/teams/{team-public-id}/workflows": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "team-public-id", "description": "The UUID of the Team.", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197402" }, "400": { "$ref": "#/components/responses/Response5197403" }, "404": { "$ref": "#/components/responses/Response5197404" }, "422": { "$ref": "#/components/responses/Response5197405" } }, "operationId": "listTeamWorkflows", "description": "Returns a paginated list of all Workflows for the specified Team.", "summary": "List Team Workflows" } }, "/api/v4/{workspace-slug}/workflow-states": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197751" }, "400": { "$ref": "#/components/responses/Response5197752" }, "404": { "$ref": "#/components/responses/Response5197753" }, "422": { "$ref": "#/components/responses/Response5197754" } }, "operationId": "listWorkflowStates", "description": "Returns a paginated list of all Workflow States in the Workspace.", "summary": "List Workflow States" } }, "/api/v4/{workspace-slug}/workflow-states/{workflow-state-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-state-public-id", "description": "The ID of the Workflow State.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197755" }, "400": { "$ref": "#/components/responses/Response5197756" }, "404": { "$ref": "#/components/responses/Response5197757" }, "422": { "$ref": "#/components/responses/Response5197758" } }, "operationId": "getWorkflowState", "description": "Returns the specified Workflow State.", "summary": "Get Workflow State" } }, "/api/v4/{workspace-slug}/workflow-states/{workflow-state-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-state-public-id", "description": "The ID of the Workflow State.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197775" }, "400": { "$ref": "#/components/responses/Response5197776" }, "404": { "$ref": "#/components/responses/Response5197777" }, "422": { "$ref": "#/components/responses/Response5197778" } }, "operationId": "listWorkflowStateStories", "description": "Returns a paginated list of all Stories in the specified Workflow State.", "summary": "List Workflow State Stories" } }, "/api/v4/{workspace-slug}/workflows": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197535" }, "400": { "$ref": "#/components/responses/Response5197536" }, "404": { "$ref": "#/components/responses/Response5197537" }, "422": { "$ref": "#/components/responses/Response5197538" } }, "operationId": "listWorkflows", "description": "Returns a paginated list of all Workflows in the Workspace.", "summary": "List Workflows" } }, "/api/v4/{workspace-slug}/workflows/{workflow-public-id}": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-public-id", "description": "The ID of the Workflow.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197471" }, "400": { "$ref": "#/components/responses/Response5197472" }, "404": { "$ref": "#/components/responses/Response5197473" }, "422": { "$ref": "#/components/responses/Response5197474" } }, "operationId": "getWorkflow", "description": "Returns the specified Workflow.", "summary": "Get Workflow" } }, "/api/v4/{workspace-slug}/workflows/{workflow-public-id}/teams": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-public-id", "description": "The ID of the Workflow.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "name", "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197771" }, "400": { "$ref": "#/components/responses/Response5197772" }, "404": { "$ref": "#/components/responses/Response5197773" }, "422": { "$ref": "#/components/responses/Response5197774" } }, "operationId": "listWorkflowTeams", "description": "Returns a paginated list of all Teams associated with the specified Workflow.", "summary": "List Workflow Teams" } }, "/api/v4/{workspace-slug}/workflows/{workflow-public-id}/states": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-public-id", "description": "The ID of the Workflow.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "position" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :all).", "required": false, "schema": { "type": "string", "enum": [ "all" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197715" }, "400": { "$ref": "#/components/responses/Response5197716" }, "404": { "$ref": "#/components/responses/Response5197717" }, "422": { "$ref": "#/components/responses/Response5197718" } }, "operationId": "listWorkflowStatesWithinAWorkflow", "description": "Returns a paginated list of all Workflow States within the specified Workflow.", "summary": "List Workflow States within a Workflow" } }, "/api/v4/{workspace-slug}/workflows/{workflow-public-id}/stories": { "get": { "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-public-id", "description": "The ID of the Workflow.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at", "position", "created_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/Response5197635" }, "400": { "$ref": "#/components/responses/Response5197636" }, "404": { "$ref": "#/components/responses/Response5197637" }, "422": { "$ref": "#/components/responses/Response5197638" } }, "operationId": "listWorkflowStories", "description": "Returns a paginated list of all Stories associated with the specified Workflow.", "summary": "List Workflow Stories" } }, "/api/v4/{workspace-slug}/workflows/{workflow-public-id}/projects": { "get": { "description": "Returns a paginated list of all Projects associated with the specified Workflow. Projects are a deprecated feature.", "summary": "List Workflow Projects", "deprecated": true, "responses": { "200": { "$ref": "#/components/responses/Response5197037" }, "400": { "$ref": "#/components/responses/Response5197038" }, "404": { "$ref": "#/components/responses/Response5197039" }, "422": { "$ref": "#/components/responses/Response5197040" } }, "parameters": [ { "in": "path", "name": "workspace-slug", "description": "The slug for the Workspace.", "required": true, "schema": { "type": "string" } }, { "in": "path", "name": "workflow-public-id", "description": "The ID of the Workflow.", "required": true, "schema": { "type": "integer", "format": "int64" } }, { "in": "query", "name": "limit", "description": "The number of results to include in a page. Can be between 1 and 100. Defaults to 10.", "required": false, "schema": { "minimum": 1, "maximum": 100, "type": "integer", "format": "int64" } }, { "in": "query", "name": "cursor", "description": "The cursor indicating where we are in a paged response. If sent, it (and an optional `fields` parameter) must be the only parameters.", "required": false, "schema": { "type": "string" } }, { "in": "query", "name": "order_by", "description": "Order the results by this property and direction.", "required": false, "schema": { "type": "string", "enum": [ "updated_at" ] } }, { "in": "query", "name": "order_dir", "description": "Order order_by in this direction. If order_by not provided, the default order property for this entity type will be used.", "required": false, "schema": { "type": "string", "enum": [ "desc", "asc" ] } }, { "in": "query", "name": "filter", "description": "Filter options (default: :exclude_archived).", "required": false, "schema": { "type": "string", "enum": [ "exclude_archived", "include_archived" ] } }, { "in": "query", "name": "fields", "description": "Fields to include in the response, as a comma-separated string. If provided, only these fields will be included for each entity in the response. If not present, all fields will be returned.", "required": false, "schema": { "type": "string" } } ], "operationId": "listWorkflowProjects" } } }, "components": { "schemas": { "Response5197816": { "type": "object", "additionalProperties": false, "properties": {} }, "CommitSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "commit:slim" ] }, "id": { "description": "The unique ID of the Commit.", "type": "integer", "format": "int64" }, "message": { "description": "The message of the Commit.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "message", "uri" ] }, "Response5197305": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateEntityTemplatesParams1": { "type": "object", "properties": { "id": { "description": "The UUID of the Entity Template to update.", "type": "string", "format": "uuid" }, "name": { "maxLength": 128, "minLength": 1, "description": "The updated template name.", "type": "string" }, "story_contents": { "$ref": "#/components/schemas/UpdateEntityTemplateStoryContentsParams" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197389": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197601": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197742": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryChecklistItemEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/ChecklistItem" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197123": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197664": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197263": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DocFollowerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197093": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197556": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkflowStateSlim": { "description": "The default Workflow State of the Workspace's default Workflow.", "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "workflow-state:slim" ] }, "id": { "description": "The unique ID of the Workflow State.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Workflow State.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "workflow_name": { "description": "The name of the Workflow this state belongs to.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri", "workflow_name" ] }, "Response5197035": { "type": "object", "additionalProperties": false, "properties": {} }, "DocEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Doc" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "BulkUpdateCustomFieldsParams1": { "type": "object", "properties": { "id": { "description": "The unique ID of the Custom Field to update.", "type": "string", "format": "uuid" }, "after_id": { "description": "Move this Custom Field to after the field with this ID.", "type": "string", "format": "uuid" }, "before_id": { "description": "Move this Custom Field to before the field with this ID.", "type": "string", "format": "uuid" }, "description": { "maxLength": 1024, "description": "A description of the Custom Field.", "type": "string" }, "enabled": { "description": "Whether the Custom Field is enabled.", "type": "boolean" }, "icon_set_identifier": { "maxLength": 63, "minLength": 1, "description": "An identifier for the icon set for this Custom Field.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The name of the Custom Field.", "type": "string" }, "values": { "description": "The ordered list of enum values. Existing values not included will be deleted.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomFieldEnumValueParams" } }, "values_add": { "description": "Enum values to add to the Custom Field. Existing values are unchanged.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomFieldEnumValueParams" } }, "values_remove": { "description": "IDs of enum values to remove from the Custom Field.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197388": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197673": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197626": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197580": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197174": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/RepositoryBranchEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Objective": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Objective.", "type": "string" }, "archived": { "description": "Whether the Objective is archived.", "type": "boolean" }, "categories": { "description": "The Categories associated with the Objective.", "type": "array", "items": { "$ref": "#/components/schemas/CategorySlim" } }, "completed": { "description": "Whether the Objective has been completed.", "type": "boolean" }, "completed_at": { "description": "The time/date the Objective was completed.", "type": "string", "format": "date-time", "nullable": true }, "completed_at_override": { "description": "A manual override for the time/date the Objective was completed.", "type": "string", "format": "date-time", "nullable": true }, "created_at": { "description": "The time/date the Objective was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Objective.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "objective" ] }, "epics": { "$ref": "#/components/schemas/NestedEpicSlimList" }, "healths": { "$ref": "#/components/schemas/NestedHealthSlimList" }, "id": { "description": "The unique ID of the Objective.", "type": "integer", "format": "int64" }, "key_results": { "$ref": "#/components/schemas/NestedKeyResultSlimList" }, "name": { "maxLength": 512, "description": "The name of the Objective.", "type": "string" }, "owners": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "started": { "description": "Whether the Objective has been started.", "type": "boolean" }, "started_at": { "description": "The time/date the Objective was started.", "type": "string", "format": "date-time", "nullable": true }, "started_at_override": { "description": "A manual override for the time/date the Objective was started.", "type": "string", "format": "date-time", "nullable": true }, "state": { "description": "The workflow state of the Objective.", "type": "string", "enum": [ "in progress", "to do", "done" ] }, "teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "updated_at": { "description": "The time/date the Objective was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "Response5197725": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197281": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFileEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/LinkedFile" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197259": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197829": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197188": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197337": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197474": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryCommentEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "NestedMemberSlimList": { "description": "A list of Members mentioned in the text of this Comment.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197131": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197155": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197810": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197605": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197677": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197711": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "WorkflowStateEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/WorkflowState" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197066": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197360": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196999": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197451": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196994": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197805": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197077": { "type": "object", "additionalProperties": false, "properties": {} }, "MemberStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196959": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197284": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "NestedLinkedFileSlimList": { "description": "A list of linked files attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/LinkedFileSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197209": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197099": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197004": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CommitEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197420": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196931": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197202": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryOwnerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197364": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197343": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196866": { "type": "object", "properties": { "labels": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Label to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateLabelParams" } } }, "additionalProperties": false, "required": [ "labels" ] }, "IterationStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197751": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowStateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197302": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197835": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196851": { "type": "object", "properties": { "entity_templates": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Entity Template to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateEntityTemplatesParams1" } } }, "additionalProperties": false, "required": [ "entity_templates" ] }, "Response5197787": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196935": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197703": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197692": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197604": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197569": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196998": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197557": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197422": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197545": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196904": { "type": "object", "properties": { "iterations": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Iteration to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateIterationsParams1" } } }, "additionalProperties": false, "required": [ "iterations" ] }, "Response5197670": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateEntityTemplateStoryContentsParams": { "description": "A map of story attributes this template populates.", "type": "object", "properties": { "custom_fields": { "description": "An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 512, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the epic to be populated.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate to be populated.", "type": "integer", "format": "int64", "nullable": true }, "external_links": { "description": "An array of external links to be populated.", "type": "array", "items": { "type": "string" } }, "file_ids": { "description": "An array of the attached file IDs to be populated.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "group_id": { "description": "The ID of the group to be populated.", "type": "string", "format": "uuid", "nullable": true }, "iteration_id": { "description": "The ID of the iteration to be populated.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "An array of IDs for Labels to be populated by the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of the linked file IDs to be populated.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "name": { "maxLength": 512, "description": "The name of the story.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for any Members you want to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "story_type": { "description": "The type of story (feature, bug, chore).", "type": "string", "enum": [ "chore", "bug", "feature" ] }, "sub_tasks": { "description": "An array of sub-tasks to be populated by the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEntityTemplateSubTaskParams" } }, "tasks": { "description": "An array of tasks to be populated by the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEntityTemplateTaskParams" } }, "workflow_state_id": { "description": "The ID of the workflow state to be populated.", "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "Response5197444": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197235": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197477": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196877SetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "IterationLabelEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "ReactionSlim": { "type": "object", "properties": { "emoji": { "description": "The emoji used for the Reaction.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "reaction:slim" ] }, "id": { "description": "The unique ID of the Reaction.", "type": "string", "format": "uuid" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "emoji", "uri" ] }, "Response5197068": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197376": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197167": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197452": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197821": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197697": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197088": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedTeamSlimList": { "description": "A list of Teams that this Member belongs to.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/TeamSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197258": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197055": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196964": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197393": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197534": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197067": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateLinkedFilesParams1": { "type": "object", "properties": { "id": { "description": "The id of the Linked File to update.", "type": "integer", "format": "int64" }, "description": { "maxLength": 512, "description": "The description of the Linked File.", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Linked File.", "type": "string" }, "thumbnail_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the thumbnail.", "type": "string" }, "type": { "maxLength": 63, "minLength": 1, "description": "The integration type (e.g. google, dropbox, box, onedrive, url).", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the Linked File.", "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197003": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197152": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197379": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197747": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197190": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentReactionEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197542": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197342": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicOwnerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197282": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197814": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196946": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197720": { "type": "object", "additionalProperties": false, "properties": {} }, "EntityTemplateSubTask": { "type": "object", "properties": { "name": { "description": "The name of the Sub-Task.", "type": "string" }, "owners": { "description": "An array of Members who own this Sub-Task.", "type": "array", "items": { "$ref": "#/components/schemas/MemberSlim" } }, "position": { "description": "The position of the Sub-Task within the list.", "type": "integer", "format": "int64" }, "workflow_state": { "$ref": "#/components/schemas/WorkflowStateSlim" } }, "additionalProperties": false }, "Response5197391": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197371": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197097": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197106": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197270": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197834": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197428": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateLabelParams": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new Label.", "type": "string" }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "description": { "maxLength": 1024, "description": "The description of the new Label.", "type": "string" }, "external_id": { "maxLength": 128, "minLength": 1, "description": "This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197764": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196978": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197405": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197514": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197156": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197086": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197333": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197373": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197427": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197350": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197508": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197016": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197424": { "type": "object", "additionalProperties": false, "properties": {} }, "EntityTemplate": { "description": "The entity for this response.", "type": "object", "properties": { "author": { "$ref": "#/components/schemas/MemberSlim" }, "created_at": { "description": "The time/date when the entity template was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "A string description of this resource.", "type": "string" }, "id": { "description": "The unique identifier for the entity template.", "type": "string", "format": "uuid" }, "last_used_at": { "description": "The last time that someone created an entity using this template.", "type": "string", "format": "date-time" }, "name": { "description": "The template's name.", "type": "string" }, "story_contents": { "$ref": "#/components/schemas/EntityTemplateStoryContents" }, "updated_at": { "description": "The time/date when the entity template was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197662": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197652": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197026": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedThreadedCommentSlimList": { "description": "The Comments on the Epic.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ThreadedCommentSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197594": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateEpicCommentsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Comment to update.", "type": "integer", "format": "int64" }, "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5196957": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197392": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197033": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196942": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197117": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197139": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197519": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197231": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommitEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196856": { "type": "object", "properties": { "emoji": { "description": "The emoji short-code to add. E.g. `:thumbsup::skin-tone-4:`.", "type": "string" } }, "additionalProperties": false, "required": [ "emoji" ] }, "EpicEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Epic" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "NestedIterationSlimList": { "description": "A list of Iterations that this Story has been attached to.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/IterationSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197366": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196843": { "type": "object", "properties": { "linked_files": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Linked File to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateLinkedFilesParams1" } } }, "additionalProperties": false, "required": [ "linked_files" ] }, "Response5197023": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197792": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197207": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicState": { "type": "object", "properties": { "color": { "description": "The color of the Epic State.", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Epic State was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Epic State.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "epic-state" ] }, "id": { "description": "The unique ID of the Epic State.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Epic State.", "type": "string" }, "position": { "description": "The position of the Epic State.", "type": "integer", "format": "int64" }, "type": { "description": "The type of the Epic State (unstarted, started, done).", "type": "string" }, "updated_at": { "description": "The time/date the Epic State was last updated.", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Response5197436": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196865": { "type": "object", "properties": { "labels": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Label to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateLabelsParams1" } } }, "additionalProperties": false, "required": [ "labels" ] }, "Response5197252": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197215": { "type": "object", "additionalProperties": false, "properties": {} }, "Comment": { "type": "object", "properties": { "app_url": { "description": "The Shortcut application url for the Comment. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true }, "author": { "$ref": "#/components/schemas/MemberSlim" }, "created_at": { "description": "The time/date the Comment was created.", "type": "string", "format": "date-time" }, "deleted": { "description": "True if the comment has been deleted.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "comment" ] }, "external_id": { "description": "This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "id": { "description": "The unique ID of the Comment. Will be null if the comment is deleted.", "type": "integer", "format": "int64", "nullable": true }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "parent_comment": { "$ref": "#/components/schemas/CommentSlim", "nullable": true }, "position": { "description": "The Comment's position within the Story.", "type": "integer", "format": "int64" }, "reactions": { "$ref": "#/components/schemas/NestedReactionSlimList" }, "story": { "$ref": "#/components/schemas/StorySlim" }, "text": { "description": "The text of the Comment. Will be null if the comment is deleted.", "type": "string", "nullable": true }, "updated_at": { "description": "The time/date the Comment was last updated.", "type": "string", "format": "date-time" }, "uri": { "description": "A resolvable URI for the entity that will return the full representation. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true } }, "additionalProperties": false }, "Response5196987": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedPullRequestSlimList": { "description": "A list of Pull/Merge Requests attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/PullRequestSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197094": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/PullRequestEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197271": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197120": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197473": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197595": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197017": { "type": "object", "additionalProperties": false, "properties": {} }, "Health": { "type": "object", "properties": { "author": { "$ref": "#/components/schemas/MemberSlim" }, "created_at": { "description": "The time/date the Health was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "health" ] }, "epic": { "$ref": "#/components/schemas/EpicSlim", "nullable": true }, "id": { "description": "The unique ID of the Health.", "type": "string", "format": "uuid" }, "objective": { "$ref": "#/components/schemas/ObjectiveSlim", "nullable": true }, "status": { "description": "The status of the Health.", "type": "string", "enum": [ "At Risk", "On Track", "Off Track", "No Health" ] }, "text": { "description": "The text body of the Health update.", "type": "string", "nullable": true }, "updated_at": { "description": "The time/date the Health was last updated.", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Response5197384": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197158": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197476": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197744": { "type": "object", "additionalProperties": false, "properties": {} }, "CommitStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "HealthEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Health" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196966": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197014": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196907": { "type": "object", "properties": { "category_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the archived Categories to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "category_ids" ] }, "Response5197784": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197568": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197756": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196875": { "type": "object", "properties": { "archived": { "description": "Whether the Objective is archived.", "type": "boolean" }, "category_ids": { "description": "An array of IDs of Categories to set on the Objective. Replaces current Categories.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "category_ids_add": { "description": "An array of IDs of Categories to add to the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "category_ids_remove": { "description": "An array of IDs of Categories to remove from the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "completed_at_override": { "description": "A manual override for the time/date the Objective was completed.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Objective's description.", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Objective.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Objective. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_add": { "description": "An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_remove": { "description": "An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "started_at_override": { "description": "A manual override for the time/date the Objective was started.", "type": "string", "format": "date-time", "nullable": true }, "state": { "description": "The workflow state of the Objective.", "type": "string", "enum": [ "in progress", "to do", "done" ] }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Objective. This will replace the current Teams on the Objective. Sending an empty array will remove all existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for Teams to add to the Objective. These will be added to the current Teams on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for Teams to remove from the Objective. These will be removed from the current Teams on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Category": { "type": "object", "properties": { "archived": { "description": "A true/false boolean indicating if the Category has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Category (for example, \"#ff0000\").", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Category was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "category" ] }, "external_id": { "description": "An optional external ID for the Category.", "type": "string", "nullable": true }, "id": { "description": "The unique ID of the Category.", "type": "integer", "format": "int64" }, "name": { "maxLength": 128, "description": "The name of the Category.", "type": "string" }, "updated_at": { "description": "The time/date the Category was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "StoryLabelEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "CreateEpicCommentParams": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" }, "author_id": { "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token. Requires the admin role to set.", "type": "string", "format": "uuid" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "parent_comment_id": { "description": "The ID of the Comment to reply to. When provided, creates a threaded reply rather than a top-level Comment.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "text" ] }, "Response5197848": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197614": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197459": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196837SetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the given story to the first or last position in the Workflow State, or before or after a given Story.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_story_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Branch": { "description": "The entity for this response.", "type": "object", "properties": { "created_at": { "description": "The time/date the Branch was created.", "type": "string", "format": "date-time" }, "deleted": { "description": "Boolean indicating whether the Branch has been deleted.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "branch" ] }, "external_url": { "description": "The URL of the Branch in the VCS provider.", "type": "string" }, "id": { "description": "The unique ID of the Branch.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Branch.", "type": "string" }, "pull_requests": { "$ref": "#/components/schemas/NestedPullRequestSlimList" }, "repository": { "$ref": "#/components/schemas/RepositorySlim" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "updated_at": { "description": "The time/date the Branch was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197195": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197461": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197187": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196901": { "type": "object", "properties": { "comments": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Comment to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateEpicCommentsParams1" } } }, "additionalProperties": false, "required": [ "comments" ] }, "StoryMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197320": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DocEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197766": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197278": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197400": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197197": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197095": { "type": "object", "additionalProperties": false, "properties": {} }, "BranchEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Branch" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "StoryMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196913": { "type": "object", "properties": { "story_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the archived Stories to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "story_ids" ] }, "Response5197208": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197267": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DisabledFeatureError" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryCommentMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197047": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197118": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197565": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197210": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CustomFieldEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197089": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197486": { "type": "object", "additionalProperties": false, "properties": {} }, "RepositorySlim": { "description": "The Repository that contains the Commit.", "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "repository:slim" ] }, "id": { "description": "The unique ID of the Repository.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Repository.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197410": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DisabledFeatureError" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197109": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197092": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197772": { "type": "object", "additionalProperties": false, "properties": {} }, "CustomFieldValue": { "type": "object", "properties": { "color_key": { "description": "The color key associated with this enum value.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "nullable": true }, "enabled": { "description": "Whether this enum value is enabled.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "custom-field-value" ] }, "field": { "$ref": "#/components/schemas/CustomFieldSlim" }, "id": { "description": "The unique public ID for the enum value.", "type": "string", "format": "uuid" }, "position": { "description": "The position of this enum value in the ordered list.", "type": "integer", "format": "int64" }, "value": { "maxLength": 63, "description": "The string value for this enum value.", "type": "string" } }, "additionalProperties": false }, "Response5197091": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197273": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196956": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197098": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197579": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5196980": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/BranchStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197624": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197454": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197721": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197455": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197145": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicWorkflowEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/EpicWorkflow" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197463": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CommitStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197581": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197754": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196842": { "type": "object", "properties": { "linked_file_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Linked Files to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "linked_file_ids" ] }, "Response5197028": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197714": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197132": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateObjectivesParams1": { "type": "object", "properties": { "id": { "description": "The id of the Objective to update.", "type": "integer", "format": "int64" }, "archived": { "description": "Whether the Objective is archived.", "type": "boolean" }, "category_ids": { "description": "An array of IDs of Categories to set on the Objective. Replaces current Categories.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "category_ids_add": { "description": "An array of IDs of Categories to add to the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "category_ids_remove": { "description": "An array of IDs of Categories to remove from the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "completed_at_override": { "description": "A manual override for the time/date the Objective was completed.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Objective's description.", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Objective.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Objective. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_add": { "description": "An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_remove": { "description": "An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "started_at_override": { "description": "A manual override for the time/date the Objective was started.", "type": "string", "format": "date-time", "nullable": true }, "state": { "description": "The workflow state of the Objective.", "type": "string", "enum": [ "in progress", "to do", "done" ] }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Objective. This will replace the current Teams on the Objective. Sending an empty array will remove all existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for Teams to add to the Objective. These will be added to the current Teams on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for Teams to remove from the Objective. These will be removed from the current Teams on the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197162": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196914": { "type": "object", "properties": { "stories": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Story to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateStoriesParams1" } } }, "additionalProperties": false, "required": [ "stories" ] }, "CreateEntityTemplateTaskParams": { "type": "object", "properties": { "description": { "maxLength": 2048, "minLength": 1, "description": "The Task description.", "type": "string" }, "complete": { "description": "True/false boolean indicating whether the Task is completed. Defaults to false.", "type": "boolean" }, "owner_ids": { "description": "An array of UUIDs for any members you want to add as Owners on this new Task.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "description" ] }, "Response5197445": { "type": "object", "additionalProperties": false, "properties": {} }, "CustomFieldEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/CustomField" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197395": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedReactionSlimList": { "description": "A list of Reactions to this Comment.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ReactionSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "ThreadedComment": { "description": "The entity for this response.", "type": "object", "properties": { "app_url": { "description": "The Shortcut application url for the Comment. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true }, "author": { "$ref": "#/components/schemas/MemberSlim" }, "comments": { "$ref": "#/components/schemas/NestedThreadedCommentSlimList" }, "created_at": { "description": "The time/date the Comment was created.", "type": "string", "format": "date-time" }, "deleted": { "description": "Whether the Comment has been deleted.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "threaded-comment" ] }, "epic": { "$ref": "#/components/schemas/EpicSlim" }, "external_id": { "description": "This field can be set to another unique ID. In the case that the Comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "id": { "description": "The unique ID of the Comment. Will be null if the comment is deleted.", "type": "integer", "format": "int64", "nullable": true }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "parent_comment": { "$ref": "#/components/schemas/ThreadedCommentSlim", "nullable": true }, "text": { "description": "The text of the Comment. Will be null if the comment is deleted.", "type": "string", "nullable": true }, "updated_at": { "description": "The time/date the Comment was last updated.", "type": "string", "format": "date-time" }, "uri": { "description": "A resolvable URI for the entity that will return the full representation. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true } }, "additionalProperties": false }, "Response5197520": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197128": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197418": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryIterationEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Iteration" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196973": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFileMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197485": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197046": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196864": { "type": "object", "properties": { "label_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Labels to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "label_ids" ] }, "Response5196937": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197631": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197549": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197324": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DisabledFeatureError" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197100": { "type": "object", "additionalProperties": false, "properties": {} }, "CurrentIterationsOutput": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Iteration" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196924": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WhoamiEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197347": { "type": "object", "additionalProperties": false, "properties": {} }, "CustomField": { "description": "The entity for this response.", "type": "object", "properties": { "canonical_name": { "description": "The canonical name of a Shortcut-defined Custom Field.", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Custom Field was created.", "type": "string", "format": "date-time" }, "description": { "description": "A description of the Custom Field.", "maxLength": 1024, "type": "string", "nullable": true }, "enabled": { "description": "Whether the Custom Field is enabled for the Workspace.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "custom-field" ] }, "field_type": { "description": "The type of the Custom Field (e.g. \"enum\").", "type": "string" }, "fixed_position": { "description": "Whether this Custom Field has a fixed position.", "type": "boolean" }, "icon_set_identifier": { "description": "An identifier for the icon set used for this Custom Field.", "maxLength": 63, "type": "string", "nullable": true }, "id": { "description": "The unique public ID for the Custom Field.", "type": "string", "format": "uuid" }, "name": { "maxLength": 63, "description": "The name of the Custom Field.", "type": "string" }, "position": { "description": "The display position of the Custom Field.", "type": "integer", "format": "int64", "nullable": true }, "story_types": { "description": "The story types this Custom Field applies to, if restricted.", "type": "array", "items": { "type": "string", "enum": [ "feature", "chore", "bug" ] }, "nullable": true }, "updated_at": { "description": "The time/date the Custom Field was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "values": { "description": "The ordered list of enum values for this Custom Field.", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" }, "nullable": true } }, "additionalProperties": false }, "Response5197456": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197111": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197511": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197567": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197812": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Story" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197464": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197417": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197657": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197745": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197266": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197032": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DocEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197287": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197429": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFileEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/LinkedFile" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "PullRequestSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "pull-request:slim" ] }, "id": { "description": "The unique ID of the Pull Request.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Pull Request.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197269": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197587": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197678": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196897": { "type": "object", "properties": { "objective_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Objectives to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "objective_ids" ] }, "Response5197375": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197413": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197607": { "type": "object", "additionalProperties": false, "properties": {} }, "HealthSlim": { "type": "object", "properties": { "created_at": { "description": "The time/date the Health was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "health:slim" ] }, "id": { "description": "The unique ID of the Health.", "type": "string", "format": "uuid" }, "status": { "description": "The status of the Health (On Track, At Risk, Off Track, No Health).", "type": "string" }, "updated_at": { "description": "The time/date the Health was last updated.", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "Response5197442": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197726": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197589": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197562": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197468": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateEntityTemplateSubTaskParams": { "type": "object", "properties": { "name": { "maxLength": 512, "minLength": 1, "description": "The name of the Sub-Task.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs of the owners of this Sub-Task.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "workflow_state_id": { "description": "The ID of the workflow state the Sub-Task is in.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197064": { "type": "object", "additionalProperties": false, "properties": {} }, "EntityTemplateEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/EntityTemplate" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "WorkflowProjectEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "TeamStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "NestedCommentSlimList": { "description": "A list of comments attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CommentSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5196984": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196911": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" } }, "additionalProperties": false }, "Response5197248": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197537": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197318": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197073": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197176": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196883": { "type": "object", "properties": { "completed": { "description": "True/false boolean indicating whether the Checklist Item is completed. Defaults to false.", "type": "boolean" }, "description": { "maxLength": 2048, "minLength": 1, "description": "The Checklist Item description.", "type": "string" }, "set_position": { "$ref": "#/components/schemas/Body5196883SetPosition" } }, "additionalProperties": false }, "Response5197181": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197381": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkspaceSlim": { "description": "The Workspace the caller is authenticated against.", "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Workspace.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "workspace:slim" ] }, "id": { "description": "The unique ID of the Workspace.", "type": "string", "format": "uuid" }, "name": { "description": "The name of the Workspace.", "type": "string" }, "slug": { "description": "The URL Slug for the Workspace (aka `workspace-slug`).", "type": "string" } }, "additionalProperties": false }, "Body5196861": { "type": "object", "properties": { "story_link_ids": { "minItems": 1, "maxItems": 100, "description": "IDs of the Story Links to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "story_link_ids" ] }, "Response5197154": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197125": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197399": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197087": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197037": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowProjectEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "TokenAuthorization": { "description": "The authorization details for the token used to authenticate this request.", "type": "object", "properties": { "scopes": { "description": "The scopes granted by the token. Possible values are \"read\", \"write\", \"story-write\", \"comment-write\", and \"admin\".", "type": "array", "items": { "type": "string" } } }, "additionalProperties": false }, "Response5196974": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196983": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197448": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197503": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197075": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryLink": { "description": "The entity for this response.", "type": "object", "properties": { "created_at": { "description": "The time/date the Story Link was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "story-link" ] }, "id": { "description": "The unique identifier of the Story Link.", "type": "integer", "format": "int64" }, "object": { "$ref": "#/components/schemas/StorySlim" }, "subject": { "$ref": "#/components/schemas/StorySlim" }, "updated_at": { "description": "The time/date the Story Link was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "verb": { "description": "How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\".", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] } }, "additionalProperties": false }, "Response5197203": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197425": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197494": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197286": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197382": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197179": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197013": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveOwnerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "BranchStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197136": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197194": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentReactionEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Member": { "description": "The Member the caller is authenticated as.", "type": "object", "properties": { "created_at": { "description": "The time/date the Member was created.", "type": "string", "format": "date-time" }, "disabled": { "description": "True if the Member is disabled (no longer has access to the Workspace).", "type": "boolean" }, "email_address": { "description": "The Member's email address.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "member" ] }, "id": { "description": "The unique ID of the Member.", "type": "string", "format": "uuid" }, "mention_name": { "description": "The Member's mention name, used to @mention them in text fields.", "type": "string" }, "name": { "description": "The full name of the Member.", "type": "string" }, "role": { "description": "The role of the Member in the Workspace.", "type": "string" }, "teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "updated_at": { "description": "The time/date the Member was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "NestedKeyResultSlimList": { "description": "The Key Results associated with the Objective.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/KeyResultSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197290": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveKeyResultEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/KeyResult" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197765": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryCommitEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Commit" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197307": { "type": "object", "additionalProperties": false, "properties": {} }, "File": { "type": "object", "properties": { "content_type": { "description": "The content type of the File.", "type": "string" }, "created_at": { "description": "The time/date the File was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the File.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "file" ] }, "external_id": { "description": "This field can be set to another unique ID. In the case that the File has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "id": { "description": "The unique ID for the File.", "type": "integer", "format": "int64" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "name": { "description": "The name of the File.", "type": "string" }, "size": { "description": "The size of the File in bytes.", "type": "integer", "format": "int64" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "thumbnail_url": { "description": "The URL of the thumbnail for the File.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true }, "updated_at": { "description": "The time/date the File was last updated.", "type": "string", "format": "date-time" }, "uploader": { "$ref": "#/components/schemas/MemberSlim" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL for the File.", "type": "string" } }, "additionalProperties": false }, "Response5197577": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196930": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197078": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectFollowerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197344": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197074": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197801": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197535": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197675": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationFollowerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197469": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197289": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "BulkUpdateMembersParams1": { "type": "object", "properties": { "id": { "description": "The unique ID of the Member to update.", "type": "string", "format": "uuid" }, "disabled": { "description": "Set to true to disable the Member, false to re-enable them.", "type": "boolean" }, "role": { "description": "The new role to assign to the Member. One of \"admin\", \"member\", or \"observer\".", "type": "string", "enum": [ "member", "observer", "admin" ] } }, "additionalProperties": false, "required": [ "id" ] }, "Repository": { "type": "object", "properties": { "branches": { "$ref": "#/components/schemas/NestedBranchSlimList" }, "commits": { "$ref": "#/components/schemas/NestedCommitSlimList" }, "created_at": { "description": "The time/date the Repository was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "repository" ] }, "external_url": { "description": "The URL of the Repository in the VCS provider.", "type": "string" }, "full_name": { "description": "The full name of the Repository (e.g. owner/repo-name).", "type": "string" }, "id": { "description": "The unique ID of the Repository.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Repository.", "type": "string" }, "pull_requests": { "$ref": "#/components/schemas/NestedPullRequestSlimList" }, "updated_at": { "description": "The time/date the Repository was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "NestedStoryLinkSlimList": { "description": "A list of Story links attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/StoryLinkSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197369": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197488": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197226": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197211": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197322": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196840": { "type": "object", "properties": { "after_id": { "description": "Move this Custom Field to after the field with this ID.", "type": "string", "format": "uuid" }, "before_id": { "description": "Move this Custom Field to before the field with this ID.", "type": "string", "format": "uuid" }, "description": { "maxLength": 1024, "description": "A description of the Custom Field.", "type": "string" }, "enabled": { "description": "Whether the Custom Field is enabled.", "type": "boolean" }, "icon_set_identifier": { "maxLength": 63, "minLength": 1, "description": "An identifier for the icon set for this Custom Field.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The name of the Custom Field.", "type": "string" }, "values": { "description": "The ordered list of enum values. Existing values not included will be deleted.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomFieldEnumValueParams" } }, "values_add": { "description": "Enum values to add to the Custom Field. Existing values are unchanged.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateCustomFieldEnumValueParams" } }, "values_remove": { "description": "IDs of enum values to remove from the Custom Field.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Response5197820": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197062": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196960": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197236": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196837": { "type": "object", "properties": { "archived": { "description": "Controls the Story's archived state.", "type": "boolean" }, "custom_field_values": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. This will replace the current Custom Field values on the Story. Sending an empty array will delete all existing Custom Field values.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_field_values_add": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be added to the current Custom Field values on the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_field_values_remove": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be removed from the current Custom Field values on the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the Story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the Epic the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate of the Story. Can also be null, which means unestimated.", "type": "integer", "format": "int64", "nullable": true }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "external_links": { "description": "An array of External Links associated with the Story. This will replace the current External Links on the Story. Sending an empty array will delete all existing External Links.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "external_links_add": { "description": "An array of External Links associated with the Story. These will be added to the current External Links on the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "external_links_remove": { "description": "An array of External Links associated with the Story. These will be removed from the current External Links on the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "file_ids": { "description": "An array of IDs of Files attached to the Story. This will replace the current Files on the Story. Sending an empty array will delete all existing Files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_add": { "description": "An array of IDs of Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_remove": { "description": "An array of IDs of Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs of the Members that follow this Story. This will replace the current Followers on the Story. Sending an empty array will delete all existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "follower_ids_add": { "description": "An array of UUIDs of the Members that follow this Story. These will be added to the current followers on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "follower_ids_remove": { "description": "An array of UUIDs of the Members that follow this Story. These will be removed from the current followers on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "iteration_id": { "description": "The ID of the Iteration the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "Labels to attach to the Story. This will replace the current Labels on the Story. Sending an empty array will delete all existing Labels.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_add": { "description": "Labels to attach to the Story. These will be added to the current Labels on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_remove": { "description": "Labels to detach from the Story. These will be removed to the current Labels on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of IDs of Linked Files attached to the Story. This will replace the current Linked Files on the Story. Sending an empty array will delete all existing Linked Files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_add": { "description": "An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_remove": { "description": "An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "name": { "maxLength": 512, "minLength": 1, "description": "The name of the Story.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs of the Members that own this Story. This will replace the current Owners on the Story. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "owner_ids_add": { "description": "An array of UUIDs of the Members that own this Story. These will be added to the current owners on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "owner_ids_remove": { "description": "An array of UUIDs of the Members that own this Story. These will be removed from the current owners on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "parent_story_id": { "description": "The ID of the parent Story to associate with this Story (making the Story a sub-task).\nField only applicable when Sub-task feature is enabled.", "type": "integer", "format": "int64", "nullable": true }, "project_id": { "description": "The ID of the Project the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "requester_id": { "description": "The ID of the Member that requested the Story. Will default to the Member making the API call if not provided.", "type": "string", "format": "uuid" }, "set_position": { "$ref": "#/components/schemas/Body5196837SetPosition" }, "story_type": { "description": "The type of Story (feature, bug, chore).", "type": "string", "enum": [ "feature", "chore", "bug" ] }, "team_id": { "description": "The id of the Team to associate with this Story.", "type": "string", "format": "uuid", "nullable": true }, "workflow_state_id": { "description": "The ID of the Workflow State to move the Story to.", "type": "integer", "format": "int64" } }, "additionalProperties": false }, "Response5197227": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197826": { "type": "object", "additionalProperties": false, "properties": {} }, "CategoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197301": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196878": { "type": "object", "properties": { "file_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Files to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "file_ids" ] }, "PullRequest": { "type": "object", "properties": { "branch": { "$ref": "#/components/schemas/BranchSlim" }, "closed": { "description": "True/False boolean indicating whether the VCS Pull Request has been closed.", "type": "boolean" }, "created_at": { "description": "The time/date the Pull Request was created.", "type": "string", "format": "date-time" }, "draft": { "description": "True/False boolean indicating whether the Pull Request is in draft state.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "pull-request" ] }, "external_id": { "description": "The Pull Request's id in the VCS provider.", "type": "string" }, "external_url": { "description": "The URL for the Pull Request in the VCS provider.", "type": "string" }, "id": { "description": "The unique ID of the Pull Request.", "type": "integer", "format": "int64" }, "repository": { "$ref": "#/components/schemas/RepositorySlim" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "target_branch": { "$ref": "#/components/schemas/BranchSlim" }, "title": { "description": "The title of the Pull Request.", "type": "string" }, "updated_at": { "description": "The time/date the Pull Request was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197090": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryObjectiveEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196917": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" }, "author_id": { "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token. Requires the admin role to set.", "type": "string", "format": "uuid" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "parent_comment_id": { "description": "The ID of the Comment to reply to. When provided, creates a threaded reply rather than a top-level Comment.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "text" ] }, "NestedHealthSlimList": { "description": "The Health updates on the Objective.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/HealthSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197837": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197506": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197219": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197383": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197699": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196932": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196885": { "type": "object", "properties": { "archived": { "description": "Whether the Epic is archived.", "type": "boolean" }, "completed_at_override": { "description": "A manual override for the time/date the Epic was completed.", "type": "string", "format": "date-time", "nullable": true }, "deadline": { "description": "The Epic's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Epic's description.", "type": "string" }, "epic_state_id": { "description": "The ID of the Epic State.", "type": "integer", "format": "int64" }, "external_id": { "maxLength": 128, "description": "An external ID for the Epic.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for Members to set as Followers. This will replace the current Followers on the Epic. Sending an empty array will delete all existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "An array of UUIDs for Members to add as Followers. These will be added to the current Followers on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "An array of UUIDs for Members to remove as Followers. These will be removed from the current Followers on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "maxLength": 256, "minLength": 1, "description": "The Epic's name.", "type": "string" }, "objective_ids": { "description": "An array of IDs for Objectives to which this Epic is related. This will replace the current Objectives on the Epic. Sending an empty array will remove all existing Objectives.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "objective_ids_add": { "description": "An array of IDs for Objectives to add to the Epic. These will be added to the current Objectives on the Epic.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "objective_ids_remove": { "description": "An array of IDs for Objectives to remove from the Epic. These will be removed from the current Objectives on the Epic.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "owner_ids": { "description": "An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Epic. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_add": { "description": "An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_remove": { "description": "An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "planned_start_date": { "description": "The Epic's planned start date.", "type": "string", "format": "date-time", "nullable": true }, "requested_by_id": { "description": "The UUID of the Member that requested the Epic.", "type": "string", "format": "uuid" }, "started_at_override": { "description": "A manual override for the time/date the Epic was started.", "type": "string", "format": "date-time", "nullable": true }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Epic. This will replace the current Teams on the Epic. Sending an empty array will remove all existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for Teams to add to the Epic. These will be added to the current Teams on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for Teams to remove from the Epic. These will be removed from the current Teams on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Response5196928": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197530": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197755": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowStateEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197700": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateStoryLinkParams": { "type": "object", "properties": { "object_story_id": { "description": "The unique ID of the Story defined as object.", "type": "integer", "format": "int64" }, "subject_story_id": { "description": "The unique ID of the Story defined as subject.", "type": "integer", "format": "int64" }, "verb": { "description": "How the subject Story acts on the object Story. This can be one of: \"blocks\", \"duplicates\", \"relates to\"", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] } }, "additionalProperties": false, "required": [ "verb", "object_story_id", "subject_story_id" ] }, "NestedChecklistItemSlimList": { "description": "A list of Checklist Items attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ChecklistItemSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197802": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197052": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196925": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197512": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedWorkflowSlimList": { "description": "A list of Workflows associated with this Team.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197640": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197142": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicStateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197734": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197566": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197323": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197173": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196996": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197778": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197470": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196992": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryPullRequestEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197688": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197591": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197527": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197813": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197759": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197518": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196962": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197696": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196985": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197793": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197723": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryFollowerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196835": { "type": "object", "properties": { "end_date": { "minLength": 1, "description": "The date this Iteration ends (ISO 8601 date format, e.g. '2024-01-15').", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of this Iteration.", "type": "string" }, "start_date": { "minLength": 1, "description": "The date this Iteration begins (ISO 8601 date format, e.g. '2024-01-01').", "type": "string" }, "description": { "maxLength": 100000, "description": "The description of the Iteration.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids": { "description": "An array of UUIDs for any Teams you want to associate with the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name", "start_date", "end_date" ] }, "Response5197672": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197790": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196934": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197006": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197617": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197743": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197788": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197255": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5196967": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197685": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197497": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197277": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196903": { "type": "object", "properties": { "iteration_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Iterations to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "iteration_ids" ] }, "PullRequestStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197462": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197845": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197151": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicWorkflow": { "description": "The entity for this response.", "type": "object", "properties": { "created_at": { "description": "The time/date the Epic Workflow was created.", "type": "string", "format": "date-time" }, "default_epic_state": { "$ref": "#/components/schemas/EpicStateSlim" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "epic-workflow" ] }, "epic_states": { "$ref": "#/components/schemas/NestedEpicStateList" }, "id": { "description": "The unique ID of the Epic Workflow.", "type": "integer", "format": "int64" }, "updated_at": { "description": "The time/date the Epic Workflow was last updated.", "type": "string", "format": "date-time" } }, "additionalProperties": false }, "EpicCommentEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/ThreadedComment" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197635": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StorySlim": { "description": "The Story this Checklist Item belongs to.", "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Story.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "story:slim" ] }, "id": { "description": "The unique ID of the Story.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Story.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197212": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197292": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197749": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197680": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197186": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197358": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/BranchEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197804": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196927": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196887": { "type": "object", "properties": { "object_story_id": { "description": "The unique ID of the Story defined as object.", "type": "integer", "format": "int64" }, "subject_story_id": { "description": "The unique ID of the Story defined as subject.", "type": "integer", "format": "int64" }, "verb": { "description": "How the subject Story acts on the object Story. This can be one of: \"blocks\", \"duplicates\", \"relates to\"", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] } }, "additionalProperties": false, "required": [ "verb", "object_story_id", "subject_story_id" ] }, "Response5197768": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197008": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196834": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The updated template name.", "type": "string" }, "story_contents": { "$ref": "#/components/schemas/UpdateEntityTemplateStoryContentsParams" } }, "additionalProperties": false }, "Response5197770": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkflowState": { "type": "object", "properties": { "color": { "description": "The color of the Workflow State.", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Workflow State was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of what sort of Stories belong in that Workflow State.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "workflow-state" ] }, "id": { "description": "The unique ID of the Workflow State.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Workflow State.", "type": "string" }, "num_stories": { "description": "The number of Stories currently in that Workflow State.", "type": "integer", "format": "int64" }, "num_story_templates": { "description": "The number of Story Templates associated with that Workflow State.", "type": "integer", "format": "int64" }, "position": { "description": "The position that the Workflow State is in, starting with 0 at the left.", "type": "integer", "format": "int64" }, "type": { "description": "The type of the Workflow State (backlog, unstarted, started, done).", "type": "string" }, "updated_at": { "description": "The time/date the Workflow State was last updated.", "type": "string", "format": "date-time" }, "verb": { "description": "The verb that triggers a move to that Workflow State when making VCS commits.", "type": "string", "nullable": true }, "workflow": { "$ref": "#/components/schemas/WorkflowSlim" } }, "additionalProperties": false }, "Response5197101": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197192": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196896": { "type": "object", "properties": { "name": { "maxLength": 512, "minLength": 1, "description": "The name of the Story.", "type": "string" }, "workflow_state_id": { "description": "The ID of the Workflow State the Story will be in.", "type": "integer", "format": "int64" }, "archived": { "description": "Controls the Story's archived state.", "type": "boolean" }, "checklist_items": { "description": "An array of Checklist Items connected to the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryChecklistItemParams" } }, "custom_field_values": { "description": "An array of objects specifying a Custom Field value ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field value.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the Story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the Epic the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate of the Story. Can also be null, which means unestimated.", "type": "integer", "format": "int64", "nullable": true }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "external_links": { "description": "An array of External Links associated with the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "file_ids": { "description": "An array of IDs of Files attached to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs of the Members that follow this Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "iteration_id": { "description": "The ID of the Iteration the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "Labels to attach to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of IDs of Linked Files attached to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "owner_ids": { "description": "An array of UUIDs of the Members that own this Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "parent_story_id": { "description": "The ID of the parent Story to associate with this Story (making the Story a sub-task).\nField only applicable when Sub-task feature is enabled.", "type": "integer", "format": "int64", "nullable": true }, "project_id": { "description": "The ID of the Project the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "requester_id": { "description": "The ID of the Member that requested the Story. Will default to the Member making the API call if not provided.", "type": "string", "format": "uuid" }, "set_position": { "$ref": "#/components/schemas/Body5196896SetPosition" }, "story_links": { "description": "An array of Story links attached to the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateNestedStoryLinkParams" } }, "story_type": { "description": "The type of Story (feature, bug, chore).", "type": "string", "enum": [ "feature", "chore", "bug" ] }, "team_id": { "description": "The id of the Team to associate with this Story.", "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "required": [ "name", "workflow_state_id" ] }, "Response5197727": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryStoryLinkEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197408": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197043": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateCategoryParams": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new Category.", "type": "string" }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Category (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "external_id": { "maxLength": 128, "minLength": 1, "description": "An optional external ID for the Category.", "type": "string" } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197065": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197621": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkspaceTokenEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Token" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197298": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197105": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197524": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197592": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196955": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197646": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197357": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197149": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197265": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197516": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197645": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196852": { "type": "object", "properties": { "entity_templates": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Entity Template to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEntityTemplateParams" } } }, "additionalProperties": false, "required": [ "entity_templates" ] }, "Response5197728": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196899": { "type": "object", "properties": { "objectives": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Objective to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateObjectiveParams" } } }, "additionalProperties": false, "required": [ "objectives" ] }, "Body5196905": { "type": "object", "properties": { "iterations": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Iteration to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateIterationParams" } } }, "additionalProperties": false, "required": [ "iterations" ] }, "Response5197707": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "CreateStoryCommentParams": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" }, "author_id": { "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token. Requires the admin role to set.", "type": "string", "format": "uuid" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "parent_comment_id": { "description": "The ID of the Comment that this comment is threaded under.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "text" ] }, "Response5197135": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197229": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicStateSlim": { "description": "The current Epic State.", "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "epic-state:slim" ] }, "id": { "description": "The unique ID of the Epic State.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Epic State.", "type": "string" }, "type": { "description": "The type of the Epic State (unstarted, started, done).", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "type" ] }, "Response5197150": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryPullRequestEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/PullRequest" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197762": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197783": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEpicEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197367": { "type": "object", "additionalProperties": false, "properties": {} }, "MemberEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Member" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197327": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197796": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197544": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197694": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197222": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/UnusableEntitlementError" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197185": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197550": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197684": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196841": { "type": "object", "properties": { "members": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Member to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateMembersParams1" } } }, "additionalProperties": false, "required": [ "members" ] }, "EpicFollowerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197613": { "type": "object", "additionalProperties": false, "properties": {} }, "RepositoryPullRequestEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/PullRequest" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197449": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197689": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197555": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197403": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197225": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197160": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196828": { "type": "object", "properties": { "checklist_items": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Checklist Item to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateStoryChecklistItemsParams1" } } }, "additionalProperties": false, "required": [ "checklist_items" ] }, "LabelEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Label" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197499": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CustomFieldStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197586": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197005": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197394": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "CustomFieldSlim": { "description": "The Custom Field for this value.", "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "custom-field:slim" ] }, "id": { "description": "The unique public ID for the Custom Field.", "type": "string", "format": "uuid" }, "name": { "description": "The name of the Custom Field.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197370": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/KeyResultEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197157": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateStoryChecklistItemParams": { "description": "Request parameters for creating a Checklist Item on a Story.", "type": "object", "properties": { "description": { "maxLength": 2048, "minLength": 1, "description": "The Checklist Item description.", "type": "string" }, "completed": { "description": "True/false boolean indicating whether the Checklist Item is completed. Defaults to false.", "type": "boolean" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Checklist Item has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "set_position": { "$ref": "#/components/schemas/Body5196829ChecklistItemsSetPosition" } }, "additionalProperties": false, "required": [ "description" ] }, "BulkUpdateStoryChecklistItemsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Checklist Item to update.", "type": "integer", "format": "int64" }, "completed": { "description": "True/false boolean indicating whether the Checklist Item is completed. Defaults to false.", "type": "boolean" }, "description": { "maxLength": 2048, "minLength": 1, "description": "The Checklist Item description.", "type": "string" }, "set_position": { "$ref": "#/components/schemas/Body5196828ChecklistItemsSetPosition" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197501": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197165": { "type": "object", "additionalProperties": false, "properties": {} }, "FileStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "NestedStorySlimList": { "description": "A list of Stories associated with this Project.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/StorySlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197644": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197496": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197785": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197776": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationSlim": { "description": "The Iteration the story belongs to.", "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Iteration.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "iteration:slim" ] }, "id": { "description": "The unique ID of the Iteration.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Iteration.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197618": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196829": { "type": "object", "properties": { "checklist_items": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Checklist Item to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryChecklistItemParams" } } }, "additionalProperties": false, "required": [ "checklist_items" ] }, "Response5197430": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196921": { "type": "object", "properties": { "teams": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Team to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateTeamsParams1" } } }, "additionalProperties": false, "required": [ "teams" ] }, "UpdateCustomFieldEnumValueParams": { "type": "object", "properties": { "color_key": { "description": "The color key for this enum value. Pass null to clear.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "nullable": true }, "enabled": { "description": "Whether this enum value is enabled.", "type": "boolean" }, "id": { "description": "The ID of an existing enum value to update. Omit to create a new value.", "type": "string", "format": "uuid" }, "value": { "maxLength": 63, "minLength": 1, "description": "The string value for this enum value.", "type": "string" } }, "additionalProperties": false }, "Response5197313": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197387": { "type": "object", "additionalProperties": false, "properties": {} }, "Epic": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Epic.", "type": "string" }, "archived": { "description": "Whether the Epic is archived.", "type": "boolean" }, "comments": { "$ref": "#/components/schemas/NestedThreadedCommentSlimList" }, "completed": { "description": "Whether the Epic is completed.", "type": "boolean" }, "completed_at": { "description": "The time/date the Epic was completed.", "type": "string", "format": "date-time", "nullable": true }, "completed_at_override": { "description": "A manual override for the time/date the Epic was completed.", "type": "string", "format": "date-time", "nullable": true }, "created_at": { "description": "The time/date the Epic was created.", "type": "string", "format": "date-time" }, "deadline": { "description": "The Epic's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "description": "The Epic's description.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "epic" ] }, "epic_state": { "$ref": "#/components/schemas/EpicStateSlim" }, "external_id": { "description": "An external ID that can be used to identify the Epic.", "type": "string", "nullable": true }, "followers": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "healths": { "$ref": "#/components/schemas/NestedHealthSlimList" }, "id": { "description": "The unique ID of the Epic.", "type": "integer", "format": "int64" }, "labels": { "$ref": "#/components/schemas/NestedLabelSlimList" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "name": { "description": "The name of the Epic.", "type": "string" }, "objectives": { "$ref": "#/components/schemas/NestedObjectiveSlimList" }, "owners": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "planned_start_date": { "description": "The Epic's planned start date.", "type": "string", "format": "date-time", "nullable": true }, "requester": { "$ref": "#/components/schemas/MemberSlim", "nullable": true }, "started": { "description": "Whether the Epic has been started.", "type": "boolean" }, "started_at": { "description": "The time/date the Epic was started.", "type": "string", "format": "date-time", "nullable": true }, "started_at_override": { "description": "A manual override for the time/date the Epic was started.", "type": "string", "format": "date-time", "nullable": true }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "updated_at": { "description": "The time/date the Epic was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "FileEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/File" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197316": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CommitEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197540": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197799": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "WhoamiEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Whoami" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197331": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197554": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedEpicStateList": { "description": "A list of Epic States in the Epic Workflow.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EpicState" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197361": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197161": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFile": { "type": "object", "properties": { "content_type": { "description": "The content type of the linked file.", "maxLength": 128, "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Linked File was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Linked File.", "maxLength": 512, "type": "string", "nullable": true }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "linked-file" ] }, "id": { "description": "The unique ID of the Linked File.", "type": "integer", "format": "int64" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "name": { "maxLength": 256, "description": "The name of the Linked File.", "type": "string" }, "size": { "description": "The size of the Linked File, if available.", "type": "integer", "format": "int64", "nullable": true }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "thumbnail_url": { "description": "The URL of the thumbnail, if the integration provided it.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true }, "type": { "maxLength": 63, "description": "The integration type (e.g. google, dropbox, box, onedrive, url).", "type": "string" }, "updated_at": { "description": "The time/date the Linked File was updated.", "type": "string", "format": "date-time" }, "uploader": { "$ref": "#/components/schemas/MemberSlim" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the Linked File.", "type": "string" } }, "additionalProperties": false }, "Response5197841": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197406": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DocEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197177": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196976": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/RepositoryCommitEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196900": { "type": "object", "properties": { "comment_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Comments to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "comment_ids" ] }, "Response5197807": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryFollowerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197254": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateTeamParams": { "type": "object", "properties": { "mention_name": { "pattern": "^[a-z0-9\\-\\_\\.]+$", "minLength": 1, "description": "The Team's mention name.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The Team's name.", "type": "string" }, "workflow_ids": { "minItems": 1, "maxItems": 100, "description": "An array of IDs for Workflows to associate with the Team. At least one Workflow is required.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Team (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "color_key": { "description": "The color key to be displayed with the Team.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ] }, "default_workflow_id": { "description": "The ID of the default Workflow for Stories created in this Team.", "type": "integer", "format": "int64" }, "description": { "maxLength": 4096, "description": "The Team's description.", "type": "string" }, "member_ids": { "description": "An array of UUIDs for Members to add to the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name", "mention_name", "workflow_ids" ] }, "Response5197653": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197483": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197204": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197828": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197808": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196933": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197716": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196860": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new Category.", "type": "string" }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Category (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "external_id": { "maxLength": 128, "minLength": 1, "description": "An optional external ID for the Category.", "type": "string" } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197615": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryOwnerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197648": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197533": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196889": { "type": "object", "properties": { "description": { "maxLength": 100000, "description": "The description of the Iteration.", "type": "string" }, "end_date": { "minLength": 1, "description": "The date this Iteration ends (ISO 8601 date format, e.g. '2024-01-15').", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for any Members you want to set as Followers, replacing existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "An array of UUIDs for any Members you want to remove as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of this Iteration.", "type": "string" }, "start_date": { "minLength": 1, "description": "The date this Iteration begins (ISO 8601 date format, e.g. '2024-01-01').", "type": "string" }, "team_ids": { "description": "An array of UUIDs for any Teams you want to set on the Iteration, replacing existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for any Teams you want to add to the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for any Teams you want to remove from the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false }, "Response5197102": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197045": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197803": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197629": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197585": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196915StoriesChecklistItemsSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197686": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197558": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197777": { "type": "object", "additionalProperties": false, "properties": {} }, "CustomFieldEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/CustomField" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197172": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197561": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196902": { "type": "object", "properties": { "comments": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Comment to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEpicCommentParams" } } }, "additionalProperties": false, "required": [ "comments" ] }, "Response5197583": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryCommentReactionEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Reaction" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197636": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197596": { "type": "object", "additionalProperties": false, "properties": {} }, "ProjectStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197148": { "type": "object", "additionalProperties": false, "properties": {} }, "DocFollowerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196829ChecklistItemsSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197667": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197260": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197309": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197296": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CustomFieldEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "WorkflowEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197340": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197472": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197738": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197691": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197434": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197127": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197303": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196850": { "type": "object", "properties": { "entity_template_ids": { "minItems": 1, "maxItems": 100, "description": "UUIDs of the Entity Templates to delete.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "entity_template_ids" ] }, "Response5197797": { "type": "object", "additionalProperties": false, "properties": {} }, "Commit": { "type": "object", "properties": { "author": { "$ref": "#/components/schemas/MemberSlim", "nullable": true }, "created_at": { "description": "The time/date the Commit was created.", "type": "string", "format": "date-time" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "commit" ] }, "external_url": { "description": "The URL of the Commit in the VCS provider.", "type": "string" }, "hash": { "description": "The Commit hash.", "type": "string" }, "id": { "description": "The unique ID of the Commit.", "type": "integer", "format": "int64" }, "message": { "description": "The Commit message, truncated to the first line (up to 1024 characters).", "type": "string" }, "repository": { "$ref": "#/components/schemas/RepositorySlim" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "timestamp": { "description": "The time/date the Commit was pushed.", "type": "string", "format": "date-time" }, "updated_at": { "description": "The time/date the Commit was updated.", "type": "string", "format": "date-time", "nullable": true }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Body5196854": { "type": "object", "properties": { "epics": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Epic to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateEpicsParams1" } } }, "additionalProperties": false, "required": [ "epics" ] }, "Response5197193": { "type": "object", "additionalProperties": false, "properties": {} }, "CommentSlim": { "type": "object", "properties": { "app_url": { "description": "The Shortcut application url for the Comment. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true }, "deleted": { "description": "True if the comment has been deleted.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "comment:slim" ] }, "id": { "description": "The unique ID of the Comment. Will be null if the comment is deleted.", "type": "integer", "format": "int64", "nullable": true }, "text": { "description": "The text of the Comment. Will be null if the comment is deleted.", "type": "string", "nullable": true }, "uri": { "description": "A resolvable URI for the entity that will return the full representation. Will be null if the comment is deleted.", "pattern": "^https?://.+$", "maxLength": 2048, "type": "string", "nullable": true } }, "additionalProperties": false, "required": [ "app_url", "deleted", "entity_type", "id", "text", "uri" ] }, "Response5197576": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197630": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197695": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/RepositoryPullRequestEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197027": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197140": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197022": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197196": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197853": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197051": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197758": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197083": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197559": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197041": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197268": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkedFileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197377": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196943": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197346": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197076": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197597": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197137": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197423": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "WorkflowStateEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/WorkflowState" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197513": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197748": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197108": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197129": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197637": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196914StoriesSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the given story to the first or last position in the Workflow State, or before or after a given Story.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_story_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197390": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationLabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "MemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197681": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197233": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197769": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197044": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197598": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197654": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryTemplateSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "story-template:slim" ] }, "id": { "description": "The unique ID of the Story Template.", "type": "string", "format": "uuid" }, "name": { "description": "The name of the Story Template.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "StoryChecklistItemMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196891": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" } }, "additionalProperties": false }, "Response5197517": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196936": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197847": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197528": { "type": "object", "additionalProperties": false, "properties": {} }, "DocEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Doc" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197368": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196965": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197096": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196929": { "type": "object", "additionalProperties": false, "properties": {} }, "StorySubTaskStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "StoryLinkSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "story-link:slim" ] }, "id": { "description": "The unique identifier of the Story Link.", "type": "integer", "format": "int64" }, "object": { "$ref": "#/components/schemas/StorySlim" }, "subject": { "$ref": "#/components/schemas/StorySlim" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "verb": { "description": "How the subject Story acts on the object Story. This can be \"blocks\", \"duplicates\", or \"relates to\".", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "object", "subject", "uri", "verb" ] }, "StoryLinkEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/StoryLink" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197402": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamWorkflowEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197825": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196958": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicCommentCommentEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ThreadedComment" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197198": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197492": { "type": "object", "additionalProperties": false, "properties": {} }, "UpdateStoryLinkParams": { "type": "object", "properties": { "id": { "description": "The unique ID of the Story Link to update.", "type": "integer", "format": "int64" }, "object_story_id": { "description": "The unique ID of the Story defined as object.", "type": "integer", "format": "int64" }, "subject_story_id": { "description": "The unique ID of the Story defined as subject.", "type": "integer", "format": "int64" }, "verb": { "description": "How the subject Story acts on the object Story. This can be one of: \"blocks\", \"duplicates\", \"relates to\"", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197609": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197731": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197372": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197800": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197732": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197737": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197119": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197493": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197789": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197671": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "WorkflowEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Workflow" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "IterationEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Iteration" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197431": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197458": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197603": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveCategoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197021": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197317": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197541": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197110": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "FileMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197710": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196894": { "type": "object", "properties": { "story_id": { "description": "The ID of the Story to attach the files to.", "type": "integer", "format": "int64" } }, "additionalProperties": {} }, "Response5197588": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197687": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197854": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedWorkflowStateSlimList": { "description": "A list of Workflow States in the Workflow.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowStateSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197285": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197084": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197509": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197351": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedCommitSlimList": { "description": "A list of commits attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CommitSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197141": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryCommentReactionEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Reaction" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196950": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197773": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196919": { "type": "object", "properties": { "comments": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Comment to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateStoryCommentsParams1" } } }, "additionalProperties": false, "required": [ "comments" ] }, "Response5197676": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197163": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196881": { "type": "object", "properties": { "archived": { "description": "A true/false boolean indicating if the Category has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Category (for example, \"#ff0000\").", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "name": { "maxLength": 128, "minLength": 1, "description": "The name of the Category.", "type": "string" } }, "additionalProperties": false }, "Response5197113": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197482": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197539": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/PullRequestStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197312": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196872": { "type": "object", "properties": { "description": { "maxLength": 512, "description": "The description of the Linked File.", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Linked File.", "type": "string" }, "thumbnail_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the thumbnail.", "type": "string" }, "type": { "maxLength": 63, "minLength": 1, "description": "The integration type (e.g. google, dropbox, box, onedrive, url).", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the Linked File.", "type": "string" } }, "additionalProperties": false }, "Response5197649": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197421": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197170": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197276": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/PullRequestEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196922": { "type": "object", "properties": { "teams": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Team to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateTeamParams" } } }, "additionalProperties": false, "required": [ "teams" ] }, "Response5196970": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197171": { "type": "object", "additionalProperties": false, "properties": {} }, "KeyResultEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/KeyResult" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197291": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197010": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197224": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197573": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197521": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197280": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197795": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197498": { "type": "object", "additionalProperties": false, "properties": {} }, "HealthEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Health" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197643": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197729": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicSlim": { "description": "The Epic the story belongs to.", "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Epic.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "epic:slim" ] }, "id": { "description": "The unique ID of the Epic.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Epic.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197239": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "ProjectEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Project" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "WorkflowTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "CreateCustomFieldValueParams": { "type": "object", "properties": { "field_id": { "description": "The unique public ID for the Custom Field value.", "type": "string", "format": "uuid" }, "value_id": { "description": "The unique public ID for the CustomFieldEnumValue.", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "field_id", "value_id" ] }, "Response5196990": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197159": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197104": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197775": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197708": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196941": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197217": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196944": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196847": { "type": "object", "properties": { "object_story_id": { "description": "The unique ID of the Story defined as object.", "type": "integer", "format": "int64" }, "subject_story_id": { "description": "The unique ID of the Story defined as subject.", "type": "integer", "format": "int64" }, "verb": { "description": "How the subject Story acts on the object Story. This can be one of: \"blocks\", \"duplicates\", \"relates to\"", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] } }, "additionalProperties": false }, "Response5197283": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197264": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197138": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEpicEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "ChecklistItemSlim": { "type": "object", "properties": { "description": { "description": "The description of the Checklist Item.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "checklist-item:slim" ] }, "id": { "description": "The unique ID of the Checklist Item.", "type": "integer", "format": "int64" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "description", "uri" ] }, "CommitEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Commit" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197232": { "type": "object", "additionalProperties": false, "properties": {} }, "TeamWorkflowEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196988": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197674": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196828ChecklistItemsSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197575": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StorySubTaskStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryLinkEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/StoryLink" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197050": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197349": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196862": { "type": "object", "properties": { "story_links": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Story Link to update.", "type": "array", "items": { "$ref": "#/components/schemas/UpdateStoryLinkParams" } } }, "additionalProperties": false, "required": [ "story_links" ] }, "Response5197839": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicLabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197114": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicFollowerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197650": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196982": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196949": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197363": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197719": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryExternalLinkEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197466": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197221": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197786": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197214": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197543": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197122": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197622": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197001": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197040": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197112": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197352": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicStateEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/EpicState" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197628": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197843": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197256": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197319": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197656": { "type": "object", "additionalProperties": false, "properties": {} }, "Team": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Team.", "type": "string" }, "archived": { "description": "True if the Team has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Team (for example, \"#ff0000\").", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "color_key": { "description": "The color key to be displayed with the Team.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "nullable": true }, "created_at": { "description": "The time/date the Team was created.", "type": "string", "format": "date-time" }, "default_workflow": { "$ref": "#/components/schemas/WorkflowSlim", "nullable": true }, "description": { "description": "The description of the Team.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "team" ] }, "id": { "description": "The unique ID of the Team.", "type": "string", "format": "uuid" }, "members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mention_name": { "description": "The Team's mention name, used to @mention the team in text fields.", "type": "string", "nullable": true }, "name": { "description": "The name of the Team.", "type": "string" }, "updated_at": { "description": "The time/date the Team was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "workflows": { "$ref": "#/components/schemas/NestedWorkflowSlimList" } }, "additionalProperties": false }, "Response5197832": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197326": { "type": "object", "additionalProperties": false, "properties": {} }, "MemberSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "member:slim" ] }, "id": { "description": "The unique ID of the Member.", "type": "string", "format": "uuid" }, "name": { "description": "The name of the Member.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197484": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateIterationsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Iteration to update.", "type": "integer", "format": "int64" }, "description": { "maxLength": 100000, "description": "The description of the Iteration.", "type": "string" }, "end_date": { "minLength": 1, "description": "The date this Iteration ends (ISO 8601 date format, e.g. '2024-01-15').", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for any Members you want to set as Followers, replacing existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "An array of UUIDs for any Members you want to remove as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of this Iteration.", "type": "string" }, "start_date": { "minLength": 1, "description": "The date this Iteration begins (ISO 8601 date format, e.g. '2024-01-01').", "type": "string" }, "team_ids": { "description": "An array of UUIDs for any Teams you want to set on the Iteration, replacing existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for any Teams you want to add to the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for any Teams you want to remove from the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "id" ] }, "Body5196915": { "type": "object", "properties": { "stories": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Story to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryParams" } } }, "additionalProperties": false, "required": [ "stories" ] }, "Response5197529": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197638": { "type": "object", "additionalProperties": false, "properties": {} }, "CategoryObjectiveEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectiveSlim" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197223": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CategoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197419": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197115": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197809": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197205": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197251": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197329": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DisabledFeatureError" } }, "additionalProperties": false, "required": [ "schema" ] }, "ChecklistItem": { "type": "object", "properties": { "completed": { "description": "Boolean indicating whether the Checklist Item has been completed.", "type": "boolean" }, "completed_at": { "description": "The time/date the Checklist Item was completed.", "type": "string", "format": "date-time", "nullable": true }, "created_at": { "description": "The time/date the Checklist Item was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Checklist Item.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "checklist-item" ] }, "external_id": { "description": "This field can be set to another unique ID. In the case that the Checklist Item has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "id": { "description": "The unique ID of the Checklist Item.", "type": "integer", "format": "int64" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "position": { "description": "The Comment's position within the Story.", "type": "integer", "format": "int64" }, "story": { "$ref": "#/components/schemas/StorySlim" }, "updated_at": { "description": "The time/date the Checklist Item was updated.", "type": "string", "format": "date-time", "nullable": true }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197760": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197228": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197551": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197061": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/UnusableEntitlementError" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197823": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "CreateObjectiveParams": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Objective.", "type": "string" }, "category_ids": { "description": "An array of IDs of Categories attached to the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "completed_at_override": { "description": "A manual override for the time/date the Objective was completed.", "type": "string", "format": "date-time" }, "description": { "maxLength": 100000, "description": "The Objective's description.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for Members to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "started_at_override": { "description": "A manual override for the time/date the Objective was started.", "type": "string", "format": "date-time" }, "state": { "description": "The workflow state of the Objective.", "type": "string", "enum": [ "in progress", "to do", "done" ] }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197143": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicLabelEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "StoryCommentEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Comment" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Workflow": { "type": "object", "properties": { "auto_assign_owner": { "description": "Indicates if an owner is automatically assigned when an unowned story is started.", "type": "boolean" }, "created_at": { "description": "The time/date the Workflow was created.", "type": "string", "format": "date-time" }, "default_workflow_state": { "$ref": "#/components/schemas/WorkflowStateSlim" }, "description": { "description": "The description of the Workflow.", "type": "string", "nullable": true }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "workflow" ] }, "id": { "description": "The unique ID of the Workflow.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Workflow.", "type": "string" }, "teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "updated_at": { "description": "The time/date the Workflow was last updated.", "type": "string", "format": "date-time" }, "workflow_states": { "$ref": "#/components/schemas/NestedWorkflowStateSlimList" } }, "additionalProperties": false }, "StoryStoryLinkEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/StoryLink" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197538": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197736": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFileStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197182": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197504": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197261": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196938": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197584": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196961": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197794": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197414": { "type": "object", "additionalProperties": false, "properties": {} }, "Project": { "description": "The entity for this response.", "type": "object", "properties": { "abbreviation": { "description": "The Project's abbreviation.", "type": "string", "nullable": true }, "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Project.", "type": "string" }, "archived": { "description": "True if the Project has been archived.", "type": "boolean" }, "color": { "description": "The hex color assigned to the Project.", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Project was created.", "type": "string", "format": "date-time" }, "days_to_thermometer": { "description": "The number of days before the thermometer is shown.", "type": "integer", "format": "int64", "nullable": true }, "description": { "description": "The description of the Project.", "type": "string", "nullable": true }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "project" ] }, "external_id": { "description": "The external ID for the Project, set when imported from another tool.", "type": "string", "nullable": true }, "followers": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "id": { "description": "The unique ID of the Project.", "type": "integer", "format": "int64" }, "iteration_length": { "description": "The number of weeks per iteration in this Project.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Project.", "type": "string" }, "show_thermometer": { "description": "Whether the thermometer is shown for this Project.", "type": "boolean" }, "start_time": { "description": "The date at which the Project was started.", "type": "string", "format": "date-time", "nullable": true }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "updated_at": { "description": "The time/date the Project was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" }, "workflow": { "$ref": "#/components/schemas/WorkflowSlim", "nullable": true } }, "additionalProperties": false }, "EpicCommentMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197310": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197166": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "EpicStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196968": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197306": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedBranchSlimList": { "description": "A list of Git branches attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/BranchSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Body5196923": { "type": "object", "properties": { "mention_name": { "pattern": "^[a-z0-9\\-\\_\\.]+$", "minLength": 1, "description": "The Team's mention name.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The Team's name.", "type": "string" }, "workflow_ids": { "minItems": 1, "maxItems": 100, "description": "An array of IDs for Workflows to associate with the Team. At least one Workflow is required.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Team (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "color_key": { "description": "The color key to be displayed with the Team.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ] }, "default_workflow_id": { "description": "The ID of the default Workflow for Stories created in this Team.", "type": "integer", "format": "int64" }, "description": { "maxLength": 4096, "description": "The Team's description.", "type": "string" }, "member_ids": { "description": "An array of UUIDs for Members to add to the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "mention_name", "name", "workflow_ids" ] }, "Response5197038": { "type": "object", "additionalProperties": false, "properties": {} }, "ProjectEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Project" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197409": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197546": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197250": { "type": "object", "additionalProperties": false, "properties": {} }, "UpdateEntityTemplateStoryContentsParams": { "description": "Updated attributes for the template to populate.", "type": "object", "properties": { "custom_fields": { "description": "An array of CustomField value assertions to set on the template, replacing existing values.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_fields_add": { "description": "An array of CustomField value assertions to add to the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_fields_remove": { "description": "An array of CustomField value assertions to remove from the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 512, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the epic to be populated.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate to be populated.", "type": "integer", "format": "int64", "nullable": true }, "external_links": { "description": "An array of external links to set on the template, replacing existing links.", "type": "array", "items": { "type": "string" } }, "external_links_add": { "description": "An array of external links to add to the template.", "type": "array", "items": { "type": "string" } }, "external_links_remove": { "description": "An array of external links to remove from the template.", "type": "array", "items": { "type": "string" } }, "file_ids": { "description": "An array of file IDs to set on the template, replacing existing files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_add": { "description": "An array of file IDs to add to the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_remove": { "description": "An array of file IDs to remove from the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs for any Members you want to set as Followers, replacing existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "An array of UUIDs for any Members you want to remove as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "group_id": { "description": "The ID of the group to be populated.", "type": "string", "format": "uuid", "nullable": true }, "iteration_id": { "description": "The ID of the iteration to be populated.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "An array of label IDs to set on the template, replacing existing labels.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_add": { "description": "An array of label IDs to add to the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_remove": { "description": "An array of label IDs to remove from the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of linked file IDs to set on the template, replacing existing linked files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_add": { "description": "An array of linked file IDs to add to the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_remove": { "description": "An array of linked file IDs to remove from the template.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "name": { "maxLength": 512, "description": "The name of the story.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for any Members you want to set as Owners, replacing existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_add": { "description": "An array of UUIDs for any Members you want to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_remove": { "description": "An array of UUIDs for any Members you want to remove as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "project_id": { "description": "The ID of the project the story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "story_type": { "description": "The type of story (feature, bug, chore).", "type": "string", "enum": [ "chore", "bug", "feature" ] }, "sub_tasks": { "description": "An array of sub-tasks to be populated by the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEntityTemplateSubTaskParams" } }, "tasks": { "description": "An array of tasks to be populated by the template.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEntityTemplateTaskParams" } }, "workflow_state_id": { "description": "The ID of the workflow state to be populated.", "type": "integer", "format": "int64", "nullable": true } }, "additionalProperties": false }, "TeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197658": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197049": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CustomFieldEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "CreateDocParams": { "type": "object", "properties": { "content": { "description": "The content of the new Doc.", "type": "string" }, "title": { "maxLength": 256, "minLength": 1, "description": "The title of the new Doc.", "type": "string" }, "content_format": { "description": "Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage.", "type": "string", "enum": [ "markdown", "html" ] }, "description": { "maxLength": 1024, "description": "An optional description for the Doc.", "type": "string" } }, "additionalProperties": false, "required": [ "title", "content" ] }, "EpicCommentEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ThreadedComment" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197175": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196953": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197582": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197481": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197262": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197308": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197453": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197069": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197827": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197080": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197655": { "type": "object", "additionalProperties": false, "properties": {} }, "ThreadedCommentSlim": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Comment.", "type": "string" }, "deleted": { "description": "Whether the Comment has been deleted.", "type": "boolean" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "threaded-comment:slim" ] }, "id": { "description": "The unique ID of the Comment.", "type": "integer", "format": "int64" }, "text": { "description": "The text of the Comment.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "Response5197385": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197362": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/RepositoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197380": { "type": "object", "additionalProperties": false, "properties": {} }, "KeyResultSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "key-result:slim" ] }, "id": { "description": "The unique ID of the Key Result.", "type": "string", "format": "uuid" }, "name": { "maxLength": 1024, "description": "The name of the Key Result.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197572": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196838": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new Label.", "type": "string" }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color to be displayed with the Label (for example, \"#ff0000\").", "minLength": 1, "type": "string" }, "description": { "maxLength": 1024, "description": "The description of the new Label.", "type": "string" }, "external_id": { "maxLength": 128, "minLength": 1, "description": "This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197570": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197401": { "type": "object", "additionalProperties": false, "properties": {} }, "LabelEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Label" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196845": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Objective.", "type": "string" }, "category_ids": { "description": "An array of IDs of Categories attached to the Objective.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "completed_at_override": { "description": "A manual override for the time/date the Objective was completed.", "type": "string", "format": "date-time" }, "description": { "maxLength": 100000, "description": "The Objective's description.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs for Members to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "started_at_override": { "description": "A manual override for the time/date the Objective was started.", "type": "string", "format": "date-time" }, "state": { "description": "The workflow state of the Objective.", "type": "string", "enum": [ "in progress", "to do", "done" ] }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Objective.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name" ] }, "Response5197057": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Doc": { "description": "The entity for this response.", "type": "object", "properties": { "archived": { "description": "A true/false boolean indicating if the Doc has been archived.", "type": "boolean" }, "content_html": { "description": "The Doc content in HTML format. Only present on get-doc when content_format=html.", "type": "string", "nullable": true }, "content_markdown": { "description": "The Doc content in Markdown format. Only present on get-doc when content_format is omitted or 'markdown'.", "type": "string", "nullable": true }, "created_at": { "description": "The time/date the Doc was created.", "type": "string", "format": "date-time" }, "creator": { "$ref": "#/components/schemas/MemberSlim" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "doc" ] }, "followers": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "id": { "description": "The unique ID of the Doc.", "type": "string", "format": "uuid" }, "title": { "maxLength": 256, "minLength": 1, "description": "The title of the Doc.", "type": "string" }, "updated_at": { "description": "The time/date the Doc was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "Response5197107": { "type": "object", "additionalProperties": false, "properties": {} }, "LinkedFileSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "linked-file:slim" ] }, "id": { "description": "The unique ID of the Linked File.", "type": "integer", "format": "int64" }, "name": { "maxLength": 256, "description": "The name of the Linked File.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197491": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197058": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryFileEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/File" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197822": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197440": { "type": "object", "additionalProperties": false, "properties": {} }, "RepositoryBranchEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Branch" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "UpdateKeyResultValueParams": { "description": "The starting value of the Key Result.", "type": "object", "properties": { "boolean_value": { "description": "The boolean value.", "type": "boolean" }, "numeric_value": { "description": "The numeric value as a decimal string. No more than two decimal places are allowed.", "type": "string" } }, "additionalProperties": false }, "Response5197354": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196855": { "type": "object", "properties": { "epics": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Epic to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateEpicParams" } } }, "additionalProperties": false, "required": [ "epics" ] }, "Response5197253": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197220": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197218": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197247": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197245": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196920": { "type": "object", "properties": { "comments": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Comment to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryCommentParams" } } }, "additionalProperties": false, "required": [ "comments" ] }, "Response5197642": { "type": "object", "additionalProperties": false, "properties": {} }, "Label": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Label.", "type": "string" }, "archived": { "description": "A true/false boolean indicating if the Label has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Label (for example, \"#ff0000\").", "type": "string", "nullable": true }, "created_at": { "description": "The time/date that the Label was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Label.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "label" ] }, "epics": { "$ref": "#/components/schemas/NestedEpicSlimList" }, "external_id": { "description": "This field can be set to another unique ID. In the case that the Label has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "id": { "description": "The unique ID of the Label.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Label.", "type": "string" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "updated_at": { "description": "The time/date that the Label was updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197475": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryFileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197011": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197257": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197311": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197029": { "type": "object", "additionalProperties": false, "properties": {} }, "FileEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/File" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197293": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197321": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197356": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197844": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196876": { "type": "object", "properties": { "documents": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Doc to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateDocParams" } } }, "additionalProperties": false, "required": [ "documents" ] }, "Response5197339": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197234": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197750": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197460": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197030": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveEpicEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/EpicSlim" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197763": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197478": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197072": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197048": { "type": "object", "additionalProperties": false, "properties": {} }, "KeyResult": { "type": "object", "properties": { "created_at": { "description": "The time/date the Key Result was created.", "type": "string", "format": "date-time" }, "current_observed_value": { "$ref": "#/components/schemas/KeyResultValue" }, "current_target_value": { "$ref": "#/components/schemas/KeyResultValue" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "key-result" ] }, "id": { "description": "The unique ID of the Key Result.", "type": "string", "format": "uuid" }, "initial_observed_value": { "$ref": "#/components/schemas/KeyResultValue" }, "name": { "maxLength": 1024, "description": "The name of the Key Result.", "type": "string" }, "objective": { "$ref": "#/components/schemas/ObjectiveSlim" }, "progress": { "description": "A percentage (0-100) indicating progress toward the target value.", "type": "integer", "format": "int64" }, "type": { "description": "The type of this Key Result's values.", "type": "string", "enum": [ "percent", "boolean", "numeric" ] }, "updated_at": { "description": "The time/date the Key Result was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the Key Result.", "type": "string" } }, "additionalProperties": false }, "Response5197328": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197480": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197665": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197479": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryBranchEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197059": { "type": "object", "additionalProperties": false, "properties": {} }, "FileMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197668": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197191": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197441": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196979": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197054": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197683": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationAssociatedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197779": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/RepositoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "EpicMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196975": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196995": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197771": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197365": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197495": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveOwnerEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197831": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197437": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197669": { "type": "object", "additionalProperties": false, "properties": {} }, "BranchPullRequestEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/PullRequest" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "RepositoryEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Repository" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197335": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197746": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196971": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196831": { "type": "object", "properties": { "abbreviation": { "description": "The abbreviation for the Project. Set to null to clear.", "maxLength": 63, "type": "string", "nullable": true }, "archived": { "description": "Whether the Project is archived.", "type": "boolean" }, "color": { "description": "The hex color for the Project. Set to null to clear.", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "days_to_thermometer": { "description": "The number of days before the thermometer is shown.", "type": "integer", "format": "int64" }, "description": { "description": "The description of the Project.", "maxLength": 100000, "type": "string", "nullable": true }, "follower_ids": { "description": "UUIDs of Members to set as Followers. Replaces current followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "UUIDs of Members to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "UUIDs of Members to remove as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "maxLength": 2048, "minLength": 1, "description": "The name of the Project.", "type": "string" }, "show_thermometer": { "description": "Whether the thermometer is shown.", "type": "boolean" } }, "additionalProperties": false }, "Response5197606": { "type": "object", "additionalProperties": false, "properties": {} }, "LabelSlim": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Label.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "label:slim" ] }, "id": { "description": "The unique ID of the Label.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Label.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197846": { "type": "object", "additionalProperties": false, "properties": {} }, "Reaction": { "type": "object", "properties": { "author": { "$ref": "#/components/schemas/MemberSlim" }, "comment": { "$ref": "#/components/schemas/CommentSlim" }, "created_at": { "description": "The time/date the Reaction was created.", "type": "string", "format": "date-time" }, "emoji": { "description": "The emoji used for the Reaction.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "reaction" ] }, "id": { "description": "The unique ID of the Reaction.", "type": "string", "format": "uuid" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197056": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197416": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196908": { "type": "object", "properties": { "categories": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Category to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateCategoriesParams1" } } }, "additionalProperties": false, "required": [ "categories" ] }, "NestedExternalLinkList": { "description": "A list of external links connected to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ExternalLink" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197199": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197782": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197842": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196918": { "type": "object", "properties": { "comment_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Comments to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "comment_ids" ] }, "EpicOwnerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197024": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197126": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197836": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197241": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197702": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedEpicSlimList": { "description": "A list of Epics that have this Label.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/EpicSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197610": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Objective" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197780": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197447": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "NestedObjectiveSlimList": { "description": "The Objectives associated with this Epic.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/ObjectiveSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5197715": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowStateEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "FileSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "file:slim" ] }, "id": { "description": "The unique ID for the file.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the file.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197206": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196873": { "type": "object", "properties": { "initial_observed_value": { "$ref": "#/components/schemas/UpdateKeyResultValueParams" }, "name": { "maxLength": 1024, "description": "The new name of the Key Result.", "type": "string" }, "observed_value": { "$ref": "#/components/schemas/UpdateKeyResultValueParams" }, "target_value": { "$ref": "#/components/schemas/UpdateKeyResultValueParams" } }, "additionalProperties": false }, "Response5197345": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197031": { "type": "object", "additionalProperties": false, "properties": {} }, "RepositoryCommitEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Commit" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197216": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationAssociatedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197178": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197552": { "type": "object", "additionalProperties": false, "properties": {} }, "KeyResultEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/KeyResult" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196993": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197153": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197297": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196945": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Epic" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197666": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197201": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197465": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197704": { "type": "object", "additionalProperties": false, "properties": {} }, "LabelEpicEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Epic" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196948": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ProjectEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197246": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197590": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197733": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197522": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197818": { "type": "object", "additionalProperties": false, "properties": {} }, "RepositoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Repository" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197740": { "type": "object", "additionalProperties": false, "properties": {} }, "DisabledFeatureError": { "type": "object", "properties": { "feature_tag": { "description": "The feature that is disabled.", "type": "string" }, "message": { "description": "The message explaining the error.", "type": "string" } }, "additionalProperties": false, "required": [ "feature_tag", "message" ] }, "Response5197811": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196896SetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the given story to the first or last position in the Workflow State, or before or after a given Story.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_story_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197000": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCustomFieldValueEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197467": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "ObjectiveEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Objective" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "EpicMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197244": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197560": { "type": "object", "additionalProperties": false, "properties": {} }, "EntityTemplateTask": { "type": "object", "properties": { "complete": { "description": "True/false boolean indicating whether the Task has been completed.", "type": "boolean" }, "description": { "description": "Full text of the Task.", "type": "string" }, "owners": { "description": "An array of Members who own this Task.", "type": "array", "items": { "$ref": "#/components/schemas/MemberSlim" } }, "position": { "description": "The number corresponding to the Task's position within a list of Tasks on a Story.", "type": "integer", "format": "int64" } }, "additionalProperties": false }, "LabelStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197599": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Story": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Story.", "type": "string" }, "archived": { "description": "True if the Story has been archived or not.", "type": "boolean" }, "blocked": { "description": "A true/false boolean indicating if the Story is currently blocked.", "type": "boolean" }, "blocker": { "description": "A true/false boolean indicating if the Story is currently a blocker of another Story.", "type": "boolean" }, "branches": { "$ref": "#/components/schemas/NestedBranchSlimList" }, "checklist_items": { "$ref": "#/components/schemas/NestedChecklistItemSlimList" }, "comments": { "$ref": "#/components/schemas/NestedCommentSlimList" }, "commits": { "$ref": "#/components/schemas/NestedCommitSlimList" }, "completed": { "description": "A true/false boolean indicating if the Story has been completed.", "type": "boolean" }, "completed_at": { "description": "The time/date the Story was completed.", "type": "string", "format": "date-time", "nullable": true }, "completed_at_override": { "description": "A manual override for the time/date the Story was completed.", "type": "string", "format": "date-time", "nullable": true }, "created_at": { "description": "The time/date the Story was created.", "type": "string", "format": "date-time" }, "custom_field_values": { "$ref": "#/components/schemas/NestedCustomFieldValueSlimList" }, "deadline": { "description": "The Story's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "description": "The description of the Story.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "story" ] }, "epic": { "$ref": "#/components/schemas/EpicSlim", "nullable": true }, "estimate": { "description": "The numeric point estimate of the Story. Can also be null, which means unestimated.", "type": "integer", "format": "int64", "nullable": true }, "external_id": { "description": "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string", "nullable": true }, "external_links": { "$ref": "#/components/schemas/NestedExternalLinkList" }, "files": { "$ref": "#/components/schemas/NestedFileSlimList" }, "followers": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "id": { "description": "The unique ID of the Story.", "type": "integer", "format": "int64" }, "iterations": { "$ref": "#/components/schemas/NestedIterationSlimList" }, "labels": { "$ref": "#/components/schemas/NestedLabelSlimList" }, "linked_files": { "$ref": "#/components/schemas/NestedLinkedFileSlimList" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "moved_at": { "description": "The time this Story was last moved between Workflow States.", "type": "string", "format": "date-time", "nullable": true }, "name": { "description": "The name of the Story.", "type": "string" }, "owners": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "parent_story": { "$ref": "#/components/schemas/StorySlim", "nullable": true }, "position": { "description": "The Story's relative position.", "type": "integer", "format": "int64" }, "project": { "$ref": "#/components/schemas/ProjectSlim", "nullable": true }, "pull_requests": { "$ref": "#/components/schemas/NestedPullRequestSlimList" }, "requester": { "$ref": "#/components/schemas/MemberSlim" }, "started": { "description": "A true/false boolean indicating if the Story has been started.", "type": "boolean" }, "started_at": { "description": "The time/date the Story was started.", "type": "string", "format": "date-time", "nullable": true }, "started_at_override": { "description": "A manual override for the time/date the Story was started.", "type": "string", "format": "date-time", "nullable": true }, "story_links": { "$ref": "#/components/schemas/NestedStoryLinkSlimList" }, "story_template": { "$ref": "#/components/schemas/StoryTemplateSlim", "nullable": true }, "story_type": { "description": "The type of Story (feature, bug, chore).", "type": "string", "enum": [ "chore", "bug", "feature" ] }, "sub_task_stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "team": { "$ref": "#/components/schemas/TeamSlim", "nullable": true }, "updated_at": { "description": "The time/date the Story was updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" }, "workflow": { "$ref": "#/components/schemas/WorkflowSlim" }, "workflow_state": { "$ref": "#/components/schemas/WorkflowStateSlim" } }, "additionalProperties": false }, "Response5197034": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196909": { "type": "object", "properties": { "categories": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Category to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCategoryParams" } } }, "additionalProperties": false, "required": [ "categories" ] }, "Response5197457": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197500": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveCategoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Category" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197334": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197042": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197712": { "type": "object", "additionalProperties": false, "properties": {} }, "BranchSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "branch:slim" ] }, "id": { "description": "The unique ID of the Branch.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Branch.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197791": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "CreateIterationParams": { "type": "object", "properties": { "end_date": { "minLength": 1, "description": "The date this Iteration ends (ISO 8601 date format, e.g. '2024-01-15').", "type": "string" }, "name": { "maxLength": 256, "minLength": 1, "description": "The name of this Iteration.", "type": "string" }, "start_date": { "minLength": 1, "description": "The date this Iteration begins (ISO 8601 date format, e.g. '2024-01-01').", "type": "string" }, "description": { "maxLength": 100000, "description": "The description of the Iteration.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for any Members you want to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids": { "description": "An array of UUIDs for any Teams you want to associate with the Iteration.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name", "start_date", "end_date" ] }, "Response5197237": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197397": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197230": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197682": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateStoriesParams1": { "type": "object", "properties": { "id": { "description": "The id of the Story to update.", "type": "integer", "format": "int64" }, "archived": { "description": "Controls the Story's archived state.", "type": "boolean" }, "custom_field_values": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. This will replace the current Custom Field values on the Story. Sending an empty array will delete all existing Custom Field values.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_field_values_add": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be added to the current Custom Field values on the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "custom_field_values_remove": { "description": "An array of objects specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field. These will be removed from the current Custom Field values on the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the Story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the Epic the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate of the Story. Can also be null, which means unestimated.", "type": "integer", "format": "int64", "nullable": true }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "external_links": { "description": "An array of External Links associated with the Story. This will replace the current External Links on the Story. Sending an empty array will delete all existing External Links.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "external_links_add": { "description": "An array of External Links associated with the Story. These will be added to the current External Links on the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "external_links_remove": { "description": "An array of External Links associated with the Story. These will be removed from the current External Links on the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "file_ids": { "description": "An array of IDs of Files attached to the Story. This will replace the current Files on the Story. Sending an empty array will delete all existing Files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_add": { "description": "An array of IDs of Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "file_ids_remove": { "description": "An array of IDs of Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs of the Members that follow this Story. This will replace the current Followers on the Story. Sending an empty array will delete all existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "follower_ids_add": { "description": "An array of UUIDs of the Members that follow this Story. These will be added to the current followers on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "follower_ids_remove": { "description": "An array of UUIDs of the Members that follow this Story. These will be removed from the current followers on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "iteration_id": { "description": "The ID of the Iteration the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "Labels to attach to the Story. This will replace the current Labels on the Story. Sending an empty array will delete all existing Labels.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_add": { "description": "Labels to attach to the Story. These will be added to the current Labels on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "label_ids_remove": { "description": "Labels to detach from the Story. These will be removed to the current Labels on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of IDs of Linked Files attached to the Story. This will replace the current Linked Files on the Story. Sending an empty array will delete all existing Linked Files.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_add": { "description": "An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids_remove": { "description": "An array of IDs of Linked Files attached to the Story. These will be added to the current files on the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "name": { "maxLength": 512, "minLength": 1, "description": "The name of the Story.", "type": "string" }, "owner_ids": { "description": "An array of UUIDs of the Members that own this Story. This will replace the current Owners on the Story. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "owner_ids_add": { "description": "An array of UUIDs of the Members that own this Story. These will be added to the current owners on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "owner_ids_remove": { "description": "An array of UUIDs of the Members that own this Story. These will be removed from the current owners on the Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "parent_story_id": { "description": "The ID of the parent Story to associate with this Story (making the Story a sub-task).\nField only applicable when Sub-task feature is enabled.", "type": "integer", "format": "int64", "nullable": true }, "project_id": { "description": "The ID of the Project the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "requester_id": { "description": "The ID of the Member that requested the Story. Will default to the Member making the API call if not provided.", "type": "string", "format": "uuid" }, "set_position": { "$ref": "#/components/schemas/Body5196914StoriesSetPosition" }, "story_type": { "description": "The type of Story (feature, bug, chore).", "type": "string", "enum": [ "feature", "chore", "bug" ] }, "team_id": { "description": "The id of the Team to associate with this Story.", "type": "string", "format": "uuid", "nullable": true }, "workflow_state_id": { "description": "The ID of the Workflow State to move the Story to.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197304": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197002": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197432": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197840": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196963": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196883SetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Response5197184": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197752": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197620": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197578": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedCustomFieldValueSlimList": { "description": "A list of Custom Field values for the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValueSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Body5196886": { "type": "object", "properties": { "status": { "description": "The health status.", "type": "string", "enum": [ "At Risk", "On Track", "Off Track", "No Health" ] }, "text": { "description": "The text body of the Health update.", "type": "string" } }, "additionalProperties": false, "required": [ "status" ] }, "CustomFieldStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197015": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197168": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197025": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197063": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197505": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197374": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/KeyResultEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197774": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197299": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197200": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryBranchEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Branch" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197510": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197713": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateTeamsParams1": { "type": "object", "properties": { "id": { "description": "The UUID of the Team to update.", "type": "string", "format": "uuid" }, "archived": { "description": "Whether the Team is archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Team (for example, \"#ff0000\"). Set to null to clear.", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "color_key": { "description": "The color key to be displayed with the Team. Set to null to clear.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "nullable": true }, "default_workflow_id": { "description": "The ID of the default Workflow for Stories created in this Team. Set to null to clear.", "type": "integer", "format": "int64", "nullable": true }, "description": { "maxLength": 4096, "description": "The Team's description.", "type": "string" }, "member_ids": { "description": "An array of UUIDs for Members to set as the Team's members. Replaces current members.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "member_ids_add": { "description": "An array of UUIDs for Members to add to the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "member_ids_remove": { "description": "An array of UUIDs for Members to remove from the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "mention_name": { "pattern": "^[a-z0-9\\-\\_\\.]+$", "minLength": 1, "description": "The Team's mention name.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The Team's name.", "type": "string" }, "workflow_ids": { "description": "An array of IDs for Workflows to associate with the Team. Replaces current Workflows.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "workflow_ids_add": { "description": "An array of IDs for Workflows to add to the Team.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "workflow_ids_remove": { "description": "An array of IDs for Workflows to remove from the Team.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "id" ] }, "IterationTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "NestedFileSlimList": { "description": "A list of files attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/FileSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5196951": { "type": "object", "additionalProperties": false, "properties": {} }, "ObjectiveSlim": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Objective.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "objective:slim" ] }, "id": { "description": "The unique ID of the Objective.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Objective.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197294": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196972": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EntityTemplateEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197824": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197663": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197849": { "type": "object", "additionalProperties": false, "properties": {} }, "TeamEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Team" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5196989": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197020": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LabelEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "ProjectFollowerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197396": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateLinkedFileParams": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Linked File.", "type": "string" }, "type": { "maxLength": 63, "minLength": 1, "description": "The integration type (e.g. google, dropbox, box, onedrive, url).", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the Linked File.", "type": "string" }, "content_type": { "maxLength": 128, "description": "The content type of the Linked File.", "type": "string" }, "description": { "maxLength": 512, "description": "The description of the Linked File.", "type": "string" }, "size": { "description": "The size of the Linked File.", "type": "integer", "format": "int64" }, "thumbnail_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the thumbnail.", "type": "string" } }, "additionalProperties": false, "required": [ "name", "type", "url" ] }, "Response5197243": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197272": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197330": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/BranchPullRequestEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197471": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkflowEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196827": { "type": "object", "properties": { "checklist_item_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Checklist Items to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "checklist_item_ids" ] }, "Response5197183": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197625": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197730": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196939": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196867": { "type": "object", "properties": { "status": { "description": "The health status.", "type": "string", "enum": [ "At Risk", "On Track", "Off Track", "No Health" ] }, "text": { "description": "The text body of the Health update.", "type": "string" } }, "additionalProperties": false, "required": [ "status" ] }, "Response5197009": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197332": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197443": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicStoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197450": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197660": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197085": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197767": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196848": { "type": "object", "properties": { "name": { "maxLength": 2048, "minLength": 1, "description": "The name of the Project.", "type": "string" }, "abbreviation": { "maxLength": 63, "description": "The abbreviation for the Project. Should be kept to 3 characters at most.", "type": "string" }, "color": { "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "description": "The hex color for the Project (e.g., \"#ff0000\").", "minLength": 1, "type": "string" }, "description": { "maxLength": 100000, "description": "The description of the Project.", "type": "string" }, "external_id": { "maxLength": 128, "description": "An external ID for the Project, for use when importing from another tool.", "type": "string" }, "follower_ids": { "description": "UUIDs of Members to add as Followers of the Project.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "iteration_length": { "description": "The number of weeks per iteration in this Project.", "type": "integer", "format": "int64" }, "start_time": { "description": "The date at which the Project was started.", "type": "string", "format": "date-time" }, "workflow_id": { "description": "The ID of the Workflow for the Project. Defaults to the workspace default.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "name" ] }, "Body5196892": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The name of the Linked File.", "type": "string" }, "type": { "maxLength": 63, "minLength": 1, "description": "The integration type (e.g. google, dropbox, box, onedrive, url).", "type": "string" }, "url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the Linked File.", "type": "string" }, "content_type": { "maxLength": 128, "description": "The content type of the Linked File.", "type": "string" }, "description": { "maxLength": 512, "description": "The description of the Linked File.", "type": "string" }, "size": { "description": "The size of the Linked File.", "type": "integer", "format": "int64" }, "thumbnail_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the thumbnail.", "type": "string" } }, "additionalProperties": false, "required": [ "name", "type", "url" ] }, "CommitEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Commit" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197651": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196912": { "type": "object", "properties": { "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" }, "author_id": { "description": "The Member ID of the Comment's author. Defaults to the user identified by the API token. Requires the admin role to set.", "type": "string", "format": "uuid" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the comment has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "parent_comment_id": { "description": "The ID of the Comment that this comment is threaded under.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "text" ] }, "Response5197060": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateNestedStoryLinkParams": { "type": "object", "properties": { "verb": { "description": "How the subject Story acts on the object Story. This can be one of: \"blocks\", \"duplicates\", \"relates to\"", "type": "string", "enum": [ "blocks", "duplicates", "relates to" ] }, "object_story_id": { "description": "The unique ID of the Story defined as object. At least one of `object_story_id` or `subject_story_id` must be present.", "type": "integer", "format": "int64" }, "subject_story_id": { "description": "The unique ID of the Story defined as subject. At least one of `object_story_id` or `subject_story_id` must be present.", "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "verb" ] }, "Response5197616": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196858": { "type": "object", "properties": { "custom_fields": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Custom Field to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateCustomFieldsParams1" } } }, "additionalProperties": false, "required": [ "custom_fields" ] }, "Response5197036": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DisabledFeatureError" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197341": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197548": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197439": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveKeyResultEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197404": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197189": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197082": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197830": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197717": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197238": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197661": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197532": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197741": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197634": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197526": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197398": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/WorkspaceTokenEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197386": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197338": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicWorkflowEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197563": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197007": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197705": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196997": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197815": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197240": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197833": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196940": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197490": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197632": { "type": "object", "additionalProperties": false, "properties": {} }, "CustomFieldValueSlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "custom-field-value:slim" ] }, "field": { "$ref": "#/components/schemas/CustomFieldSlim" }, "id": { "description": "The unique public ID for the Custom Field Value.", "type": "string", "format": "uuid" }, "value": { "description": "A string representation of the value.", "type": "string" } }, "additionalProperties": false }, "MemberTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196991": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196952": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentMentionedTeamEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5196926": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkflowSlim": { "description": "The default Workflow for the Workspace the caller is authenticated against.", "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "workflow:slim" ] }, "id": { "description": "The unique ID of the Workflow.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Workflow.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197798": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateCategoriesParams1": { "type": "object", "properties": { "id": { "description": "The id of the Category to update.", "type": "integer", "format": "int64" }, "archived": { "description": "A true/false boolean indicating if the Category has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Category (for example, \"#ff0000\").", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "name": { "maxLength": 128, "minLength": 1, "description": "The name of the Category.", "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }, "TeamMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5196981": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196898": { "type": "object", "properties": { "objectives": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Objective to update.", "type": "array", "items": { "$ref": "#/components/schemas/BulkUpdateObjectivesParams1" } } }, "additionalProperties": false, "required": [ "objectives" ] }, "PullRequestEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/PullRequest" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197525": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197433": { "type": "object", "additionalProperties": false, "properties": {} }, "WorkflowStoryEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Story" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "CreateEntityTemplateParams": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new entity template.", "type": "string" }, "story_contents": { "$ref": "#/components/schemas/CreateEntityTemplateStoryContentsParams" }, "author_id": { "description": "The ID of the member creating this template.", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "name", "story_contents" ] }, "Response5197018": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197851": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197133": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197761": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateStoryParams": { "type": "object", "properties": { "name": { "maxLength": 512, "minLength": 1, "description": "The name of the Story.", "type": "string" }, "workflow_state_id": { "description": "The ID of the Workflow State the Story will be in.", "type": "integer", "format": "int64" }, "archived": { "description": "Controls the Story's archived state.", "type": "boolean" }, "checklist_items": { "description": "An array of Checklist Items connected to the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryChecklistItemParams" } }, "custom_field_values": { "description": "An array of objects specifying a Custom Field value ID and CustomFieldEnumValue ID that represents an assertion of some value for a Custom Field value.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the Story.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The description of the story.", "type": "string" }, "epic_id": { "description": "The ID of the Epic the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "estimate": { "description": "The numeric point estimate of the Story. Can also be null, which means unestimated.", "type": "integer", "format": "int64", "nullable": true }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Story has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "external_links": { "description": "An array of External Links associated with the Story.", "type": "array", "items": { "type": "string" }, "uniqueItems": true }, "file_ids": { "description": "An array of IDs of Files attached to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "follower_ids": { "description": "An array of UUIDs of the Members that follow this Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "iteration_id": { "description": "The ID of the Iteration the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "label_ids": { "description": "Labels to attach to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "linked_file_ids": { "description": "An array of IDs of Linked Files attached to the Story.", "type": "array", "items": { "type": "integer", "format": "int64" }, "uniqueItems": true }, "owner_ids": { "description": "An array of UUIDs of the Members that own this Story.", "type": "array", "items": { "type": "string", "format": "uuid" }, "uniqueItems": true }, "parent_story_id": { "description": "The ID of the parent Story to associate with this Story (making the Story a sub-task).\nField only applicable when Sub-task feature is enabled.", "type": "integer", "format": "int64", "nullable": true }, "project_id": { "description": "The ID of the Project the Story belongs to.", "type": "integer", "format": "int64", "nullable": true }, "requester_id": { "description": "The ID of the Member that requested the Story. Will default to the Member making the API call if not provided.", "type": "string", "format": "uuid" }, "set_position": { "$ref": "#/components/schemas/Body5196915StoriesSetPosition" }, "story_links": { "description": "An array of Story links attached to the Story.", "type": "array", "items": { "$ref": "#/components/schemas/CreateNestedStoryLinkParams" } }, "story_type": { "description": "The type of Story (feature, bug, chore).", "type": "string", "enum": [ "feature", "chore", "bug" ] }, "team_id": { "description": "The id of the Team to associate with this Story.", "type": "string", "format": "uuid", "nullable": true } }, "additionalProperties": false, "required": [ "name", "workflow_state_id" ] }, "Response5197753": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197619": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CurrentIterationsOutput" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryLinkedFileEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/LinkedFile" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197574": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197348": { "type": "object", "additionalProperties": false, "properties": {} }, "EpicObjectiveEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ObjectiveSlim" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197411": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197507": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197722": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197838": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197701": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197103": { "type": "object", "additionalProperties": false, "properties": {} }, "TeamSlim": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Team.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "team:slim" ] }, "id": { "description": "The unique ID of the Team.", "type": "string", "format": "uuid" }, "name": { "description": "The name of the Team.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197121": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196859": { "type": "object", "properties": { "disabled": { "description": "Set to true to disable the Member, false to re-enable them.", "type": "boolean" }, "role": { "description": "The new role to assign to the Member. One of \"admin\", \"member\", or \"observer\".", "type": "string", "enum": [ "member", "observer", "admin" ] } }, "additionalProperties": false }, "Body5196879": { "type": "object", "properties": { "archived": { "description": "Whether the Team is archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Team (for example, \"#ff0000\"). Set to null to clear.", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "color_key": { "description": "The color key to be displayed with the Team. Set to null to clear.", "type": "string", "enum": [ "blue", "purple", "midnight-blue", "orange", "yellow-green", "brass", "gray", "fuchsia", "yellow", "pink", "sky-blue", "green", "red", "black", "slate", "turquoise" ], "nullable": true }, "default_workflow_id": { "description": "The ID of the default Workflow for Stories created in this Team. Set to null to clear.", "type": "integer", "format": "int64", "nullable": true }, "description": { "maxLength": 4096, "description": "The Team's description.", "type": "string" }, "member_ids": { "description": "An array of UUIDs for Members to set as the Team's members. Replaces current members.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "member_ids_add": { "description": "An array of UUIDs for Members to add to the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "member_ids_remove": { "description": "An array of UUIDs for Members to remove from the Team.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "mention_name": { "pattern": "^[a-z0-9\\-\\_\\.]+$", "minLength": 1, "description": "The Team's mention name.", "type": "string" }, "name": { "maxLength": 63, "minLength": 1, "description": "The Team's name.", "type": "string" }, "workflow_ids": { "description": "An array of IDs for Workflows to associate with the Team. Replaces current Workflows.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "workflow_ids_add": { "description": "An array of IDs for Workflows to add to the Team.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "workflow_ids_remove": { "description": "An array of IDs for Workflows to remove from the Team.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false }, "Response5197600": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197571": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "EpicCommentMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "CategoryEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/Category" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197623": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryCustomFieldValueEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197081": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197706": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197315": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197242": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197300": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/MemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197146": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/BranchEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5196954": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197355": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196986": { "type": "object", "additionalProperties": false, "properties": {} }, "PullRequestEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/PullRequest" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "Response5197070": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/LinkedFileEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Whoami": { "description": "The entity for this response.", "type": "object", "properties": { "authorization": { "$ref": "#/components/schemas/TokenAuthorization" }, "default_workflow": { "$ref": "#/components/schemas/WorkflowSlim" }, "default_workflow_state": { "$ref": "#/components/schemas/WorkflowStateSlim" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "whoami" ] }, "member": { "$ref": "#/components/schemas/Member" }, "workspace": { "$ref": "#/components/schemas/WorkspaceSlim" } }, "additionalProperties": false }, "Body5196857": { "type": "object", "properties": { "custom_field_ids": { "minItems": 1, "maxItems": 100, "description": "The unique IDs of the Custom Fields to delete.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "custom_field_ids" ] }, "ExternalLink": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "external-link" ] }, "value": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URL of the external link.", "type": "string" } }, "additionalProperties": false }, "Response5197359": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197353": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197724": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197633": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197249": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197295": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197144": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196915StoriesSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the given story to the first or last position in the Workflow State, or before or after a given Story.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_story_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "Token": { "type": "object", "properties": { "created_at": { "description": "The time/date the Token was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Token.", "type": "string" }, "disabled": { "description": "True if the Token has been disabled.", "type": "boolean" }, "email_address": { "description": "The email address of the Member this Token belongs to.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "token" ] }, "id": { "description": "The unique ID of the Token.", "type": "string", "format": "uuid" }, "last_used_at": { "description": "The date the Token was last used. Null if never used.", "type": "string", "format": "date-time", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberSlim" }, "scopes": { "description": "The scopes granted to this token. Possible values: \"read\", \"write\", \"story-write\", \"comment-write\", \"admin\". Null for legacy tokens.", "type": "array", "items": { "type": "string" }, "nullable": true }, "updated_at": { "description": "The time/date the Token was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false }, "StoryChecklistItemMentionedTeamEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Team" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197134": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/KeyResultEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197817": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateLabelsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Label to update.", "type": "integer", "format": "int64" }, "archived": { "description": "A true/false boolean indicating if the Label has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Label (for example, \"#ff0000\").", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "description": { "maxLength": 1024, "description": "The description of the Label.", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "description": "The name of the Label.", "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197679": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197412": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197180": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197639": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryIterationEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197593": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197698": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197735": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197279": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197435": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/TeamEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197502": { "type": "object", "additionalProperties": false, "properties": {} }, "CategorySlim": { "type": "object", "properties": { "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "category:slim" ] }, "id": { "description": "The unique ID of the Category.", "type": "integer", "format": "int64" }, "name": { "maxLength": 128, "description": "The name of the Category.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity.", "type": "string" } }, "additionalProperties": false, "required": [ "entity_type", "id", "name", "uri" ] }, "Response5197071": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryChecklistItemEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ChecklistItem" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196870": { "type": "object", "properties": { "content": { "description": "The content of the new Doc.", "type": "string" }, "title": { "maxLength": 256, "minLength": 1, "description": "The title of the new Doc.", "type": "string" }, "content_format": { "description": "Format of the content being sent. Defaults to 'html'. If 'markdown', content will be converted to HTML for storage.", "type": "string", "enum": [ "markdown", "html" ] }, "description": { "maxLength": 1024, "description": "An optional description for the Doc.", "type": "string" } }, "additionalProperties": false, "required": [ "title", "content" ] }, "Response5197446": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197627": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicObjectiveEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197079": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197757": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationFollowerEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196844": { "type": "object", "properties": { "linked_files": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Linked File to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateLinkedFileParams" } } }, "additionalProperties": false, "required": [ "linked_files" ] }, "Response5197147": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197718": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197523": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197781": { "type": "object", "additionalProperties": false, "properties": {} }, "NestedLabelSlimList": { "description": "A list of labels attached to the Story.", "type": "object", "properties": { "current_items": { "type": "integer", "format": "int64" }, "entities": { "type": "array", "items": { "$ref": "#/components/schemas/LabelSlim" } }, "list_url": { "pattern": "^https?://.+$", "maxLength": 2048, "type": "string" }, "total_items": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "total_items", "entities", "list_url", "current_items" ] }, "Response5196977": { "type": "object", "additionalProperties": false, "properties": {} }, "Iteration": { "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Iteration.", "type": "string" }, "associated_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "created_at": { "description": "The time/date the Iteration was created.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the Iteration.", "type": "string", "nullable": true }, "end_date": { "description": "The end date of the Iteration (ISO 8601 date format, e.g. '2024-01-15').", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "iteration" ] }, "followers": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "id": { "description": "The unique ID of the Iteration.", "type": "integer", "format": "int64" }, "labels": { "$ref": "#/components/schemas/NestedLabelSlimList" }, "mentioned_members": { "$ref": "#/components/schemas/NestedMemberSlimList" }, "mentioned_teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "name": { "description": "The name of the Iteration.", "type": "string" }, "start_date": { "description": "The start date of the Iteration (ISO 8601 date format, e.g. '2024-01-01').", "type": "string" }, "stories": { "$ref": "#/components/schemas/NestedStorySlimList" }, "teams": { "$ref": "#/components/schemas/NestedTeamSlimList" }, "updated_at": { "description": "The time/date the Iteration was last updated.", "type": "string", "format": "date-time" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false }, "Response5197336": { "type": "object", "additionalProperties": false, "properties": {} }, "BulkUpdateStoryCommentsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Comment to update.", "type": "integer", "format": "int64" }, "text": { "maxLength": 100000, "description": "The comment text.", "type": "string" } }, "additionalProperties": false, "required": [ "id" ] }, "Response5197602": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197852": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196853": { "type": "object", "properties": { "epic_ids": { "minItems": 1, "maxItems": 100, "description": "Ids of the Epics to delete.", "type": "array", "items": { "type": "integer", "format": "int64" } } }, "additionalProperties": false, "required": [ "epic_ids" ] }, "UnusableEntitlementError": { "type": "object", "properties": { "entitlement_tag": { "maxLength": 63, "minLength": 1, "description": "Short tag describing the unusable entitlement action taken by the user.", "type": "string" }, "message": { "maxLength": 256, "minLength": 1, "description": "Message displayed to the user on why their action failed.", "type": "string" }, "reason_tag": { "description": "The tag for violating an entitlement action.", "type": "string", "enum": [ "entitlement-violation" ] } }, "additionalProperties": false, "required": [ "reason_tag", "entitlement_tag", "message" ] }, "Response5197325": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/DocEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197415": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197288": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/HealthEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196877": { "type": "object", "properties": { "description": { "maxLength": 2048, "minLength": 1, "description": "The Checklist Item description.", "type": "string" }, "completed": { "description": "True/false boolean indicating whether the Checklist Item is completed. Defaults to false.", "type": "boolean" }, "external_id": { "maxLength": 128, "description": "This field can be set to another unique ID. In the case that the Checklist Item has been imported from another tool, the ID in the other tool can be indicated here.", "type": "string" }, "set_position": { "$ref": "#/components/schemas/Body5196877SetPosition" } }, "additionalProperties": false, "required": [ "description" ] }, "Response5196969": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197314": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197438": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197709": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197378": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197124": { "type": "object", "additionalProperties": false, "properties": {} }, "IterationEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Iteration" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197553": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197690": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5196947": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197039": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197659": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/FileMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197164": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197489": { "type": "object", "additionalProperties": false, "properties": {} }, "StoryCommentMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Body5196893": { "type": "object", "properties": { "name": { "maxLength": 128, "minLength": 1, "description": "The name of the new entity template.", "type": "string" }, "story_contents": { "$ref": "#/components/schemas/CreateEntityTemplateStoryContentsParams" }, "author_id": { "description": "The ID of the member creating this template.", "type": "string", "format": "uuid" } }, "additionalProperties": false, "required": [ "name", "story_contents" ] }, "Response5197739": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197819": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197531": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryLinkEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryExternalLinkEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/ExternalLink" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197213": { "type": "object", "additionalProperties": false, "properties": {} }, "BranchEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Branch" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197274": { "type": "object", "additionalProperties": false, "properties": {} }, "Body5196869": { "type": "object", "properties": { "archived": { "description": "A true/false boolean indicating if the Label has been archived.", "type": "boolean" }, "color": { "description": "The hex color to be displayed with the Label (for example, \"#ff0000\").", "pattern": "^#[a-fA-F0-9]{6}$", "format": "css-color", "minLength": 1, "type": "string", "nullable": true }, "description": { "maxLength": 1024, "description": "The description of the Label.", "type": "string" }, "name": { "maxLength": 128, "minLength": 1, "description": "The name of the Label.", "type": "string" } }, "additionalProperties": false }, "LinkedFileMentionedMemberEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Member" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197611": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/ObjectiveEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197487": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197116": { "type": "object", "additionalProperties": false, "properties": {} }, "KeyResultValue": { "description": "The starting observed value of the Key Result.", "type": "object", "properties": { "created_at": { "description": "The time/date this value was created.", "type": "string", "format": "date-time" }, "creator": { "$ref": "#/components/schemas/MemberSlim" }, "boolean_value": { "description": "The boolean value. Present for boolean key results.", "type": "boolean" }, "numeric_value": { "description": "The numeric value as a decimal string. Present for numeric and percent key results.", "type": "string" } }, "additionalProperties": false, "required": [ "creator", "created_at" ] }, "Body5196863": { "type": "object", "properties": { "story_links": { "minItems": 1, "maxItems": 100, "description": "Payloads for each Story Link to create.", "type": "array", "items": { "$ref": "#/components/schemas/CreateStoryLinkParams" } } }, "additionalProperties": false, "required": [ "story_links" ] }, "Response5197012": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197407": { "type": "object", "additionalProperties": false, "properties": {} }, "CreateEpicParams": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The Epic's name.", "type": "string" }, "completed_at_override": { "description": "A manual override for the time/date the Epic was completed.", "type": "string", "format": "date-time" }, "deadline": { "description": "The Epic's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Epic's description.", "type": "string" }, "epic_state_id": { "description": "The ID of the Epic State.", "type": "integer", "format": "int64" }, "external_id": { "maxLength": 128, "description": "An external ID for the Epic.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for Members to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "objective_ids": { "description": "An array of IDs for Objectives to which this Epic is related.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "owner_ids": { "description": "An array of UUIDs for Members to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "planned_start_date": { "description": "The Epic's planned start date.", "type": "string", "format": "date-time", "nullable": true }, "requested_by_id": { "description": "The UUID of the Member that requested the Epic.", "type": "string", "format": "uuid" }, "started_at_override": { "description": "A manual override for the time/date the Epic was started.", "type": "string", "format": "date-time" }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name" ] }, "EntityTemplateEntityWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "entity": { "$ref": "#/components/schemas/EntityTemplate" } }, "additionalProperties": false, "required": [ "$schema", "entity" ] }, "EntityTemplateStoryContents": { "description": "A container entity for the attributes this template should populate.", "type": "object", "properties": { "custom_fields": { "description": "An array of maps specifying a CustomField ID and CustomFieldEnumValue ID that represents an assertion of some value for a CustomField.", "type": "array", "items": { "$ref": "#/components/schemas/CreateCustomFieldValueParams" } }, "deadline": { "description": "The due date of the story.", "type": "string", "format": "date-time" }, "description": { "description": "The description of the story.", "type": "string", "nullable": true }, "entity_type": { "description": "A string description of this resource.", "type": "string" }, "epic": { "$ref": "#/components/schemas/EpicSlim" }, "estimate": { "description": "The numeric point estimate of the story.", "type": "integer", "format": "int64" }, "external_links": { "description": "An array of external links connected to the story.", "type": "array", "items": { "type": "string" } }, "files": { "description": "An array of files attached to the story.", "type": "array", "items": { "$ref": "#/components/schemas/FileSlim" } }, "followers": { "description": "An array of Members listed as Followers.", "type": "array", "items": { "$ref": "#/components/schemas/MemberSlim" } }, "iteration": { "$ref": "#/components/schemas/IterationSlim" }, "labels": { "description": "An array of labels attached to the story.", "type": "array", "items": { "$ref": "#/components/schemas/LabelSlim" } }, "linked_files": { "description": "An array of linked files attached to the story.", "type": "array", "items": { "$ref": "#/components/schemas/LinkedFileSlim" } }, "name": { "description": "The name of the story.", "type": "string" }, "owners": { "description": "An array of Members who own the story.", "type": "array", "items": { "$ref": "#/components/schemas/MemberSlim" } }, "project": { "$ref": "#/components/schemas/ProjectSlim" }, "story_type": { "description": "The type of story (feature, bug, chore).", "type": "string" }, "sub_tasks": { "description": "An array of sub-tasks connected to the story.", "type": "array", "items": { "$ref": "#/components/schemas/EntityTemplateSubTask" } }, "tasks": { "description": "An array of tasks connected to the story.", "type": "array", "items": { "$ref": "#/components/schemas/EntityTemplateTask" } }, "team": { "$ref": "#/components/schemas/TeamSlim" }, "workflow_state": { "$ref": "#/components/schemas/WorkflowStateSlim" } }, "additionalProperties": false }, "Response5197019": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197053": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/CustomFieldEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197850": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197693": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197426": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197647": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicCommentEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Body5196849": { "type": "object", "properties": { "name": { "maxLength": 256, "minLength": 1, "description": "The Epic's name.", "type": "string" }, "completed_at_override": { "description": "A manual override for the time/date the Epic was completed.", "type": "string", "format": "date-time" }, "deadline": { "description": "The Epic's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Epic's description.", "type": "string" }, "epic_state_id": { "description": "The ID of the Epic State.", "type": "integer", "format": "int64" }, "external_id": { "maxLength": 128, "description": "An external ID for the Epic.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for Members to add as Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "objective_ids": { "description": "An array of IDs for Objectives to which this Epic is related.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "owner_ids": { "description": "An array of UUIDs for Members to add as Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "planned_start_date": { "description": "The Epic's planned start date.", "type": "string", "format": "date-time", "nullable": true }, "requested_by_id": { "description": "The UUID of the Member that requested the Epic.", "type": "string", "format": "uuid" }, "started_at_override": { "description": "A manual override for the time/date the Epic was started.", "type": "string", "format": "date-time" }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "name" ] }, "Body5196896ChecklistItemsSetPosition": { "description": "One of \"first\", \"last\", \"before\", or \"after\". This can be used to move the Checklist Item to the first or last position in the Story's checklist, or before or after a given Checklist Item.", "type": "object", "properties": { "position": { "type": "string", "enum": [ "after", "last", "before", "first" ] }, "anchor_checklist_item_id": { "type": "integer", "format": "int64" } }, "additionalProperties": false, "required": [ "position" ] }, "BulkUpdateEpicsParams1": { "type": "object", "properties": { "id": { "description": "The id of the Epic to update.", "type": "integer", "format": "int64" }, "archived": { "description": "Whether the Epic is archived.", "type": "boolean" }, "completed_at_override": { "description": "A manual override for the time/date the Epic was completed.", "type": "string", "format": "date-time", "nullable": true }, "deadline": { "description": "The Epic's deadline.", "type": "string", "format": "date-time", "nullable": true }, "description": { "maxLength": 100000, "description": "The Epic's description.", "type": "string" }, "epic_state_id": { "description": "The ID of the Epic State.", "type": "integer", "format": "int64" }, "external_id": { "maxLength": 128, "description": "An external ID for the Epic.", "type": "string" }, "follower_ids": { "description": "An array of UUIDs for Members to set as Followers. This will replace the current Followers on the Epic. Sending an empty array will delete all existing Followers.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_add": { "description": "An array of UUIDs for Members to add as Followers. These will be added to the current Followers on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "follower_ids_remove": { "description": "An array of UUIDs for Members to remove as Followers. These will be removed from the current Followers on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "name": { "maxLength": 256, "minLength": 1, "description": "The Epic's name.", "type": "string" }, "objective_ids": { "description": "An array of IDs for Objectives to which this Epic is related. This will replace the current Objectives on the Epic. Sending an empty array will remove all existing Objectives.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "objective_ids_add": { "description": "An array of IDs for Objectives to add to the Epic. These will be added to the current Objectives on the Epic.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "objective_ids_remove": { "description": "An array of IDs for Objectives to remove from the Epic. These will be removed from the current Objectives on the Epic.", "type": "array", "items": { "type": "integer", "format": "int64" } }, "owner_ids": { "description": "An array of UUIDs for Members to set as Owners. This will replace the current Owners on the Epic. Sending an empty array will delete all existing Owners.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_add": { "description": "An array of UUIDs for Members to add as Owners. These will be added to the current Owners on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "owner_ids_remove": { "description": "An array of UUIDs for Members to remove as Owners. These will be removed from the current Owners on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "planned_start_date": { "description": "The Epic's planned start date.", "type": "string", "format": "date-time", "nullable": true }, "requested_by_id": { "description": "The UUID of the Member that requested the Epic.", "type": "string", "format": "uuid" }, "started_at_override": { "description": "A manual override for the time/date the Epic was started.", "type": "string", "format": "date-time", "nullable": true }, "team_ids": { "description": "An array of UUIDs for Teams to associate with the Epic. This will replace the current Teams on the Epic. Sending an empty array will remove all existing Teams.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_add": { "description": "An array of UUIDs for Teams to add to the Epic. These will be added to the current Teams on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } }, "team_ids_remove": { "description": "An array of UUIDs for Teams to remove from the Epic. These will be removed from the current Teams on the Epic.", "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false, "required": [ "id" ] }, "ProjectSlim": { "description": "The Project the story belongs to.", "type": "object", "properties": { "app_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The Shortcut application url for the Project.", "type": "string" }, "entity_type": { "description": "The type of this entity.", "type": "string", "enum": [ "project:slim" ] }, "id": { "description": "The unique ID of the Project.", "type": "integer", "format": "int64" }, "name": { "description": "The name of the Project.", "type": "string" }, "uri": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A resolvable URI for the entity that will return the full representation.", "type": "string" } }, "additionalProperties": false, "required": [ "app_url", "entity_type", "id", "name", "uri" ] }, "Response5197641": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197169": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197536": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197564": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197806": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197608": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197547": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/IterationEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "StoryCommentCommentEntityListWrapper": { "type": "object", "properties": { "$schema": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "The URI for the json-schema for this response.", "type": "string" }, "current_items": { "description": "The number of items on the current page.", "type": "integer", "format": "int64" }, "current_page": { "description": "The number of the current page.", "type": "integer", "format": "int64" }, "entities": { "description": "The entities for this page.", "type": "array", "items": { "$ref": "#/components/schemas/Comment" } }, "total_items": { "description": "The number of total items across all pages.", "type": "integer", "format": "int64" }, "total_pages": { "description": "The total number of pages.", "type": "integer", "format": "int64" }, "next_page_url": { "pattern": "^https?://.+$", "maxLength": 2048, "description": "A URL to get the next page. Will be absent on the last page.", "type": "string" } }, "additionalProperties": false, "required": [ "$schema", "current_items", "current_page", "entities", "total_items", "total_pages" ] }, "Response5197275": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197515": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/StoryChecklistItemMentionedMemberEntityListWrapper" } }, "additionalProperties": false, "required": [ "schema" ] }, "Response5197612": { "type": "object", "additionalProperties": false, "properties": {} }, "Response5197130": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/EpicEntityWrapper" } }, "additionalProperties": false, "required": [ "schema" ] } }, "securitySchemes": { "BearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "Shortcut Token" } }, "responses": { "Response5197069": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197069" } } } }, "Response5197582": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197582" } } } }, "Response5197800": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197800" } } } }, "Response5197542": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197542" } } } }, "Response5196951": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196951" } } } }, "Response5197106": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197106" } } }, "description": "Resource" }, "Response5197289": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197289" } } } }, "Response5196994": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196994" } } } }, "Response5197736": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197736" } } } }, "Response5197081": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197081" } } } }, "Response5197718": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197718" } } } }, "Response5197267": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197267" } } } }, "Response5197575": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197575" } } }, "description": "Resource" }, "Response5197116": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197116" } } } }, "Response5197570": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197570" } } } }, "Response5197577": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197577" } } } }, "Response5197291": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197291" } } } }, "Response5197131": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197131" } } } }, "Response5197428": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197428" } } } }, "Response5197819": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197819" } } }, "description": "Resource" }, "Response5197225": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197225" } } } }, "Response5197709": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197709" } } } }, "Response5197680": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197680" } } } }, "Response5197737": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197737" } } } }, "Response5197014": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197014" } } } }, "Response5197348": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197348" } } } }, "Response5197681": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197681" } } } }, "Response5197724": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197724" } } } }, "Response5197576": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197576" } } } }, "Response5197033": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197033" } } } }, "Response5197479": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197479" } } }, "description": "Resource" }, "Response5197268": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197268" } } }, "description": "Resource" }, "Response5197282": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197282" } } } }, "Response5197470": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197470" } } } }, "Response5197723": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197723" } } }, "description": "Resource" }, "Response5197583": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197583" } } }, "description": "Resource" }, "Response5197404": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197404" } } } }, "Response5197593": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197593" } } } }, "Response5196992": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196992" } } }, "description": "Resource" }, "Response5197034": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197034" } } } }, "Response5197846": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197846" } } } }, "Response5197472": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197472" } } } }, "Response5197534": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197534" } } } }, "Response5197103": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197103" } } } }, "Response5197448": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197448" } } } }, "Response5197539": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197539" } } }, "description": "Resource" }, "Response5197726": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197726" } } } }, "Response5196969": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196969" } } } }, "Response5197649": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197649" } } } }, "Response5197186": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197186" } } }, "description": "Resource" }, "Response5197703": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197703" } } }, "description": "Resource" }, "Response5197004": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197004" } } }, "description": "Resource" }, "Response5197845": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197845" } } } }, "Response5197594": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197594" } } } }, "Response5196944": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196944" } } }, "description": "Resource" }, "Response5197505": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197505" } } } }, "Response5197006": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197006" } } } }, "Response5197451": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197451" } } }, "description": "No Content" }, "Response5197123": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197123" } } } }, "Response5197452": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197452" } } } }, "Response5197666": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197666" } } } }, "Response5197572": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197572" } } } }, "Response5197238": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197238" } } } }, "Response5197266": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197266" } } } }, "Response5197565": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197565" } } } }, "Response5197704": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197704" } } } }, "Response5196924": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196924" } } }, "description": "Resource" }, "Response5197733": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197733" } } } }, "Response5197695": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197695" } } }, "description": "Resource" }, "Response5196965": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196965" } } } }, "Response5197689": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197689" } } } }, "Response5197563": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197563" } } }, "description": "Resource" }, "Response5197044": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197044" } } } }, "Response5197211": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197211" } } } }, "Response5196938": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196938" } } } }, "Response5197725": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197725" } } } }, "Response5197243": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197243" } } }, "description": "Resource" }, "Response5197183": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197183" } } } }, "Response5197260": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197260" } } } }, "Response5197368": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197368" } } } }, "Response5196937": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196937" } } } }, "Response5197683": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197683" } } }, "description": "Resource" }, "Response5197035": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197035" } } } }, "Response5197369": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197369" } } } }, "Response5197228": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197228" } } } }, "Response5197021": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197021" } } } }, "Response5196983": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196983" } } } }, "Response5197236": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197236" } } } }, "Response5197366": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197366" } } }, "description": "Resource" }, "Response5197018": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197018" } } } }, "Response5197050": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197050" } } } }, "Response5197674": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197674" } } } }, "Response5197528": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197528" } } } }, "Response5197311": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197311" } } } }, "Response5197202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197202" } } }, "description": "Resource" }, "Response5197206": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197206" } } }, "description": "No Content" }, "Response5197080": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197080" } } } }, "Response5197722": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197722" } } } }, "Response5197833": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197833" } } } }, "Response5197022": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197022" } } } }, "Response5197364": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197364" } } } }, "Response5197229": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197229" } } } }, "Response5197297": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197297" } } } }, "Response5197468": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197468" } } } }, "Response5197609": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197609" } } } }, "Response5196970": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196970" } } } }, "Response5197333": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197333" } } } }, "Response5197100": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197100" } } } }, "Response5197040": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197040" } } } }, "Response5197587": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197587" } } }, "description": "Resource" }, "Response5197133": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197133" } } } }, "Response5197535": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197535" } } }, "description": "Resource" }, "Response5197088": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197088" } } } }, "Response5196971": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196971" } } } }, "Response5197038": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197038" } } } }, "Response5197341": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197341" } } } }, "Response5197705": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197705" } } } }, "Response5197032": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197032" } } }, "description": "Resource" }, "Response5197124": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197124" } } } }, "Response5197030": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197030" } } } }, "Response5197764": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197764" } } } }, "Response5197380": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197380" } } } }, "Response5197756": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197756" } } } }, "Response5197790": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197790" } } } }, "Response5197773": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197773" } } } }, "Response5197648": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197648" } } } }, "Response5197328": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197328" } } } }, "Response5197027": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197027" } } } }, "Response5197182": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197182" } } }, "description": "Resource" }, "Response5197706": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197706" } } } }, "Response5197836": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197836" } } } }, "Response5197007": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197007" } } } }, "Response5197220": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197220" } } } }, "Response5197048": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197048" } } } }, "Response5197503": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197503" } } }, "description": "No Content" }, "Response5197061": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197061" } } } }, "Response5197288": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197288" } } }, "description": "Resource" }, "Response5196998": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196998" } } } }, "Response5197327": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197327" } } } }, "Response5197435": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197435" } } }, "description": "Resource" }, "Response5197043": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197043" } } } }, "Response5197153": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197153" } } } }, "Response5197257": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197257" } } } }, "Response5197485": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197485" } } } }, "Response5197129": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197129" } } } }, "Response5197215": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197215" } } } }, "Response5197457": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197457" } } } }, "Response5197772": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197772" } } } }, "Response5197104": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197104" } } } }, "Response5197567": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197567" } } }, "description": "Resource" }, "Response5197832": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197832" } } } }, "Response5197294": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197294" } } } }, "Response5196958": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196958" } } } }, "Response5197360": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197360" } } } }, "Response5197213": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197213" } } } }, "Response5197584": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197584" } } } }, "Response5197125": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197125" } } } }, "Response5197770": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197770" } } } }, "Response5197710": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197710" } } } }, "Response5197549": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197549" } } } }, "Response5197385": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197385" } } } }, "Response5197235": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197235" } } }, "description": "No Content" }, "Response5197561": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197561" } } } }, "Response5197805": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197805" } } } }, "Response5197287": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197287" } } } }, "Response5197516": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197516" } } } }, "Response5197178": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197178" } } }, "description": "No Content" }, "Response5197731": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197731" } } }, "description": "No Content" }, "Response5197067": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197067" } } } }, "Response5197492": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197492" } } } }, "Response5197807": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197807" } } }, "description": "Resource" }, "Response5197418": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197418" } } } }, "Response5197853": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197853" } } } }, "Response5197070": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197070" } } }, "description": "Resource" }, "Response5197686": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197686" } } } }, "Response5197203": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197203" } } } }, "Response5197557": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197557" } } } }, "Response5197491": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197491" } } }, "description": "Resource" }, "Response5197462": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197462" } } } }, "Response5197786": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197786" } } } }, "Response5197701": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197701" } } } }, "Response5197754": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197754" } } } }, "Response5197198": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197198" } } }, "description": "Resource" }, "Response5197222": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197222" } } } }, "Response5197057": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197057" } } }, "description": "Resource" }, "Response5197578": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197578" } } } }, "Response5196980": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196980" } } }, "description": "Resource" }, "Response5197423": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197423" } } }, "description": "Resource" }, "Response5197632": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197632" } } } }, "Response5197309": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197309" } } } }, "Response5197159": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197159" } } } }, "Response5196987": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196987" } } } }, "Response5197769": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197769" } } } }, "Response5197204": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197204" } } } }, "Response5197172": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197172" } } } }, "Response5197249": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197249" } } } }, "Response5197793": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197793" } } } }, "Response5197399": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197399" } } } }, "Response5197429": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197429" } } } }, "Response5197795": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197795" } } }, "description": "Resource" }, "Response5197414": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197414" } } } }, "Response5197526": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197526" } } } }, "Response5197150": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197150" } } }, "description": "Resource" }, "Response5197702": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197702" } } } }, "Response5197713": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197713" } } } }, "Response5197656": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197656" } } } }, "Response5197210": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197210" } } }, "description": "Resource" }, "Response5197056": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197056" } } } }, "Response5197586": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197586" } } } }, "Response5197190": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197190" } } }, "description": "Resource" }, "Response5197476": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197476" } } } }, "Response5197699": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197699" } } }, "description": "No Content" }, "Response5197469": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197469" } } } }, "Response5197233": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197233" } } } }, "Response5197138": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197138" } } }, "description": "Resource" }, "Response5197506": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197506" } } } }, "Response5197824": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197824" } } } }, "Response5197317": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197317" } } } }, "Response5196955": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196955" } } } }, "Response5197003": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197003" } } } }, "Response5197663": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197663" } } }, "description": "No Content" }, "Response5197241": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197241" } } } }, "Response5197149": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197149" } } } }, "Response5196990": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196990" } } } }, "Response5197171": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197171" } } } }, "Response5197420": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197420" } } } }, "Response5197560": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197560" } } } }, "Response5197809": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197809" } } } }, "Response5197676": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197676" } } } }, "Response5197165": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197165" } } } }, "Response5197529": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197529" } } } }, "Response5197758": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197758" } } } }, "Response5197438": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197438" } } } }, "Response5197011": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197011" } } } }, "Response5197728": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197728" } } } }, "Response5197041": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197041" } } }, "description": "Resource" }, "Response5197232": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197232" } } } }, "Response5196933": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196933" } } } }, "Response5197616": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197616" } } } }, "Response5197511": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197511" } } }, "description": "Resource" }, "Response5197744": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197744" } } } }, "Response5197137": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197137" } } } }, "Response5197377": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197377" } } } }, "Response5197504": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197504" } } } }, "Response5197179": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197179" } } } }, "Response5197205": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197205" } } } }, "Response5197729": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197729" } } } }, "Response5197652": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197652" } } } }, "Response5197517": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197517" } } } }, "Response5196936": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196936" } } }, "description": "Resource" }, "Response5197408": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197408" } } } }, "Response5197520": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197520" } } } }, "Response5197823": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197823" } } }, "description": "Resource" }, "Response5197658": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197658" } } } }, "Response5197102": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197102" } } }, "description": "No Content" }, "Response5197168": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197168" } } } }, "Response5197329": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197329" } } } }, "Response5197449": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197449" } } } }, "Response5197015": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197015" } } } }, "Response5197313": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197313" } } } }, "Response5197158": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197158" } } }, "description": "No Content" }, "Response5197634": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197634" } } } }, "Response5197687": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197687" } } }, "description": "No Content" }, "Response5197842": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197842" } } } }, "Response5197029": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197029" } } } }, "Response5197277": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197277" } } } }, "Response5197787": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197787" } } }, "description": "No Content" }, "Response5197307": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197307" } } } }, "Response5197413": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197413" } } } }, "Response5197514": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197514" } } } }, "Response5197269": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197269" } } } }, "Response5197803": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197803" } } }, "description": "Resource" }, "Response5197097": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197097" } } } }, "Response5197101": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197101" } } } }, "Response5197108": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197108" } } } }, "Response5197078": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197078" } } }, "description": "Resource" }, "Response5197671": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197671" } } }, "description": "Resource" }, "Response5197400": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197400" } } } }, "Response5196988": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196988" } } }, "description": "Resource" }, "Response5197478": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197478" } } } }, "Response5197402": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197402" } } }, "description": "Resource" }, "Response5197161": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197161" } } } }, "Response5197743": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197743" } } }, "description": "Resource" }, "Response5197248": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197248" } } } }, "Response5197189": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197189" } } } }, "Response5197461": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197461" } } } }, "Response5197284": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197284" } } }, "description": "Resource" }, "Response5197072": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197072" } } } }, "Response5197532": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197532" } } } }, "Response5196959": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196959" } } } }, "Response5197477": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197477" } } } }, "Response5197303": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197303" } } } }, "Response5197359": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197359" } } } }, "Response5196960": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196960" } } }, "description": "No Content" }, "Response5197651": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197651" } } }, "description": "Resource" }, "Response5197346": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197346" } } }, "description": "No Content" }, "Response5197707": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197707" } } }, "description": "Resource" }, "Response5197347": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197347" } } } }, "Response5197496": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197496" } } } }, "Response5197585": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197585" } } } }, "Response5197337": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197337" } } } }, "Response5197607": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197607" } } }, "description": "No Content" }, "Response5197475": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197475" } } }, "description": "Resource" }, "Response5197678": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197678" } } } }, "Response5197187": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197187" } } } }, "Response5197324": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197324" } } } }, "Response5197533": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197533" } } } }, "Response5197677": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197677" } } } }, "Response5197270": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197270" } } } }, "Response5197792": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197792" } } } }, "Response5197052": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197052" } } } }, "Response5197227": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197227" } } }, "description": "Resource" }, "Response5197714": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197714" } } } }, "Response5197367": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197367" } } } }, "Response5197285": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197285" } } } }, "Response5197660": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197660" } } } }, "Response5196952": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196952" } } }, "description": "Resource" }, "Response5197397": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197397" } } } }, "Response5197716": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197716" } } } }, "Response5197345": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197345" } } } }, "Response5196977": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196977" } } } }, "Response5197264": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197264" } } } }, "Response5197531": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197531" } } }, "description": "Resource" }, "Response5197281": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197281" } } } }, "Response5197812": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197812" } } } }, "Response5197180": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197180" } } } }, "Response5197382": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197382" } } }, "description": "Resource" }, "Response5197463": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197463" } } }, "description": "Resource" }, "Response5197177": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197177" } } } }, "Response5197411": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197411" } } }, "description": "Resource" }, "Response5197642": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197642" } } } }, "Response5196947": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196947" } } } }, "Response5197276": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197276" } } }, "description": "Resource" }, "Response5197315": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197315" } } } }, "Response5197562": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197562" } } } }, "Response5197192": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197192" } } } }, "Response5197290": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197290" } } } }, "Response5196985": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196985" } } } }, "Response5197305": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197305" } } } }, "Response5197252": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197252" } } } }, "Response5197692": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197692" } } } }, "Response5197748": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197748" } } } }, "Response5197063": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197063" } } } }, "Response5197065": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197065" } } } }, "Response5197355": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197355" } } } }, "Response5197422": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197422" } } } }, "Response5197635": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197635" } } }, "description": "Resource" }, "Response5197493": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197493" } } } }, "Response5197105": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197105" } } } }, "Response5197145": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197145" } } } }, "Response5197407": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197407" } } } }, "Response5197474": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197474" } } } }, "Response5197357": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197357" } } } }, "Response5197489": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197489" } } } }, "Response5197331": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197331" } } } }, "Response5197500": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197500" } } } }, "Response5197816": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197816" } } } }, "Response5197753": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197753" } } } }, "Response5197058": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197058" } } } }, "Response5197669": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197669" } } } }, "Response5197173": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197173" } } } }, "Response5197623": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197623" } } }, "description": "Resource" }, "Response5197302": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197302" } } } }, "Response5196968": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196968" } } }, "description": "Resource" }, "Response5197465": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197465" } } } }, "Response5197170": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197170" } } }, "description": "Resource" }, "Response5196934": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196934" } } } }, "Response5197401": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197401" } } } }, "Response5197762": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197762" } } } }, "Response5197574": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197574" } } } }, "Response5197615": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197615" } } }, "description": "Resource" }, "Response5197151": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197151" } } } }, "Response5197814": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197814" } } } }, "Response5197627": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197627" } } }, "description": "Resource" }, "Response5197127": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197127" } } } }, "Response5196973": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196973" } } } }, "Response5197001": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197001" } } } }, "Response5197647": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197647" } } }, "description": "Resource" }, "Response5197373": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197373" } } } }, "Response5197525": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197525" } } } }, "Response5197082": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197082" } } }, "description": "Resource" }, "Response5197323": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197323" } } } }, "Response5197181": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197181" } } } }, "Response5197209": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197209" } } } }, "Response5197073": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197073" } } } }, "Response5197036": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197036" } } } }, "Response5197246": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197246" } } } }, "Response5197670": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197670" } } } }, "Response5197010": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197010" } } } }, "Response5197553": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197553" } } } }, "Response5197120": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197120" } } } }, "Response5197757": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197757" } } } }, "Response5197148": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197148" } } } }, "Response5197802": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197802" } } } }, "Response5197467": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197467" } } }, "description": "Resource" }, "Response5197640": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197640" } } } }, "Response5197597": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197597" } } } }, "Response5197231": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197231" } } }, "description": "Resource" }, "Response5197334": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197334" } } }, "description": "Resource" }, "Response5197454": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197454" } } } }, "Response5197195": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197195" } } } }, "Response5196927": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196927" } } } }, "Response5197537": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197537" } } } }, "Response5196956": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196956" } } }, "description": "Resource" }, "Response5197415": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197415" } } }, "description": "Resource" }, "Response5197794": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197794" } } } }, "Response5197548": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197548" } } } }, "Response5197494": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197494" } } } }, "Response5197009": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197009" } } } }, "Response5196940": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196940" } } }, "description": "No Content" }, "Response5197589": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197589" } } } }, "Response5197829": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197829" } } } }, "Response5197653": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197653" } } } }, "Response5197223": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197223" } } }, "description": "Resource" }, "Response5197379": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197379" } } } }, "Response5197335": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197335" } } } }, "Response5197169": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197169" } } } }, "Response5197325": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197325" } } }, "description": "Resource" }, "Response5197854": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197854" } } } }, "Response5197037": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197037" } } }, "description": "Resource" }, "Response5196950": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196950" } } } }, "Response5197591": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197591" } } }, "description": "Resource" }, "Response5197759": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197759" } } }, "description": "No Content" }, "Response5197507": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197507" } } }, "description": "Resource" }, "Response5197843": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197843" } } }, "description": "Resource" }, "Response5197515": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197515" } } }, "description": "Resource" }, "Response5197775": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197775" } } }, "description": "Resource" }, "Response5197488": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197488" } } } }, "Response5197638": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197638" } } } }, "Response5197614": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197614" } } } }, "Response5197738": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197738" } } } }, "Response5197362": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197362" } } }, "description": "Resource" }, "Response5197727": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197727" } } }, "description": "Resource" }, "Response5197815": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197815" } } }, "description": "No Content" }, "Response5197779": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197779" } } }, "description": "Resource" }, "Response5196929": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196929" } } } }, "Response5197761": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197761" } } } }, "Response5197730": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197730" } } } }, "Response5197254": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197254" } } } }, "Response5197522": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197522" } } } }, "Response5197295": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197295" } } } }, "Response5196948": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196948" } } }, "description": "Resource" }, "Response5197117": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197117" } } } }, "Response5197464": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197464" } } } }, "Response5197555": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197555" } } }, "description": "No Content" }, "Response5197389": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197389" } } } }, "Response5197114": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197114" } } }, "description": "Resource" }, "Response5197292": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197292" } } }, "description": "Resource" }, "Response5197085": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197085" } } } }, "Response5197176": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197176" } } } }, "Response5197708": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197708" } } } }, "Response5197216": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197216" } } } }, "Response5197298": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197298" } } } }, "Response5197312": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197312" } } }, "description": "Resource" }, "Response5197273": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197273" } } } }, "Response5197453": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197453" } } } }, "Response5197693": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197693" } } } }, "Response5197013": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197013" } } } }, "Response5197314": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197314" } } } }, "Response5197107": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197107" } } } }, "Response5197237": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197237" } } } }, "Response5197113": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197113" } } } }, "Response5197732": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197732" } } } }, "Response5197763": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197763" } } }, "description": "Resource" }, "Response5197545": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197545" } } } }, "Response5197293": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197293" } } } }, "Response5197242": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197242" } } } }, "Response5197251": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197251" } } }, "description": "No Content" }, "Response5197655": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197655" } } }, "description": "Resource" }, "Response5197691": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197691" } } }, "description": "Resource" }, "Response5197698": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197698" } } } }, "Response5196939": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196939" } } } }, "Response5197847": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197847" } } }, "description": "Resource" }, "Response5197717": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197717" } } } }, "Response5197688": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197688" } } } }, "Response5197571": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197571" } } }, "description": "Resource" }, "Response5196978": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196978" } } } }, "Response5197395": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197395" } } } }, "Response5197599": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197599" } } }, "description": "Resource" }, "Response5197427": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197427" } } }, "description": "Resource" }, "Response5197808": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197808" } } } }, "Response5197384": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197384" } } } }, "Response5197090": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197090" } } }, "description": "Resource" }, "Response5197527": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197527" } } }, "description": "Resource" }, "Response5197828": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197828" } } } }, "Response5197850": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197850" } } } }, "Response5197026": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197026" } } } }, "Response5196942": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196942" } } } }, "Response5197618": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197618" } } } }, "Response5196961": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196961" } } } }, "Response5197839": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197839" } } }, "description": "Resource" }, "Response5197350": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197350" } } }, "description": "Resource" }, "Response5197075": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197075" } } } }, "Response5197810": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197810" } } } }, "Response5197820": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197820" } } } }, "Response5197679": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197679" } } }, "description": "Resource" }, "Response5197126": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197126" } } }, "description": "Resource" }, "Response5197391": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197391" } } } }, "Response5197700": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197700" } } } }, "Response5197031": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197031" } } } }, "Response5197140": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197140" } } } }, "Response5197005": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197005" } } } }, "Response5197316": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197316" } } }, "description": "Resource" }, "Response5197433": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197433" } } } }, "Response5197661": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197661" } } } }, "Response5197416": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197416" } } } }, "Response5197645": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197645" } } } }, "Response5197185": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197185" } } } }, "Response5197343": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197343" } } } }, "Response5197383": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197383" } } } }, "Response5197012": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197012" } } }, "description": "Resource" }, "Response5197336": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197336" } } } }, "Response5197818": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197818" } } } }, "Response5197008": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197008" } } }, "description": "No Content" }, "Response5197417": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197417" } } } }, "Response5197662": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197662" } } } }, "Response5197564": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197564" } } } }, "Response5197498": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197498" } } } }, "Response5196995": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196995" } } } }, "Response5197059": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197059" } } } }, "Response5197797": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197797" } } } }, "Response5197852": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197852" } } } }, "Response5197062": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197062" } } }, "description": "No Content" }, "Response5197136": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197136" } } } }, "Response5197306": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197306" } } } }, "Response5197508": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197508" } } } }, "Response5197646": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197646" } } } }, "Response5197835": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197835" } } }, "description": "Resource" }, "Response5197751": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197751" } } }, "description": "Resource" }, "Response5197049": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197049" } } }, "description": "Resource" }, "Response5197466": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197466" } } } }, "Response5197372": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197372" } } } }, "Response5197580": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197580" } } } }, "Response5197720": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197720" } } } }, "Response5197370": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197370" } } }, "description": "Resource" }, "Response5197781": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197781" } } } }, "Response5197142": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197142" } } }, "description": "Resource" }, "Response5197749": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197749" } } } }, "Response5197437": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197437" } } } }, "Response5197752": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197752" } } } }, "Response5196935": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196935" } } } }, "Response5197536": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197536" } } } }, "Response5197421": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197421" } } } }, "Response5197060": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197060" } } } }, "Response5197175": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197175" } } } }, "Response5197817": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197817" } } } }, "Response5197280": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197280" } } }, "description": "Resource" }, "Response5197118": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197118" } } }, "description": "Resource" }, "Response5197319": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197319" } } } }, "Response5197144": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197144" } } } }, "Response5197519": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197519" } } }, "description": "Resource" }, "Response5196954": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196954" } } } }, "Response5197218": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197218" } } }, "description": "Resource" }, "Response5197208": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197208" } } } }, "Response5197822": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197822" } } } }, "Response5197054": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197054" } } } }, "Response5197801": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197801" } } } }, "Response5197768": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197768" } } } }, "Response5196945": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196945" } } } }, "Response5197047": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197047" } } } }, "Response5197552": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197552" } } } }, "Response5197191": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197191" } } } }, "Response5197484": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197484" } } } }, "Response5197512": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197512" } } } }, "Response5197358": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197358" } } }, "description": "Resource" }, "Response5197791": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197791" } } }, "description": "Resource" }, "Response5196976": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196976" } } }, "description": "Resource" }, "Response5197308": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197308" } } }, "description": "Resource" }, "Response5197304": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197304" } } }, "description": "No Content" }, "Response5197152": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197152" } } } }, "Response5197217": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197217" } } } }, "Response5197760": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197760" } } } }, "Response5197841": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197841" } } } }, "Response5197784": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197784" } } } }, "Response5197207": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197207" } } } }, "Response5197650": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197650" } } } }, "Response5197023": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197023" } } } }, "Response5197595": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197595" } } }, "description": "Resource" }, "Response5197392": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197392" } } } }, "Response5197502": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197502" } } } }, "Response5197376": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197376" } } } }, "Response5197602": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197602" } } } }, "Response5197426": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197426" } } } }, "Response5197432": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197432" } } } }, "Response5197799": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197799" } } }, "description": "Resource" }, "Response5197219": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197219" } } } }, "Response5196993": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196993" } } } }, "Response5197834": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197834" } } } }, "Response5197622": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197622" } } } }, "Response5197719": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197719" } } }, "description": "Resource" }, "Response5197077": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197077" } } } }, "Response5197119": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197119" } } } }, "Response5197256": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197256" } } } }, "Response5197778": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197778" } } } }, "Response5197641": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197641" } } } }, "Response5197598": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197598" } } } }, "Response5196972": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196972" } } }, "description": "Resource" }, "Response5197155": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197155" } } } }, "Response5197523": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197523" } } }, "description": "Resource" }, "Response5197603": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197603" } } }, "description": "Resource" }, "Response5197431": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197431" } } }, "description": "Resource" }, "Response5197697": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197697" } } } }, "Response5197654": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197654" } } } }, "Response5197274": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197274" } } } }, "Response5197821": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197821" } } } }, "Response5197601": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197601" } } } }, "Response5197086": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197086" } } }, "description": "Resource" }, "Response5197356": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197356" } } } }, "Response5197234": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197234" } } } }, "Response5197633": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197633" } } } }, "Response5197750": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197750" } } } }, "Response5196967": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196967" } } } }, "Response5197121": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197121" } } } }, "Response5197083": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197083" } } } }, "Response5197550": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197550" } } } }, "Response5197353": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197353" } } } }, "Response5197568": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197568" } } } }, "Response5197673": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197673" } } } }, "Response5197128": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197128" } } } }, "Response5197199": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197199" } } } }, "Response5197524": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197524" } } } }, "Response5197388": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197388" } } } }, "Response5197739": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197739" } } }, "description": "Resource" }, "Response5197174": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197174" } } }, "description": "Resource" }, "Response5197338": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197338" } } }, "description": "Resource" }, "Response5197785": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197785" } } } }, "Response5197371": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197371" } } } }, "Response5197262": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197262" } } } }, "Response5197074": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197074" } } }, "description": "Resource" }, "Response5197798": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197798" } } } }, "Response5197510": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197510" } } } }, "Response5197272": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197272" } } }, "description": "Resource" }, "Response5197544": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197544" } } } }, "Response5197099": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197099" } } } }, "Response5197349": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197349" } } } }, "Response5197406": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197406" } } }, "description": "Resource" }, "Response5197259": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197259" } } }, "description": "Resource" }, "Response5197621": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197621" } } } }, "Response5197826": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197826" } } } }, "Response5197625": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197625" } } } }, "Response5197631": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197631" } } }, "description": "Resource" }, "Response5197694": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197694" } } } }, "Response5197445": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197445" } } } }, "Response5197025": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197025" } } } }, "Response5197320": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197320" } } }, "description": "Resource" }, "Response5197848": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197848" } } } }, "Response5196963": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196963" } } } }, "Response5197668": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197668" } } } }, "Response5197782": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197782" } } } }, "Response5197501": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197501" } } } }, "Response5197460": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197460" } } } }, "Response5197020": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197020" } } }, "description": "Resource" }, "Response5197363": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197363" } } } }, "Response5197606": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197606" } } } }, "Response5197091": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197091" } } } }, "Response5197643": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197643" } } }, "description": "No Content" }, "Response5197352": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197352" } } } }, "Response5197450": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197450" } } } }, "Response5197393": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197393" } } } }, "Response5197079": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197079" } } } }, "Response5197412": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197412" } } } }, "Response5197156": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197156" } } } }, "Response5197193": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197193" } } } }, "Response5197188": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197188" } } } }, "Response5197111": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197111" } } } }, "Response5197378": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197378" } } }, "description": "No Content" }, "Response5197600": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197600" } } } }, "Response5197518": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197518" } } } }, "Response5197495": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197495" } } }, "description": "Resource" }, "Response5197766": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197766" } } } }, "Response5197745": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197745" } } } }, "Response5197844": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197844" } } } }, "Response5197084": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197084" } } } }, "Response5197068": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197068" } } } }, "Response5197755": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197755" } } }, "description": "Resource" }, "Response5197332": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197332" } } } }, "Response5197624": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197624" } } } }, "Response5197499": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197499" } } }, "description": "Resource" }, "Response5197184": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197184" } } } }, "Response5197163": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197163" } } } }, "Response5197296": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197296" } } }, "description": "Resource" }, "Response5197143": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197143" } } } }, "Response5197226": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197226" } } } }, "Response5196925": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196925" } } } }, "Response5197405": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197405" } } } }, "Response5197132": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197132" } } } }, "Response5197776": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197776" } } } }, "Response5197513": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197513" } } } }, "Response5197521": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197521" } } } }, "Response5197446": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197446" } } } }, "Response5197566": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197566" } } } }, "Response5197483": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197483" } } }, "description": "No Content" }, "Response5197558": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197558" } } } }, "Response5197559": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197559" } } }, "description": "Resource" }, "Response5197425": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197425" } } } }, "Response5197830": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197830" } } } }, "Response5197746": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197746" } } } }, "Response5197777": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197777" } } } }, "Response5197617": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197617" } } } }, "Response5197398": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197398" } } }, "description": "Resource" }, "Response5197016": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197016" } } }, "description": "Resource" }, "Response5197053": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197053" } } }, "description": "Resource" }, "Response5197064": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197064" } } } }, "Response5197588": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197588" } } } }, "Response5197734": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197734" } } } }, "Response5197135": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197135" } } } }, "Response5197806": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197806" } } } }, "Response5197825": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197825" } } } }, "Response5197361": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197361" } } } }, "Response5197299": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197299" } } } }, "Response5197838": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197838" } } } }, "Response5197811": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197811" } } }, "description": "Resource" }, "Response5197471": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197471" } } }, "description": "Resource" }, "Response5196957": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196957" } } } }, "Response5197224": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197224" } } } }, "Response5197443": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197443" } } }, "description": "Resource" }, "Response5197626": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197626" } } } }, "Response5197167": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197167" } } } }, "Response5197813": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197813" } } } }, "Response5197456": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197456" } } } }, "Response5197326": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197326" } } } }, "Response5197110": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197110" } } }, "description": "Resource" }, "Response5197147": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197147" } } } }, "Response5197747": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197747" } } }, "description": "Resource" }, "Response5197827": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197827" } } }, "description": "Resource" }, "Response5197094": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197094" } } }, "description": "Resource" }, "Response5197112": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197112" } } } }, "Response5197551": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197551" } } }, "description": "Resource" }, "Response5196964": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196964" } } }, "description": "No Content" }, "Response5197573": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197573" } } } }, "Response5197160": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197160" } } } }, "Response5197742": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197742" } } } }, "Response5197039": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197039" } } } }, "Response5196996": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196996" } } }, "description": "Resource" }, "Response5197741": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197741" } } } }, "Response5197098": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197098" } } }, "description": "Resource" }, "Response5197255": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197255" } } }, "description": "Resource" }, "Response5197473": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197473" } } } }, "Response5197783": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197783" } } }, "description": "Resource" }, "Response5197605": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197605" } } } }, "Response5196979": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196979" } } } }, "Response5196991": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196991" } } } }, "Response5197765": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197765" } } } }, "Response5197455": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197455" } } }, "description": "Resource" }, "Response5197458": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197458" } } } }, "Response5197212": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197212" } } } }, "Response5197441": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197441" } } } }, "Response5197774": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197774" } } } }, "Response5197141": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197141" } } } }, "Response5197636": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197636" } } } }, "Response5197696": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197696" } } } }, "Response5197711": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197711" } } }, "description": "Resource" }, "Response5197024": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197024" } } }, "description": "Resource" }, "Response5197381": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197381" } } } }, "Response5197055": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197055" } } } }, "Response5197240": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197240" } } } }, "Response5197351": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197351" } } } }, "Response5196981": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196981" } } } }, "Response5197735": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197735" } } }, "description": "Resource" }, "Response5197659": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197659" } } }, "description": "Resource" }, "Response5197481": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197481" } } } }, "Response5197684": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197684" } } } }, "Response5197394": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197394" } } }, "description": "Resource" }, "Response5197590": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197590" } } } }, "Response5197840": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197840" } } } }, "Response5197115": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197115" } } } }, "Response5196941": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196941" } } } }, "Response5197546": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197546" } } } }, "Response5196975": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196975" } } } }, "Response5197740": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197740" } } } }, "Response5197066": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197066" } } }, "description": "Resource" }, "Response5197028": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197028" } } }, "description": "Resource" }, "Response5197197": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197197" } } } }, "Response5197301": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197301" } } } }, "Response5196932": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196932" } } }, "description": "Resource" }, "Response5197629": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197629" } } } }, "Response5197071": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197071" } } } }, "Response5197244": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197244" } } } }, "Response5197247": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197247" } } }, "description": "Resource" }, "Response5197675": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197675" } } }, "description": "Resource" }, "Response5197611": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197611" } } }, "description": "Resource" }, "Response5197286": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197286" } } } }, "Response5197283": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197283" } } } }, "Response5196989": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196989" } } } }, "Response5197715": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197715" } } }, "description": "Resource" }, "Response5197538": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197538" } } } }, "Response5197771": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197771" } } }, "description": "Resource" }, "Response5197042": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197042" } } } }, "Response5197139": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197139" } } } }, "Response5197261": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197261" } } } }, "Response5197613": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197613" } } } }, "Response5197610": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197610" } } } }, "Response5197375": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197375" } } } }, "Response5197196": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197196" } } } }, "Response5197162": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197162" } } }, "description": "Resource" }, "Response5196984": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196984" } } }, "description": "Resource" }, "Response5197271": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197271" } } } }, "Response5197318": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197318" } } } }, "Response5197253": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197253" } } } }, "Response5197497": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197497" } } } }, "Response5197788": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197788" } } } }, "Response5197321": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197321" } } } }, "Response5197543": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197543" } } }, "description": "No Content" }, "Response5197340": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197340" } } } }, "Response5197509": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197509" } } } }, "Response5197569": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197569" } } } }, "Response5197444": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197444" } } } }, "Response5197000": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197000" } } }, "description": "Resource" }, "Response5197130": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197130" } } }, "description": "Resource" }, "Response5196962": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196962" } } } }, "Response5197682": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197682" } } } }, "Response5196997": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196997" } } } }, "Response5196949": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196949" } } } }, "Response5197046": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197046" } } } }, "Response5197789": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197789" } } } }, "Response5196928": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196928" } } }, "description": "No Content" }, "Response5197796": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197796" } } } }, "Response5197300": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197300" } } }, "description": "Resource" }, "Response5196974": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196974" } } } }, "Response5197146": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197146" } } }, "description": "Resource" }, "Response5197200": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197200" } } } }, "Response5197002": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197002" } } } }, "Response5197608": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197608" } } } }, "Response5197490": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197490" } } } }, "Response5197122": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197122" } } }, "description": "Resource" }, "Response5197265": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197265" } } } }, "Response5197482": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197482" } } } }, "Response5197076": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197076" } } } }, "Response5197612": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197612" } } } }, "Response5197089": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197089" } } } }, "Response5197657": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197657" } } } }, "Response5197440": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197440" } } } }, "Response5197644": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197644" } } } }, "Response5197639": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197639" } } }, "description": "Resource" }, "Response5196982": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196982" } } } }, "Response5196953": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196953" } } } }, "Response5197480": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197480" } } } }, "Response5197230": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197230" } } } }, "Response5197439": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197439" } } }, "description": "Resource" }, "Response5196930": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196930" } } } }, "Response5197310": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197310" } } } }, "Response5197221": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197221" } } } }, "Response5197581": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197581" } } } }, "Response5197396": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197396" } } } }, "Response5197019": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197019" } } } }, "Response5197628": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197628" } } } }, "Response5197263": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197263" } } }, "description": "Resource" }, "Response5197554": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197554" } } } }, "Response5197667": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197667" } } }, "description": "Resource" }, "Response5197092": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197092" } } } }, "Response5197051": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197051" } } } }, "Response5197831": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197831" } } }, "description": "Resource" }, "Response5197579": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197579" } } }, "description": "Resource" }, "Response5197596": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197596" } } } }, "Response5197322": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197322" } } } }, "Response5197486": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197486" } } } }, "Response5196986": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196986" } } } }, "Response5197712": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197712" } } } }, "Response5197095": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197095" } } } }, "Response5197851": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197851" } } }, "description": "Resource" }, "Response5197592": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197592" } } } }, "Response5197386": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197386" } } }, "description": "Resource" }, "Response5196931": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196931" } } } }, "Response5197556": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197556" } } } }, "Response5197166": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197166" } } }, "description": "Resource" }, "Response5197344": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197344" } } } }, "Response5197239": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197239" } } }, "description": "Resource" }, "Response5197093": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197093" } } } }, "Response5197637": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197637" } } } }, "Response5197339": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197339" } } } }, "Response5197154": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197154" } } }, "description": "Resource" }, "Response5197664": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197664" } } } }, "Response5197424": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197424" } } } }, "Response5197374": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197374" } } }, "description": "Resource" }, "Response5197390": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197390" } } }, "description": "Resource" }, "Response5197387": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197387" } } } }, "Response5197017": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197017" } } } }, "Response5197157": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197157" } } } }, "Response5197459": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197459" } } }, "description": "Resource" }, "Response5197419": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197419" } } }, "description": "No Content" }, "Response5197403": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197403" } } } }, "Response5197540": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197540" } } } }, "Response5197849": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197849" } } } }, "Response5197245": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197245" } } } }, "Response5197258": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197258" } } } }, "Response5197045": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197045" } } }, "description": "No Content" }, "Response5197109": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197109" } } } }, "Response5197354": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197354" } } }, "description": "Resource" }, "Response5197442": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197442" } } } }, "Response5197665": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197665" } } } }, "Response5196926": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196926" } } } }, "Response5196966": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196966" } } } }, "Response5197275": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197275" } } } }, "Response5197530": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197530" } } } }, "Response5197164": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197164" } } } }, "Response5197214": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197214" } } }, "description": "Resource" }, "Response5197330": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197330" } } }, "description": "Resource" }, "Response5197201": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197201" } } } }, "Response5197194": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197194" } } }, "description": "Resource" }, "Response5197365": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197365" } } } }, "Response5197804": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197804" } } } }, "Response5197837": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197837" } } } }, "Response5197630": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197630" } } } }, "Response5197087": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197087" } } } }, "Response5197342": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197342" } } }, "description": "Resource" }, "Response5197780": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197780" } } } }, "Response5197672": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197672" } } } }, "Response5197620": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197620" } } } }, "Response5197250": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197250" } } } }, "Response5197436": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197436" } } } }, "Response5197096": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197096" } } } }, "Response5197278": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197278" } } } }, "Response5197690": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197690" } } } }, "Response5197547": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197547" } } }, "description": "Resource" }, "Response5197685": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197685" } } } }, "Response5197410": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197410" } } } }, "Response5197434": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197434" } } } }, "Response5197279": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197279" } } } }, "Response5197619": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197619" } } }, "description": "Resource" }, "Response5197767": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197767" } } }, "description": "Resource" }, "Response5197604": { "description": "Schema mismatch", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197604" } } } }, "Response5197134": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197134" } } }, "description": "Resource" }, "Response5196946": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196946" } } } }, "Response5197409": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197409" } } } }, "Response5196999": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196999" } } } }, "Response5197430": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197430" } } } }, "Response5197721": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197721" } } } }, "Response5197541": { "description": "Resource does not exist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197541" } } } }, "Response5197447": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197447" } } }, "description": "Resource" }, "Response5197487": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5197487" } } }, "description": "Resource" }, "Response5196943": { "description": "Unprocessable", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Response5196943" } } } } }, "requestBodies": { "Body5196865": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196865" } } } }, "Body5196900": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196900" } } } }, "Body5196866": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196866" } } } }, "Body5196848": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196848" } } } }, "Body5196856": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196856" } } } }, "Body5196829": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196829" } } } }, "Body5196891": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196891" } } } }, "Body5196859": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196859" } } } }, "Body5196903": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196903" } } } }, "Body5196841": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196841" } } } }, "Body5196920": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196920" } } } }, "Body5196893": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196893" } } } }, "Body5196881": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196881" } } } }, "Body5196875": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196875" } } } }, "Body5196834": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196834" } } } }, "Body5196905": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196905" } } } }, "Body5196838": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196838" } } } }, "Body5196847": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196847" } } } }, "Body5196879": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196879" } } } }, "Body5196870": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196870" } } } }, "Body5196857": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196857" } } } }, "Body5196897": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196897" } } } }, "Body5196869": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196869" } } } }, "Body5196855": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196855" } } } }, "Body5196849": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196849" } } } }, "Body5196883": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196883" } } } }, "Body5196889": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196889" } } } }, "Body5196853": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196853" } } } }, "Body5196840": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196840" } } } }, "Body5196873": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196873" } } } }, "Body5196912": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196912" } } } }, "Body5196852": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196852" } } } }, "Body5196894": { "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/Body5196894" } } } }, "Body5196908": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196908" } } } }, "Body5196877": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196877" } } } }, "Body5196831": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196831" } } } }, "Body5196921": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196921" } } } }, "Body5196923": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196923" } } } }, "Body5196886": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196886" } } } }, "Body5196876": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196876" } } } }, "Body5196844": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196844" } } } }, "Body5196864": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196864" } } } }, "Body5196850": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196850" } } } }, "Body5196842": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196842" } } } }, "Body5196854": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196854" } } } }, "Body5196872": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196872" } } } }, "": { "content": { "application/json": { "schema": null } } }, "Body5196904": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196904" } } } }, "Body5196922": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196922" } } } }, "Body5196878": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196878" } } } }, "Body5196907": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196907" } } } }, "Body5196851": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196851" } } } }, "Body5196901": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196901" } } } }, "Body5196892": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196892" } } } }, "Body5196837": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196837" } } } }, "Body5196913": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196913" } } } }, "Body5196887": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196887" } } } }, "Body5196845": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196845" } } } }, "Body5196885": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196885" } } } }, "Body5196899": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196899" } } } }, "Body5196863": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196863" } } } }, "Body5196828": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196828" } } } }, "Body5196902": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196902" } } } }, "Body5196858": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196858" } } } }, "Body5196914": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196914" } } } }, "Body5196917": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196917" } } } }, "Body5196919": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196919" } } } }, "Body5196862": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196862" } } } }, "Body5196861": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196861" } } } }, "Body5196843": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196843" } } } }, "Body5196911": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196911" } } } }, "Body5196835": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196835" } } } }, "Body5196896": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196896" } } } }, "Body5196860": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196860" } } } }, "Body5196909": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196909" } } } }, "Body5196918": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196918" } } } }, "Body5196867": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196867" } } } }, "Body5196915": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196915" } } } }, "Body5196898": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196898" } } } }, "Body5196827": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Body5196827" } } } } } }, "security": [ { "BearerAuth": [] } ] }