{"openapi":"3.0.0","info":{"title":"Businessmap API v2","contact":{"name":"Support","url":"https:\/\/businessmap.io\/customer-support\/","email":"support@businessmap.io"},"license":{"name":"Apache 2.0","url":"https:\/\/www.apache.org\/licenses\/LICENSE-2.0"},"version":"1.0.0","description":"[Contact Support](https:\/\/businessmap.io\/customer-support) \r\n[Apache 2.0](https:\/\/www.apache.org\/licenses\/LICENSE-2.0)\r\n\r\n## Table of Contents\r\n\r\n- \ud83d\udd11 **[Authentication](#\/#authentication)**\r\n- \u2699\ufe0f **[API Request Limits](#\/#api-request-limits)**\r\n - \u23f3 [Types of Limits](#\/#types-of-limits)\r\n - \u26a1 [Default Limits](#\/#default-limits)\r\n - \ud83d\udcdd [Response Headers Related to Limits](#\/#response-headers-related-to-limits)\r\n - \ud83d\udeab [Exceeding the Limits](#\/#exceeding-the-limits)\r\n- \ud83d\udea8 **[Errors](#\/#errors)**\r\n- \ud83c\udff7\ufe0f **[Response Headers](#\/#response-headers)**\r\n- \ud83d\udd0d **[Filtering and Expanding Resources](#\/#filtering-and-expanding-resources)**\r\n - \ud83d\udd0e [Filtering](#\/#filtering)\r\n - \u2197\ufe0f [Expanding](#\/#expanding)\r\n- \ud83d\udce6 **[Pagination](#\/#pagination)**\r\n - \ud83d\udd22 [Pagination Query Parameters](#\/#pagination-query-parameters)\r\n- \ud83d\ude80 **[Optimisation](#\/#optimisation)**\r\n\r\n## Authentication \r\nAuthentication is performed using an alphanumeric API key that must be included in the request header. \r\nYou can find your existing API key or generate a new one by going to your **Businessmap account** and in the top-right corner clicking **My Account** -> **API**:\r\n\r\n
\r\n \"API\r\n<\/div>\r\n\r\nOnce you have opened the API section, you can click **Show API key** to view it, or **Copy to clipboard** to easily copy the key for use in your requests.\r\n\r\n\r\n> ### Important\r\n>\r\n> Please note that if you generate a new API key, your current one will be **permanently** deleted, which may affect any existing integrations that rely on it. \r\n> This operation is **permanent** and **cannot** be undone.\r\n\r\n## API Request Limits\r\n\r\nThese API limits determine how many API calls you can make within a given time period. There are two types of request limits: **hourly** and **minutely**. \r\nFor more information on the API limits for your account, you can call the **[API Limits](#\/operations\/getApiLimits#Request)** endpoint.\r\n\r\n### Types of Limits\r\n\r\n- **Hourly** Limit - The number of requests allowed within one hour.\r\n- **Minutely** Limit - The number of requests allowed within one minute.\r\n\r\n### Default Limits\r\n\r\n- The default **hourly** limit is set to `600` requests.\r\n- The default **minutely** limit is set to `30` requests.\r\n\r\n### Response Headers Related to Limits\r\n\r\nThe following **response headers** also include information about the API limits:\r\n\r\n- `X-RateLimit-PerHour-Limit` - Indicates the maximum number of requests allowed per hour.\r\n\r\n- `X-RateLimit-PerHour-Remaining` - Shows the number of requests remaining in the current hour.\r\n\r\n- `X-RateLimit-PerMinute-Limit` - Denotes the maximum number of requests allowed per minute.\r\n\r\n- `X-RateLimit-PerMinute-Remaining` - Indicates the number of requests remaining in the current minute.\r\n\r\n### Exceeding the Limits\r\nIf you exceed these limits, you may receive an error response indicating that the rate limit has been reached.\r\n\r\n\r\n```json\r\n{\r\n \"error\": {\r\n \"code\": \"RL02\",\r\n \"message\": \"You have exceeded the minutely request limit. The limit is 10 and you've made 12 requests prior to this one. You can try again after 58 seconds.\",\r\n \"reference\": \"GE-RL02\",\r\n \"details\": {\r\n \"limit\": 10,\r\n \"requests\": 12,\r\n \"retry_after\": 58\r\n }\r\n }\r\n}\r\n```\r\n\r\n\r\n#### Parameter breakdown:\r\n- `limit` - Denotes the allowed number of requests for the selected endpoint within the specified time window. In this case, the limit is **10 requests** per minute.\r\n\r\n- `requests` - Indicates how many requests have been made so far. For this example, **12 requests** have been made prior to the current request attempt.\r\n\r\n- `retry_after` - Specifies the number of seconds remaining until you can make another successful request. In this example, you must wait **58 seconds** before trying again.\r\n\r\n## Errors\r\n\r\nWhen interacting with the API, various errors may occur. These errors will be returned as part of the response body in an error object. \r\nThe possible errors that can be returned are shown in the table below:\r\n\r\nCode | Type | Description\r\n---------|----------|---------\r\n 400 | Bad Request | The request failed due to a client error.\r\n 401 | Unauthorized | You are not authorized to access the API.\r\n 403 | Forbidden | You do not have the permissions required to access this resource or to perform this action.\r\n 404 | Not Found | This resource does not exist at the moment.\r\n 409 | Conflict | The request could not be completed due to a conflict with the current state of the resource.\r\n 429 | Too Many Requests | This request will not be processed because you have sent too many requests recently.\r\n 500 | Internal Server Error | The request failed due to an internal server error.\r\n 503 | Service Unavailable | The service is temporarily unavailable.\r\n\r\n\r\n```json\r\n{\r\n \"error\": {\r\n \"code\": \"B001\",\r\n \"message\": \"A board with id 1'204'9702 does not exist.\",\r\n \"reference\": \"GE-B001\",\r\n \"details\": {\r\n \"board_id\": 1'204'9702\r\n }\r\n }\r\n}\r\n```\r\n\r\n#### Parameter breakdown:\r\n- `code` - A unique 4-character code associated with the error.\r\n\r\n- `message` - A description of the error.\r\n\r\n- `reference` - A reference that you can use if you need to [contact customer support](https:\/\/businessmap.io\/customer-support) about the error.\r\n\r\n- `details` - Details specific to the error. Such as the values that caused it.\r\n\r\n\r\n> ### Info\r\n>\r\n> Please note that sometimes the API response may lack the `details` object in generic error scenarios, e.g. accessing a board with an invalid board ID.\r\n\r\n## Response Headers\r\n\r\nThe following **response headers** are included in the API response for **every** successful request:\r\n\r\n- `X-RateLimit-PerHour-Limit` - Indicates the maximum number of requests allowed per hour.\r\n\r\n- `X-RateLimit-PerHour-Remaining` - Shows the number of requests remaining in the current hour.\r\n\r\n- `X-RateLimit-PerMinute-Limit` - Denotes the maximum number of requests allowed per minute.\r\n\r\n- `X-RateLimit-PerMinute-Remaining` - Indicates the number of requests remaining in the current minute.\r\n\r\n- `X-Kanbanize-Version` - Shows the current version of Businessmap.\r\n\r\n## Filtering and Expanding Resources\r\n\r\nBy using both expand and filters, you can refine your queries and retrieve more detailed and relevant data. \r\nFilters allow you to narrow down results based on specific criteria, ensuring that only the most relevant information is returned. \r\nExpand is used to get more details about a specific object that is returned for an endpoint without having to call a separate endpoint.\r\n\r\n\r\n> ### Info\r\n>\r\n> Please note that filtering and expanding are **not** available for all endpoints. If they are available, they will be specified as **query parameters** for the selected endpoint.\r\n>\r\n>Invalid or unsupported filters provided in `GET` requests are **ignored**. The request will still be processed and no error will be returned.\r\n### Filtering\r\n\r\nFilters are applied to refine the data returned by the API, allowing you to focus on specific attributes or values that match your requirements. \r\nCommon filters include:\r\n\r\n- `from` - Filters results that occurred after a specific date and time in `YYYY-MM-DD HH:mm:ss` format.\r\n- `to` - Filters results that occurred before a specific date and time in `YYYY-MM-DD HH:mm:ss` format.\r\n- `from_date` - Filters results that occurred after a specific date in `YYYY-MM-DD` format.\r\n- `to_date` - Filters results that occurred before a specific date in `YYYY-MM-DD` format.\r\n\r\n### Expanding\r\n\r\nWhen expanding is enabled, you can request additional details about specific properties in the response. \r\nTo do so, simply list the properties available for the selected endpoint you wish to expand as query parameters, e.g. `expand=custom_fields`.\r\n\r\n\r\n```json\r\n{\r\n \"data\": {\r\n \"pagination\": {\r\n \"all_pages\": 1,\r\n \"current_page\": 1,\r\n \"results_per_page\": 200\r\n },\r\n \"data\": [\r\n {\r\n \"card_id\": 539522,\r\n \"custom_id\": null,\r\n \"board_id\": 1075,\r\n \"workflow_id\": 1695,\r\n \"title\": \"childInitiative1\",\r\n \"owner_user_id\": null,\r\n \"type_id\": null,\r\n \"color\": \"34a97b\",\r\n \"section\": 2,\r\n \"column_id\": 15876,\r\n \"lane_id\": 9838,\r\n \"position\": 2,\r\n \"custom_fields\": [\r\n {\r\n \"field_id\": 638,\r\n \"value\": 50,\r\n \"display_value\": \"50\"\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n}\r\n```\r\n## Pagination\r\n\r\nPagination is used to split large sets of results into smaller, more manageable pages. \r\nIt allows users to retrieve a subset of results at a time, improving performance and providing a more user-friendly experience when dealing with extensive data sets. \r\nIf pagination is available results are **always** returned in pages.\r\n\r\n\r\n> ### Info\r\n>\r\n> Please note that pagination is **not** available for all endpoints. If it is available, the specific endpoint will list the available query parameters. \r\n> Additionally in the response body, a distinct `pagination` object will appear at the top, containing the relevant pagination details.\r\n\r\n### Pagination Query Parameters\r\n\r\nYou can control the pagination behavior using the following query parameters:\r\n\r\n- `page` - This parameter specifies which page of results to return. By default, the API returns the **first** page.\r\n\r\n- `per_page` - This controls the number of results per page. The **default** value is `100`, and the **maximum** allowed is `200`.\r\n\r\nBy using these parameters, you can navigate through large datasets more effectively.\r\n\r\n\r\n```json\r\n{\r\n \"pagination\": {\r\n \"all_pages\": 199387,\r\n \"current_page\": 1,\r\n \"results_per_page\": 1\r\n },\r\n \"data\": [\r\n {\r\n \"user_id\": 2,\r\n \"resource\": \"api\/v*\/cards\/*\",\r\n \"method\": \"get\",\r\n \"status_code\": 404,\r\n \"support_reference\": null,\r\n \"time\": \"2025-01-01T00:00:00+00:00\"\r\n }\r\n ]\r\n}\r\n```\r\n## Optimisation\r\n\r\nWhen utilising the API, it's important to design your requests efficiently to reduce latency, lower network load, and improve overall performance.\r\n\r\nMany resources in the Businessmap API include a main GET endpoint (e.g. [GET \/cards](#\/operations\/getCards), [GET \/boards](#\/operations\/getBoards), etc.) that supports filtering, expanding, and field selection parameters.\r\nThese features are specifically designed to help you retrieve all the information you need in a single, optimised request, instead of sending multiple individual calls such as [GET \/cards\/{card_id}](#\/operations\/getCard ) for each item.\r\n\r\nEmploying the collection endpoints with supported query parameters (e.g. `expand`, `fields` and various other filters **specific** to each endpoint) enables more efficient data retrieval, reduces request overhead, and enhances API performance.\r\n\r\nFor example, instead of making several separate calls to fetch detailed data for each card:\r\n\r\n```\r\nGET \/cards\/101\r\nGET \/cards\/102\r\nGET \/cards\/103\r\n```\r\nYou can use the main endpoint once and expand the required properties:\r\n\r\n```\r\nGET \/cards?card_ids=101,102,103\r\n```\r\nThis not only returns all relevant data in one response but also ensures your integration runs faster and scales better.\r\n\r\nIn addition, when creating or updating multiple resources, you can use the corresponding bulk endpoints, such as [POST \/cards\/createMany](#\/operations\/createManyCards), to perform batch operations in a single request.\r\nUsing these bulk endpoints helps optimise both performance and reliability across your integration."},"servers":[{"url":"https:\/\/demo.kanbanize.com\/api\/v2"}],"tags":[{"name":"API Limits"},{"name":"API Request History"},{"name":"Arrival Rule History"},{"name":"Archived Card Versions"},{"name":"BAI Prompt History"},{"name":"Block Reason Boards"},{"name":"Block Reason Cards"},{"name":"Block Reason History"},{"name":"Block Reasons"},{"name":"Board Access Requests"},{"name":"Board Arrival Rules"},{"name":"Board BAI Prompts"},{"name":"Board Docs"},{"name":"Board Assignees"},{"name":"Board Block Reasons"},{"name":"Board Effective Cycle Time Columns"},{"name":"Board Card and Initiative Default Views Settings"},{"name":"Board Card and Initiative Effective Views Settings"},{"name":"Board Card and Initiative Views My Settings"},{"name":"Board Card Templates"},{"name":"Board Card Types"},{"name":"Board Column Checklist Items"},{"name":"Board Column Checklist Item Allowed Users"},{"name":"Board Custom Field Allowed Values"},{"name":"Board Custom Field Default Contributors"},{"name":"Board Custom Fields"},{"name":"Board Default Settings"},{"name":"Board Departure Rules"},{"name":"Board Discard Reasons"},{"name":"Board History"},{"name":"Board Logged Time Categories"},{"name":"Board Milestones"},{"name":"Board Points Of Contact"},{"name":"Board Settings"},{"name":"Board Stickers"},{"name":"Board Structure"},{"name":"Board Structure Revisions"},{"name":"Board Tags"},{"name":"Board Teams"},{"name":"Board Visible Standard Fields"},{"name":"Boards"},{"name":"Business Rule Execution History"},{"name":"Business Rules Active Rules Limit"},{"name":"Calculated Outcome Value Rules Active Rules Limit"},{"name":"Calculated Outcome Value Rules Execution History"},{"name":"Card Attachments"},{"name":"Card Block Reason"},{"name":"Card Column Checklist Items"},{"name":"Card Comment Attachments"},{"name":"Card Comments"},{"name":"Card Cover Image"},{"name":"Card Co Owners"},{"name":"Card Custom Field Contributors"},{"name":"Card Custom Field Files"},{"name":"Card Custom Field Selected Cards"},{"name":"Card Custom Field Selected Values"},{"name":"Card Custom Field Votes"},{"name":"Card Custom Fields"},{"name":"Card Linked Cards"},{"name":"Card Milestones"},{"name":"Card Parent Cards"},{"name":"Card Predecessor Cards"},{"name":"Card Relative Cards"},{"name":"Card Revisions"},{"name":"Card Stickers"},{"name":"Card Subtask Attachments"},{"name":"Card Subtasks"},{"name":"Card Successor Cards"},{"name":"Card Tags"},{"name":"Card Outcomes"},{"name":"Card Templates"},{"name":"Card Template Card Attachments"},{"name":"Card Template Card Child Cards"},{"name":"Card Template Card Co Owners"},{"name":"Card Template Card Custom Fields"},{"name":"Card Template Card Custom Field Contributors"},{"name":"Card Template Card Custom Field Files"},{"name":"Card Template Card Custom Field Selected Values"},{"name":"Card Template Card Milestones"},{"name":"Card Template Card Parent Cards"},{"name":"Card Template Card Predecessor Cards"},{"name":"Card Template Card Relative Cards"},{"name":"Card Template Card Stickers"},{"name":"Card Template Card Subtask Attachments"},{"name":"Card Template Card Subtasks"},{"name":"Card Template Card Successor Cards"},{"name":"Card Template Card Tags"},{"name":"Card Template Card Watchers"},{"name":"Card Template Cards"},{"name":"Card Templates History"},{"name":"Card Types"},{"name":"Card Type Boards"},{"name":"Card Type Cards"},{"name":"Card Type History"},{"name":"Card Watched"},{"name":"Card Watchers"},{"name":"Cards"},{"name":"Cards Comments"},{"name":"Cards Create Many"},{"name":"Cards Delete Many"},{"name":"Cards Update Many"},{"name":"Cell Limits"},{"name":"Check DKIM Record"},{"name":"Check SPF Record"},{"name":"Child Cards"},{"name":"Columns"},{"name":"Company Settings"},{"name":"Custom Field Allowed Values"},{"name":"Custom Field Boards"},{"name":"Custom Field Cards"},{"name":"Custom Field History"},{"name":"Custom Fields"},{"name":"Data Fields"},{"name":"Docs"},{"name":"Dashboard Page Teams"},{"name":"Dashboard Page Users"},{"name":"Dashboard Page Workspaces"},{"name":"Dashboard Pages"},{"name":"Departure Rule History"},{"name":"Discard Reason Boards"},{"name":"Discard Reason Cards"},{"name":"Discard Reason History"},{"name":"Discard Reasons"},{"name":"Dkim Domains"},{"name":"Email Integration Errors"},{"name":"Email Integration History"},{"name":"Exports"},{"name":"Global User Privileges"},{"name":"Internal Announcement Views"},{"name":"Internal Announcement History"},{"name":"Internal Announcement For Roles"},{"name":"Internal Announcement For Teams"},{"name":"Internal Announcements"},{"name":"Integration Settings"},{"name":"Lane Default Settings"},{"name":"Lane Section Limits"},{"name":"Lanes"},{"name":"Logged Time"},{"name":"Logged Time Board Categories"},{"name":"Logged Time Categories"},{"name":"Logged Time Category History"},{"name":"Logged Time History"},{"name":"MCP Tools"},{"name":"Managed Workspaces"},{"name":"Merged Areas"},{"name":"Me"},{"name":"Milestone Boards"},{"name":"Milestone Cards"},{"name":"Milestone History"},{"name":"Milestones"},{"name":"My API Key Generate"},{"name":"My App Settings"},{"name":"My Announcements"},{"name":"My Board Access Requests"},{"name":"My Board Settings"},{"name":"My Boards Settings"},{"name":"My Dashboard Page Settings"},{"name":"My Dashboard Page Workspaces"},{"name":"My Dashboard Pages"},{"name":"My Favorite Boards"},{"name":"My Favorite Docs"},{"name":"Old API Limits"},{"name":"Old API Request History"},{"name":"Outcome Tags"},{"name":"Outcomes"},{"name":"Outcome Checkpoints"},{"name":"Outcome Values"},{"name":"Outcome Tags by Outcome"},{"name":"Personal Docs"},{"name":"Related Workflows"},{"name":"Role History"},{"name":"Role Permissions"},{"name":"Roles"},{"name":"Search for Cards"},{"name":"Sticker Boards"},{"name":"Sticker Cards"},{"name":"Sticker History"},{"name":"Stickers"},{"name":"Tags"},{"name":"Tag Boards"},{"name":"Tag Cards"},{"name":"Tag History"},{"name":"Team Boards"},{"name":"Team History"},{"name":"Team Managers"},{"name":"Team Users"},{"name":"Teams"},{"name":"User Activity"},{"name":"User Attributes"},{"name":"User Boards"},{"name":"User History"},{"name":"User Involved Business Rules"},{"name":"User Teams"},{"name":"Users"},{"name":"Users' Attributes"},{"name":"Webhook History"},{"name":"Webhooks"},{"name":"Workspace Managers"},{"name":"Workspaces"},{"name":"Workspaces History"},{"name":"Workflow Cycle Time Columns"},{"name":"Workflows"}],"paths":{"\/apiLimits":{"get":{"tags":["API Limits"],"summary":"Get the hourly and minutely limits for API requests","description":"Retrieves a list of API limits that determine how many API calls you can make within a given time period. There are two types of request limits: **hourly** and **minutely**. \r\n\r\n### Types of Limits\r\n\r\n- **Hourly** Limit - The number of requests allowed within one hour.\r\n- **Minutely** Limit - The number of requests allowed within one minute.\r\n\r\n### Default Limits\r\n\r\n- The default **hourly** limit is set to `600` requests.\r\n- The default **minutely** limit is set to `30` requests.\r\n\r\n### Response Headers Related to Limits\r\n\r\nThe following **response headers** also include information about the API limits:\r\n\r\n- `X-RateLimit-PerHour-Limit` - Indicates the maximum number of requests allowed per hour.\r\n\r\n- `X-RateLimit-PerHour-Remaining` - Shows the number of requests remaining in the current hour.\r\n\r\n- `X-RateLimit-PerMinute-Limit` - Denotes the maximum number of requests allowed per minute.\r\n\r\n- `X-RateLimit-PerMinute-Remaining` - Indicates the number of requests remaining in the current minute.","operationId":"getApiLimits","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ApiLimit"}}}},"example":{"$ref":"#\/components\/responseExamples\/ApiLimitExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/apiRequestHistory":{"get":{"tags":["API Request History"],"summary":"Get a list of past API requests","description":"Retrieves a list of previously made API requests along with their relevant details.\nThis endpoint allows you to review the history of API usage and can be tailored using various filtering options.\n","operationId":"getApiRequestHistory","parameters":[{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the API request history to include only requests made by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"methods","in":"query","description":"A list of HTTP methods used to filter the API request history to include only requests executed with those methods.","required":false,"schema":{"items":{"type":"string","enum":["get","put","post","patch","delete"]}},"example":"get,put","explode":false},{"name":"status_codes","in":"query","description":"A list of HTTP status codes used to filter the API request history to include only responses with those status codes.","required":false,"schema":{"items":{"format":"int32","type":"integer","enum":[200,"204",400,401,403,404,405,409,429,500,503]}},"example":"200,400","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"description":"A list of past API requests.","type":"array","items":{"$ref":"#\/components\/schemas\/ApiRequestHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/ApiRequestHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/apiRequestHistory\/aggregated":{"get":{"tags":["API Request History"],"summary":"Get a list of API requests aggregated by user","description":"Retrieves a list of previously made API requests, aggregated by user, along with their relevant details.\nThis endpoint allows you to review the history of API usage and can be tailored using various filtering options.\n","operationId":"getApiRequestHistoryAggregated","parameters":[{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the API request history to include only requests made by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"aggregation_period","in":"query","description":"Specifies the aggregation period for grouping API request logs. Defaults to `day` if not specified.","required":false,"schema":{"type":"string","default":"day","enum":["day","hour"]}},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An aggregated response of the API's history, grouped by User ID.","type":"array","items":{"$ref":"#\/components\/schemas\/ApiRequestHistoryAggregated"}}}},"example":{"$ref":"#\/components\/responseExamples\/ApiRequestHistoryAggregatedExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/arrivalRules\/history":{"get":{"tags":["Arrival Rule History"],"summary":"Get a list of arrival rule creation, deletion, and update, rule enabled, rule disabled events.","description":"Returns a log of all actions related to the arrival rules. This includes records of arrival rules that have been **created**, **updated**, **deleted**, **rule enabled** or **rule disabled**.","operationId":"getArrivalRulesHistory","parameters":[{"name":"rule_ids","in":"query","description":"A list of arrival rule IDs by which to filter the arrival rule history.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the arrival rule history to include only requests made by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types by which to filter the arrival rule history.","required":false,"schema":{"items":{"type":"string","enum":["rule_created","rule_updated","rule_deleted","rule_disabled","rule_enabled"]}},"example":"rule_created,rule_updated","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/ArrivalRuleHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/ArrivalRuleHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/archivedCardVersions":{"get":{"tags":["Archived Card Versions"],"summary":"Get a list of archived card versions","description":"Get a list of all created archived card versions. Archived card versions provide a way to group multiple archived cards together under a single version, which can either be **manually** or **automatically** created.\r\n\r\n - **Manually** - Archived card versions can be manually created via **[POST request](#\/operations\/createArchiveCardVersion#Request)**. \r\n\r\n - **Automatically** - Archived card versions are automatically generated when cards are archived based on board settings. Cards may be automatically archived every `1`, `7`, `14`, or `30` days and a **single** archived card version is created for each automatic archiving operation.","operationId":"getArchivedCardVersions","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of archived card versions.","type":"array","items":{"$ref":"#\/components\/schemas\/ArchiveCardVersion"}}}},"example":{"$ref":"#\/components\/responseExamples\/ArchiveCardVersionsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Archived Card Versions"],"summary":"Create an archived card version","description":"Create a new archived card version. The version name must be **unique**, as duplicate names are **not** permitted.\nTo associate a card with an archived card version, the `version_id` **must** be specified when the card is being archived via **[PATCH request](#\/operations\/updateCard#Request)**.\n\nIf a card is **already** archived, it has to be **unarchived** before it can be associated with a new archived card version.\n","operationId":"createArchiveCardVersion","requestBody":{"content":{"application\/json":{"schema":{"description":"Archived card version data.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the new version.","type":"string","minLength":1,"maxLength":250}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ArchiveCardVersion"}}},"example":{"$ref":"#\/components\/responseExamples\/ArchiveCardVersionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/archivedCardVersions\/{version_id}":{"get":{"tags":["Archived Card Versions"],"summary":"Get the details of a single archived card version","description":"Get the details of a single archived card version.","operationId":"getArchiveCardVersion","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ArchiveCardVersion"}}},"example":{"$ref":"#\/components\/responseExamples\/ArchiveCardVersionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Archived Card Versions"],"summary":"Update an archived card version","description":"Update an archived card version. Only the **name** of the archived card version can be updated.","operationId":"updateArchiveCardVersion","requestBody":{"content":{"application\/json":{"schema":{"description":"Archived card version data.","type":"object","properties":{"name":{"description":"The name of the version.","type":"string","minLength":1,"maxLength":250}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ArchiveCardVersion"}}},"example":{"$ref":"#\/components\/responseExamples\/ArchiveCardVersionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Archived Card Versions"],"summary":"Delete an archived card version","description":"Delete an archived card version.\r\n\r\n\r\n> ### Info\r\n>\r\n> This does **not** delete the archived card itself, rather the version under which the archived card is grouped.\r\n","operationId":"deleteArchiveCardVersion","responses":{"204":{"description":"The archived card version has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/versionIdInPath"}]},"\/baiPrompts\/history":{"get":{"tags":["BAI Prompt History"],"summary":"Get a list of BAI prompt creation, deletion, and update events.","description":"Returns a log of all actions related to the prompts within Businessmap AI (BAI). This includes records of prompts that have been **created**, **updated**, or **deleted**.\n\nThere are **three** types of prompts:\r\n\r\n- **Comments and Emails** - Prompts that allow the generation of text content for a comment or email \r\n- **Subtasks** - Prompts that generate text for comments or email content associated with an existing card.\r\n- **Summaries** - Prompts that generate a concise summary of a card's contents, such as its title, description, and other relevant details.","operationId":"getBaiPromptsHistory","parameters":[{"name":"prompt_ids","in":"query","description":"A list of BAI prompt IDs by which to filter the BAI prompt history.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the BAI prompts history to include only requests made by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types by which to filter the BAI prompt history.","required":false,"schema":{"items":{"type":"string","enum":["prompt_created","prompt_updated","prompt_deleted"]}},"example":"prompt_created,prompt_updated","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/BaiPromptHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/BaiPromptHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/blockReasons\/{reason_id}\/boards":{"get":{"tags":["Block Reason Boards"],"summary":"Get a list of boards where the block reason is available","description":"Get a list of board IDs where the specified block reason is applicable. A list of all block reasons can be retrieved by calling the [blockReasons endpoint](#\/operations\/getBlockReasons#Request).\n\nThe **Waiting on us** and **Waiting on others** block reasons exist by default for **every** account. As such, they are available for **all** boards (unless specified otherwise) along with the **Generic Blocker**.\r\n\r\n\r\n> ### Info\r\n>\r\n> The **Generic Blocker** is **not** included in this list. To determine if a board allows its use, you can call the [currentStructure endpoint](#\/paths\/boards-board_id--currentStructure\/get#Request), which returns the `allow_generic_blocker` parameter.\r\n","operationId":"getBlockReasonBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Contains the IDs of boards where the block reason is applicable.","type":"array","items":{"title":"Block Reason Board","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of a board where the block reason is applicable."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/blockReasonIdInPath"}]},"\/blockReasons\/{reason_id}\/batchBoardOperations":{"post":{"tags":["Block Reason Boards"],"summary":"Change the availability of a block reason on one or more boards","description":"Change the availability of a block reason on one or more boards.","operationId":"updateBlockReasonBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason boards data.","type":"object","properties":{"board_ids_to_add":{"description":"A list of board IDs where the block reason should be made available.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids_to_remove":{"description":"A list of board IDs where the block reason should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/BlockReasonBatchBoardOperationsExample"}}}},"responses":{"204":{"description":"The block reason's availability has been updated on the specified board(s)."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/blockReasonIdInPath"}]},"\/blockReasons\/{reason_id}\/cards":{"get":{"tags":["Block Reason Cards"],"summary":"Get a list of cards where the block reason is currently applied","description":"Get a list of card IDs where the specified block reason is **currently** applied. A list of all block reasons can be retrieved by calling the [blockReasons endpoint](#\/operations\/getBlockReasons#Request).\r\n\r\nIf a card is unblocked and then blocked again with a **different** block reason, it will **no longer** be associated with the initial block reason.\r\n\r\n> ### Info\r\n>\r\n> The **Generic Blocker** is not included in this list. To determine if a card is currently blocked using the **Generic Blocker**, you can call the [cards\/{card_id} endpoint](#\/operations\/getCard#Request).\r\n> \r\n>If a card uses the **Generic Blocker** the `block_reason` object in the response body will have its `reason_id` parameter set to `null`.","operationId":"getBlockReasonCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Contains the IDs of cards where the block reason is currently applied.","type":"array","items":{"title":"Block Reason Card","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of a card where the block reason is currently applied."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/TokenCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/blockReasonIdInPath"}]},"\/blockReasons\/history":{"get":{"tags":["Block Reason History"],"summary":"Get a list of block reasons creation, deletion and update events","description":"Retrieves a list of events related to block reasons.\nThis endpoint allows you to review the history of block reasons and can be tailored using various filtering options.\n","operationId":"getBlockReasonsHistory","parameters":[{"name":"reason_ids","in":"query","description":"A list of reason IDs used to filter the block reasons history to include only block reasons with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the block reasons history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types used to filter the block reasons history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["reason_created","reason_updated","reason_disabled","reason_enabled","reason_deleted","reason_added_to_board","reason_removed_from_board"]}},"example":"reason_created,reason_updated","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"description":"A list of block reasons creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/BlockReasonHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonsHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/blockReasons":{"get":{"tags":["Block Reasons"],"summary":"Get a list of block reasons","description":"Get a list of all created block reasons. The **Waiting on us** and **Waiting on others** block reasons exist by default for **every** account.\n\nA **Generic Blocker** is also available by default, but it is **not** listed as a block reason in this endpoint. To determine if a board allows its use, you can call the [currentStructure endpoint](#\/paths\/boards-board_id--currentStructure\/get#Request), which returns the `allow_generic_blocker` parameter.","operationId":"getBlockReasons","parameters":[{"name":"reason_ids","in":"query","description":"A list of reason IDs used to filter the block reasons to include those with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"label","in":"query","description":"Filters block reasons by their exact label (i.e. the name of the block reason).","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the block reasons.\n\nA value of `0` represents **On-demand**, meaning the block reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the block reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the block reason is automatically added to all boards across all workspaces. Once a block reason's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"example":"0,1","explode":false},{"name":"is_enabled","in":"query","description":"Filters block reasons based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["reason_id","icon_type","icon_id","label","color","availability","is_enabled"]}},"example":"reason_id,availability","explode":false},{"name":"expand","in":"query","description":"A list of properties for which additional details should be included in the response.","schema":{"items":{"type":"string","enum":["board_ids","board_count","card_count","business_rules"]}},"example":"board_ids,board_count","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of block reasons.","type":"array","items":{"$ref":"#\/components\/schemas\/BlockReason"}}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Block Reasons"],"summary":"Create a block reason","description":"Create a new block reason. The block reason name must be **unique**, as duplicate names are **not** permitted.","operationId":"createBlockReason","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason data.","required":["label"],"type":"object","properties":{"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the block reason. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the block reason. If set to `0`, the block reason will not have an icon.","default":0},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The **unique** label (i.e. the name) assigned to the block reason."},"color":{"type":"string","description":"The color of the block reason in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the block reason.\n\nA value of `0` represents **On-demand**, meaning the block reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the block reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the block reason is automatically added to all boards across all workspaces. Once a block reason's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the block reason is enabled.","enum":[0,1],"default":1}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BlockReason"}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/blockReasons\/{reason_id}":{"get":{"tags":["Block Reasons"],"summary":"Get the details of a single block reason","description":"Get the details of a single block reason.\n\n\n> #### Info\n>\n> You can use the [GET \/blockReasons](#\/operations\/getBlockReasons) endpoint with the `reason_ids` query parameter to retrieve multiple block reasons in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getBlockReason","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BlockReason"}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Block Reasons"],"summary":"Update a block reason","description":"Update a block reason.","operationId":"updateBlockReason","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason data.","required":["label"],"type":"object","properties":{"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the block reason. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the block reason. If set to `0`, the block reason will not have an icon.","default":0},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The **unique** label (i.e. the name) assigned to the block reason."},"color":{"type":"string","description":"The color of the block reason in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the block reason.\n\nA value of `0` represents **On-demand**, meaning the block reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the block reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the block reason is automatically added to all boards across all workspaces. Once a block reason's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the block reason is enabled.","enum":[0,1],"default":1}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BlockReason"}}},"example":{"$ref":"#\/components\/responseExamples\/BlockReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Block Reasons"],"summary":"Delete a block reason","description":"Deletes a block reason. Unless the `replace_with_reason_id` parameter is provided, **all** cards that were previously blocked by the deleted block reason will be **reassigned** to the **Generic Blocker**.\r\n\r\nAdditionally, a `comment` parameter will be automatically added to the **Generic Blocker**, containing the name of the deleted block reason. To view this update, you can call the [cards\/{card_id} endpoint](#\/operations\/getCard#Request) and inspect the `block_reason` object in the response body.\r\n\r\n#### Example:\r\n\r\n- If a block reason named `\"This is a blocker\"` is deleted, the **Generic Blocker** will be applied to the affected cards, and a `comment` parameter will be included with the value `\"This is a blocker\"`.\r\n","operationId":"deleteBlockReason","parameters":[{"name":"replace_with_reason_id","in":"query","description":"The ID of the block reason that will replace the deleted block reason for **all** affected cards.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The block reason has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/blockReasonIdInPath"}]},"\/blockReasons\/deleteMany":{"post":{"tags":["Block reasons Delete Many"],"summary":"Delete many block reasons","description":"Schedule multiple block reasons for deletion in a single request. Block reasons are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyBlockReasons","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason IDs data.","type":"object","required":["reason_ids"],"properties":{"reason_ids":{"description":"A list of block reason IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"reason_ids":[1,2]}}}},"responses":{"204":{"description":"The block reasons have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/blockReasons\/disableMany":{"post":{"tags":["Block reason Disable Many"],"summary":"Disable many block reasons","description":"Schedule multiple block reasons for disabling in a single request. Block reasons are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyBlockReasons","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason IDs data.","type":"object","required":["reason_ids"],"properties":{"reason_ids":{"description":"A list of block reason IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"reason_ids":[1,2]}}}},"responses":{"204":{"description":"The block reasons have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/blockReasons\/enableMany":{"post":{"tags":["Block reason Enable Many"],"summary":"Enable many block reasons","description":"Schedule multiple block reasons for enabling in a single request. Block reasons are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyBlockReasons","requestBody":{"content":{"application\/json":{"schema":{"description":"Block reason IDs data.","type":"object","required":["reason_ids"],"properties":{"reason_ids":{"description":"A list of block reason IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"reason_ids":[1,2]}}}},"responses":{"204":{"description":"The block reasons have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/accessRequests":{"get":{"tags":["Board Access Requests"],"summary":"Get a list of access requests for a board","description":"Get a list of user-submitted access requests for a specific board.\n\nIf a user has sent **multiple** access requests, only the **last** one will be returned.\n\nIf an access request is approved or denied, it will **no longer** be included in the response.","operationId":"getBoardAccessRequests","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of access requests.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardAccessRequest"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardAccessRequestsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/MyAccessRequest":{"put":{"tags":["Board Access Requests"],"summary":"Request access to a board","description":"Request access to a board.","operationId":"requestBoardAccess","requestBody":{"content":{"application\/json":{"schema":{"description":"Board access request data.","type":"object","properties":{"comment":{"description":"An optional comment provided by the user requesting access, explaining why they need access to the board.","type":"string"}}}}}},"responses":{"204":{"description":"The access request has been sent."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boardAccessRequests\/processMany":{"post":{"tags":["Board Access Requests"],"summary":"Process a list of access requests","description":"Process a list of access requests.","operationId":"processBoardAccessRequests","requestBody":{"content":{"application\/json":{"schema":{"description":"Board access requests data.","type":"object","properties":{"requests_to_approve":{"description":"A list of board access requests to approve.","type":"array","items":{"required":["board_id","user_id","role_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board for which the access request is being processed."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who is requesting access to the board."},"role_id":{"format":"int32","type":"integer","description":"The ID of the role that will be assigned to the user once their access request is approved."}}}},"requests_to_deny":{"description":"A list of board access requests to deny.","type":"array","items":{"required":["board_id","user_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board for which the access request is being processed."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who is requesting access to the board."},"reason":{"type":"string","maxLength":255,"description":"An optional reason for denying the access request, which can be provided by the user processing the request.","default":""}}}}}},"example":{"$ref":"#\/components\/requestExamples\/BoardAccessRequestsProcessManyExample"}}}},"responses":{"204":{"description":"The access requests have been processed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/arrivalRules":{"get":{"tags":["Board Arrival Rules"],"summary":"Get a list of the arrival rules for a board","description":"Get a list of the arrival rules for a board.","operationId":"getBoardArrivalRules","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of arrival rules.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardRule"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardArrivalRulesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Board Arrival Rules"],"summary":"Add an arrival rule to a board","description":"Add an arrival rule to a board.","operationId":"addBoardArrivalRule","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardArrivalRuleCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardArrivalRuleCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardRule"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardArrivalRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/arrivalRules\/{rule_id}":{"get":{"tags":["Board Arrival Rules"],"summary":"Get the details of an arrival rule for a board","description":"Get the details of an arrival rule for a board.","operationId":"getBoardArrivalRule","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardRule"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardArrivalRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Arrival Rules"],"summary":"Update an arrival rule for a board","description":"Update an arrival rule for a board.","operationId":"updateBoardArrivalRule","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardArrivalRuleUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardArrivalRuleUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardRule"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardArrivalRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Arrival Rules"],"summary":"Remove an arrival rule from a board","description":"Remove an arrival rule from a board.","operationId":"removeBoardArrivalRule","responses":{"204":{"description":"The arrival rule has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/ruleIdInPath"}]},"\/boards\/{board_id}\/baiPrompts":{"get":{"tags":["Board BAI Prompts"],"summary":"Get a list of the BAI prompts for a board","description":"Returns a list of all Businessmap AI (BAI) prompts for a board.\n\nThere are **three** types of prompts:\r\n\r\n- **Comments and Emails** - Prompts that allow the generation of text content for a comment or email \r\n- **Subtasks** - Prompts that generate text for comments or email content associated with an existing card.\r\n- **Summaries** - Prompts that generate a concise summary of a card's contents, such as its title, description, and other relevant details.","operationId":"getBoardBaiPrompts","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of BAI prompts.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardBaiPrompt"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardBaiPromptsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Board BAI Prompts"],"summary":"Add a BAI prompt to a board","description":"Add a Businessmap AI (BAI) prompt to a board.","operationId":"addBoardBaiPrompt","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardBaiPromptCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardBaiPromptCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardBaiPrompt"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardBaiPromptExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/baiPrompts\/{prompt_id}":{"get":{"tags":["Board BAI Prompts"],"summary":"Get the details of a BAI prompt for a board","description":"Get the details of a Businessmap AI (BAI) prompt for a board.","operationId":"getBoardBaiPrompt","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardBaiPrompt"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardBaiPromptExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board BAI Prompts"],"summary":"Update a BAI prompt for a board","description":"Update a Businessmap AI (BAI) for a board. The **type** of a prompt **cannot** be changed once it's created.","operationId":"updateBoardBaiPrompt","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardBaiPromptUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardBaiPromptUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardBaiPrompt"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardBaiPromptExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board BAI Prompts"],"summary":"Remove a BAI prompt from a board","description":"Remove a Businessmap AI (BAI) from a board.","operationId":"removeBoardBaiPrompt","responses":{"204":{"description":"The Businessmap AI (BAI) prompt has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/promptIdInPath"}]},"\/boards\/{board_id}\/userRoles":{"get":{"tags":["Board Assignees"],"summary":"Get a list of board assignees","description":"Get a list of user IDs assigned to a specific board, along with their respective roles.\n\nYou can get a list of all roles by calling the [roles endpoint](#\/operations\/getRoles#Request) and a list of all users by calling the [users endpoint](#\/operations\/getUsers#request).","operationId":"getBoardAssignees","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of user IDs assigned to a specific board, along with their respective roles.","type":"array","items":{"title":"Board assignee","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user assigned to the board."},"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role assigned to the user on the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardAssigneesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/userRoles\/{user_id}":{"get":{"tags":["Board Assignees"],"summary":"Get the role of a board assignee","description":"Returns the role of a user assigned to a specific board.","operationId":"getBoardUserRole","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Board user role","description":"A role id.","type":"object","properties":{"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role assigned to the user on the board."}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardUserRoleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Assignees"],"summary":"Assign a user to a board","description":"Assign a user to a board or update their role.","operationId":"setBoardUserRole","requestBody":{"content":{"application\/json":{"schema":{"description":"Role data.","required":["role_id"],"type":"object","properties":{"role_id":{"description":"The unique identifier of the role to be assigned to the user on the board.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/BoardUserRoleSetRequestExample"}}}},"responses":{"204":{"description":"The user's role was successfully assigned or updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Assignees"],"summary":"Unassign a user from a board","description":"Unassign a user from a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the user's assignment and does **not** delete the user themselves.","operationId":"unsetBoardUserRole","responses":{"204":{"description":"The user has been successfully unassigned from the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/boards\/{board_id}\/userRoles\/batchOperations":{"post":{"tags":["Board Assignees"],"summary":"Assign\/unassign users to\/from a board.","description":"Assign\/unassign users to\/from a board or change their roles.","operationId":"setBoardUserRoles","requestBody":{"content":{"application\/json":{"schema":{"properties":{"users_to_add_or_update":{"description":"A list of user IDs and their roles to be added to or updated on the board.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardUserRoleSetRequest"}},"user_ids_to_remove":{"description":"A list of user IDs to be unassigned from the board.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/BoardUserRolesBatchOperationsExample"}}}},"responses":{"204":{"description":"The users have been assigned, unassigned, or had their roles updated successfully."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/blockReasons":{"get":{"tags":["Board Block Reasons"],"summary":"Get a list of block reasons available on a board","description":"Get a list of the block reasons available on a board. You can get all block reasons by calling the [blockReasons endpoint](#\/operations\/getBlockReasons#Request).","operationId":"getBoardBlockReasons","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of block reasons.","type":"array","items":{"title":"Block reason","type":"object","properties":{"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of the block reason."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardBlockReasonsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/blockReasons\/{reason_id}":{"get":{"tags":["Board Block Reasons"],"summary":"Check if a block reason is available on a board","description":"Check if a block reason is available on a board.","operationId":"checkBoardBlockReason","responses":{"204":{"description":"The block reason is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Block Reasons"],"summary":"Make a block reason available on a board","description":"Make a block reason available on a board.","operationId":"addBoardBlockReason","responses":{"204":{"description":"The block reason is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Block Reasons"],"summary":"Make a block reason unavailable on a board","description":"Make a block reason unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the block reason from the board and does **not** delete the actual block reason.","operationId":"removeBoardBlockReason","responses":{"204":{"description":"The block reason is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/blockReasonIdInPath"}]},"\/boards\/{board_id}\/effectiveCycleTimeColumns":{"get":{"tags":["Board Effective Cycle Time Columns"],"summary":"Get the specified board's workflows and their effective cycle time columns","description":"Get the specified board's workflows and their effective cycle time columns.\n\nBy default, each board has two workflows:\n- **Cards workflow**\n- **Initiatives workflow**\n\nEach of these workflows includes the following cycle time columns by default:\n- **Requested**\n- **In Progress**\n\nYou can find a list of all boards by calling the [boards endpoint](#\/operations\/getBoards#Request).\n","operationId":"getBoardEffectiveCycleTimeColumns","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of workflows and their effective cycle time columns.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardEffectiveCycleTimeColumn"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardEffectiveCycleTimeColumnsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/cardAndInitiativeViews\/{view_id}\/defaultSettings":{"get":{"tags":["Board Card and Initiative Default Views Settings"],"summary":"Get the default card and initiative view settings for one of the four available views on a board","description":"Get the default card and initiative view settings for one of the four available views on a board.","operationId":"getBoardCardAndInitiativeViewSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Card and Initiative Default Views Settings"],"summary":"Update the default card and initiative view settings for one of the four available views on a board","description":"Update the default card and initiative view settings for one of the four available views on a board.\n\nUsers who have **already** saved their personal view settings using the [mySettings](#\/operations\/setBoardCardAndInitiativeViewSettings#Request) endpoint will **not** be affected.","operationId":"updateBoardCardAndInitiativeViewSettings","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettingsUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardCardAndInitiativeViewSettingsUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/viewIdInPath"}]},"\/boards\/{board_id}\/cardAndInitiativeViews\/{view_id}\/effectiveSettings":{"get":{"tags":["Board Card and Initiative Effective Views Settings"],"summary":"Get the effective card and initiative view settings for one of the four available views on a board","description":"Get the effective card and initiative view settings for one of the four available views on a board.\n\nIf a user has saved their personal view settings using the [mySettings](#\/operations\/setBoardCardAndInitiativeViewSettings#Request) endpoint, those settings will be returned **instead** of the default settings.\nIf they **haven't**, the **default** settings for the board will be returned.","operationId":"getBoardCardAndInitiativeViewEffectiveSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/viewIdInPath"}]},"\/boards\/{board_id}\/cardAndInitiativeViews\/{view_id}\/mySettings":{"get":{"tags":["Board Card and Initiative Views My Settings"],"summary":"Get the current user's card and initiative view settings for one of the four available views on a board","description":"Get the current user's card and initiative view settings for one of the four available views on a board.","operationId":"getMyBoardCardAndInitiativeViewSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Card and Initiative Views My Settings"],"summary":"Update the current user's card and initiative view settings for one of the four available views on a board","description":"Update the current user's card and initiative view settings for one of the four available views on a board.","operationId":"updateMyBoardCardAndInitiativeViewSettings","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettingsUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardCardAndInitiativeViewSettingsUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Card and Initiative Views My Settings"],"summary":"Set the current user's card and initiative view settings for one of the four available views on a board","description":"Set the current user's card and initiative view settings for one of the four available views on a board. **All** of the parameters are **required**.","operationId":"setBoardCardAndInitiativeViewSettings","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewRequiredSettingsUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardCardAndInitiativeViewSettingsUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardAndInitiativeViewSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardAndInitiativeViewSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Card and Initiative Views My Settings"],"summary":"Reset the current user's card and initiative view settings for one of the board\u2019s four available views to their default state","description":"Reset the current user's card and initiative view settings for one of the board\u2019s four available views to their default state.","operationId":"resetBoardCardAndInitiativeViewSettings","responses":{"204":{"description":"The settings for the current user were successfully reset to their default values."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/viewIdInPath"}]},"\/boards\/{board_id}\/cardTemplates":{"get":{"tags":["Board Card Templates"],"summary":"Get a list of card templates available on a board","description":"Get a list of the card templates available on a board. You can get all card templates by calling the [cardTemplates endpoint](#\/operations\/getCardTemplates#Request).","operationId":"getBoardCardTemplates","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card templates.","type":"array","items":{"title":"Card template","type":"object","properties":{"template_id":{"description":"The unique identifier of the card template.","format":"int32","type":"integer"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTemplatesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/cardTemplates\/{template_id}":{"get":{"tags":["Board Card Templates"],"summary":"Check if a card template is available on a board","description":"Check if a card template is available on a board.","operationId":"checkBoardCardTemplate","responses":{"204":{"description":"The card template is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Card Templates"],"summary":"Make a card template available on a board","description":"Make a card template available on a board.","operationId":"addBoardCardTemplate","responses":{"204":{"description":"The card template is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Card Templates"],"summary":"Make a card template unavailable on a board","description":"Make a card template unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the card template from the board and does **not** delete the actual card template.","operationId":"removeBoardCardTemplate","responses":{"204":{"description":"The card template is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/templateIdInPath"}]},"\/boards\/{board_id}\/cardTypes":{"get":{"tags":["Board Card Types"],"summary":"Get a list of card types available on a board","description":"Get a list of the card types available on a board. You can get all card types by calling the [cardTypes endpoint](#\/operations\/getCardTypes#Request).","operationId":"getBoardCardTypes","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card types.","type":"array","items":{"allOf":[{"type":"object","properties":{"type_id":{"description":"The unique identifier of the card type.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCardType"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTypesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/cardTypes\/{type_id}":{"get":{"tags":["Board Card Types"],"summary":"Check if a card type is available on a board","description":"Check if a card type is available on a board.","operationId":"checkBoardCardType","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardType"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Card Types"],"summary":"Make a card type available on a board","description":"Make a card type available on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> If no parameters are specified in the request body, the card type will be added to the board with `null` values for **all** fields.\r\n> \r\n> If you get the effective settings of the card type using the [effectiveSettings endpoint](#\/operations\/getBoardCardTypeEffectiveSettings#Request), you will see that the card type has been added with its **global** settings.","operationId":"addBoardCardType","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardCardTypeCreateOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardCardTypeCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardType"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Card Types"],"summary":"Update a card type available on a board","description":"Update a card type available on a board. The changes made will **only** apply to the **specific board** and will **not** affect the **global** settings of the card type.","operationId":"updateBoardCardType","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardCardTypeCreateOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardCardTypeCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardType"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Card Types"],"summary":"Make a card type unavailable on a board","description":"Make a card type unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the card type from the board and does **not** delete the actual card type.","operationId":"removeBoardCardType","responses":{"204":{"description":"The card type is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/boards\/{board_id}\/cardTypes\/{type_id}\/effectiveSettings":{"get":{"tags":["Board Card Types"],"summary":"Get the effective settings of a card type for a board if it is available on it","description":"Get the effective settings of a card type for a board if it is available on it. If you've made any changes to a type on a board level using the [updateBoardCardType](#\/operations\/updateBoardCardType#Request) endpoint, those changes will be reflected here as well.","operationId":"getBoardCardTypeEffectiveSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCardType"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/boards\/{board_id}\/columns\/{column_id}\/checklistItems":{"get":{"tags":["Board Column Checklist Items"],"summary":"Get a list of checklist items in a specified column","description":"Get a list of the checklist items (exit criteria) in a specified column.","operationId":"getChecklistItems","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of checklist items.","type":"array","items":{"$ref":"#\/components\/schemas\/ChecklistItem"}}}},"example":{"$ref":"#\/components\/responseExamples\/ChecklistItemsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Board Column Checklist Items"],"summary":"Create a checklist item in a specified column","description":"Create a new checklist item (exit criterion) in a specified column.","operationId":"createChecklistItem","requestBody":{"content":{"application\/json":{"schema":{"description":"Checklist item data.","required":["text"],"type":"object","properties":{"text":{"description":"The description of the new checklist item.","type":"string","minLength":1},"position":{"description":"The position of the new checklist item. `0` is the first position. If you don't specify a position, the checklist item will be added to the **end** of the list.","format":"int32","type":"integer"},"allowed_user_ids":{"description":"A list of user IDs that are allowed to mark the new checklist item as completed. If the list is empty or you don't pass it as a request body parameter, **all** users added to the board will be allowed to mark the checklist item as completed.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":[{"$ref":"#\/components\/requestExamples\/ChecklistItemCreateRequestExample"}]}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ChecklistItem"}}},"example":{"$ref":"#\/components\/responseExamples\/ChecklistItemExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/columnIdInPath"}]},"\/boards\/{board_id}\/columns\/{column_id}\/checklistItems\/{item_id}":{"get":{"tags":["Board Column Checklist Items"],"summary":"Get the details of a single checklist item in a specified column","description":"Get the details of a single checklist item (exit criterion) in a specified column.","operationId":"getChecklistItem","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ChecklistItem"}}},"example":{"$ref":"#\/components\/responseExamples\/ChecklistItemExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Column Checklist Items"],"summary":"Update a checklist item in a specified column","description":"Update a checklist item (exit criterion) in a specified column.","operationId":"updateChecklistItem","requestBody":{"content":{"application\/json":{"schema":{"description":"Checklist item data.","type":"object","properties":{"text":{"description":"The description of the checklist item.","type":"string","minLength":1},"position":{"description":"The position of the checklist item. `0` is the first position.","format":"int32","type":"integer"},"allowed_user_ids_to_add":{"description":"Add user IDs to the list of users allowed to mark the checklist item as completed. If the list is empty, **all** users added to the board will be allowed to mark the checklist item as completed.","type":"array","items":{"format":"int32","type":"integer"}},"allowed_user_ids_to_remove":{"description":"Remove user IDs from the list of users allowed to mark the checklist item as completed. If the list is empty, **all** users added to the board will be allowed to mark the checklist item as completed.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/ChecklistItemUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/ChecklistItem"}}},"example":{"$ref":"#\/components\/responseExamples\/ChecklistItemExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Column Checklist Items"],"summary":"Delete a checklist item in a specified column","description":"Delete a checklist item (exit criterion) in a specified column.","operationId":"deleteChecklistItem","responses":{"204":{"description":"The checklist item has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/columnIdInPath"},{"$ref":"#\/components\/parameters\/checklistItemIdInPath"}]},"\/boards\/{board_id}\/columns\/{column_id}\/checklistItems\/{item_id}\/allowedUsers":{"get":{"tags":["Board Column Checklist Item Allowed Users"],"summary":"Get a list of the users that are allowed to mark the specified checklist item as completed in a specified column","description":"Get a list of the users that are allowed to mark the specified checklist item (exit criterion) as completed in a specified column. If the list is empty, **all** users added to the board are allowed to check the checklist item.","operationId":"getColumnChecklistItemAllowedUsers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of users.","type":"array","items":{"type":"object","title":"Board user","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/ColumnChecklistItemAllowedUsersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/columnIdInPath"},{"$ref":"#\/components\/parameters\/checklistItemIdInPath"}]},"\/boards\/{board_id}\/columns\/{column_id}\/checklistItems\/{item_id}\/allowedUsers\/{user_id}":{"get":{"tags":["Board Column Checklist Item Allowed Users"],"summary":"Check if a user is allowed to mark the specified checklist item as completed in a specified column","description":"Check if a user is allowed to mark the specified checklist item (exit criterion) as completed in a specified column.\r\n\r\n\r\n> ### Info\r\n>\r\n> If the list of users allowed to mark a checklist item as completed is empty, this endpoint will return the **404 error** for **all** users added to the board. In such cases it's best to use the [allowedUsers endpoint](#\/operations\/getColumnChecklistItemAllowedUsers#Request) instead.\r\n","operationId":"checkColumnChecklistItemAllowedUser","responses":{"204":{"description":"The user is allowed to mark the checklist item as completed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Column Checklist Item Allowed Users"],"summary":"Allow a user to mark the specified checklist item as completed in a specified column","description":"Allow a user to mark the specified checklist item (exit criterion) as completed in a specified column.","operationId":"allowColumnChecklistItemUser","responses":{"204":{"description":"The user has been allowed to mark the checklist item as completed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Column Checklist Item Allowed Users"],"summary":"Disallow a user to mark the specified checklist item as completed in a specified column","description":"Disallow a user to mark the specified checklist item (exit criterion) as completed in a specified column.","operationId":"disallowColumnChecklistItemUser","responses":{"204":{"description":"The user has been disallowed to mark the checklist item as completed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/columnIdInPath"},{"$ref":"#\/components\/parameters\/checklistItemIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}\/allowedValues":{"get":{"tags":["Board Custom Field Allowed Values"],"summary":"Get a list of the allowed values of a custom field of type dropdown on a specified board","description":"Get a list of allowed values for a custom field of type **dropdown** on the specified board. You can obtain detailed information about the allowed values by calling the [allowedValues endpoint](#\/operations\/getCustomFieldAllowedValues#Request).\r\n\r\nBy default the allowed values that are added on a **board** level **match** the ones that are on a **global** level. \r\n\r\nIf a **new** allowed value is added on a **board** level, the allowed value will **also** appear on a **global** level. \r\nIf a custom field is **already** added to a board, any additional allowed values added on a **global** level will **not** automatically appear on a **board** level.","operationId":"getBoardCustomFieldAllowedValues","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of allowed values.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardCustomFieldAllowedValue"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldAllowedValuesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}\/allowedValues\/{value_id}":{"get":{"tags":["Board Custom Field Allowed Values"],"summary":"Get a single allowed value for a custom field of type dropdown on a specified board","description":"Get a single allowed value for a custom field of type **dropdown** on the specified board. You can obtain detailed information about the allowed value by calling the [allowedValues endpoint](#\/operations\/getCustomFieldAllowedValue#Request).","operationId":"getBoardCustomFieldAllowedValue","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCustomFieldAllowedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldAllowedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Custom Field Allowed Values"],"summary":"Add or update an allowed value for a custom field of type dropdown on a specified board","description":"Add or update an allowed value for a custom field of type **dropdown** on the specified board. If a **new** allowed value is added on a **board** level, the allowed value will **also** appear on a **global** level.","operationId":"addOrUpdateBoardCustomFieldAllowedValue","requestBody":{"content":{"application\/json":{"schema":{"description":"Board custom field allowed value data.","type":"object","properties":{"position":{"description":"The position of the allowed value. `0` is the first position. If no position is specified in the request body, the allowed value will be added to the **end** of the list.","format":"int32","type":"integer"},"is_default":{"description":"Controls whether the allowed value is a default value for the custom field on the specified board.","format":"int32","type":"integer","default":1,"enum":[0,1]}}},"example":{"$ref":"#\/components\/requestExamples\/BoardCustomFieldAllowedValueCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCustomFieldAllowedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldAllowedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Custom Field Allowed Values"],"summary":"Update an allowed value for a custom field of type dropdown on a specified board","description":"Update an allowed value for a custom field of type **dropdown** on a specified board.","operationId":"updateBoardCustomFieldAllowedValue","requestBody":{"content":{"application\/json":{"schema":{"description":"Board custom field allowed value data.","type":"object","properties":{"position":{"description":"The position of the allowed value. `0` is the first position. If no position is specified in the request body, the allowed value will be added to the **end** of the list.","format":"int32","type":"integer"},"is_default":{"description":"Controls whether the allowed value is a default value for the custom field on the specified board.","format":"int32","type":"integer","default":1,"enum":[0,1]}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardCustomFieldAllowedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldAllowedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Custom Field Allowed Values"],"summary":"Remove an allowed value for a custom field of type dropdown on a specified board","description":"Remove an allowed value for a custom field of type **dropdown** on a specified board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the allowed value from the board and does **not** delete the allowed value itself.","operationId":"removeBoardCustomFieldAllowedValue","responses":{"204":{"description":"The allowed value has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/valueIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}\/defaultContributors":{"get":{"tags":["Board Custom Field Default Contributors"],"summary":"Get a list of the default contributors for a custom field of type contributor on a specified board","description":"Get a list of the default contributors for a custom field of type contributor on a specified board. You can find a list of all custom files of type **contributor** by calling the [customFields](#\/operations\/getCustomFields#Request) endpoint with a **filter** for `types`, e.g. `\/customFields?types=contributor`.","operationId":"getBoardCustomFieldDefaultContributors","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of user IDs that are set as default contributors.","type":"array","items":{"title":"Board default contributor","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldDefaultContributorsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}\/defaultContributors\/{user_id}":{"get":{"tags":["Board Custom Field Default Contributors"],"summary":"Check if a user is a default contributor for a custom field of type contributor on a specified board","description":"Check if a user is a default contributor for a custom field of type contributor on a specified board.","operationId":"checkBoardCustomFieldDefaultContributor","responses":{"204":{"description":"The user is a default conrtibutor for the custom field on the specified board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Custom Field Default Contributors"],"summary":"Set a user as a default contributor for a custom field of type contributor on a specified board","description":"Set a user as a default contributor for a custom field of type contributor on a specified board.","operationId":"addBoardCustomFieldDefaultContributor","responses":{"204":{"description":"The user is now a default contributor for the custom field of type contributor on the specified board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Custom Field Default Contributors"],"summary":"Remove a user from the default contributor list for a custom field of type contributor on a specified board","description":"Remove a user from the default contributor list for a custom field of type contributor on a specified board.","operationId":"removeBoardCustomFieldDefaultContributor","responses":{"204":{"description":"The user has been removed from the list of default contributors for the custom field of type contributor on the specified board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/boards\/{board_id}\/customFields":{"get":{"tags":["Board Custom Fields"],"summary":"Get a list of custom fields available on a specified board","description":"Get a list of the custom fields available on a specified board. You can obtain detailed information about the custom fields by calling the [customFields endpoint](#\/operations\/getCustomFields#Request).","operationId":"getBoardCustomFields","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of board custom field properties.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPickerWithFieldId"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}":{"get":{"tags":["Board Custom Fields"],"summary":"Get a custom field available on a specified board","description":"Get a custom field available on a specified board.\r\n\r\n> ### Info\r\n>The response body of this request may contain mostly null values, if the custom field hasn't been updated **at least once** on a board level.\r\n>In those cases you can call the [effectiveSettings endpoint](#\/operations\/getBoardCustomFieldEffectiveSettings#Request).\r\n","operationId":"getBoardCustomField","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Custom Fields"],"summary":"Add a custom field to a board","description":"Add a custom field to a board. When adding a custom field to a board, please check its **availability level** in the **global** settings using the [customFields\/{field_id} endpoint](#\/operations\/getCustomField#Request).\n\nWhen set to `0` the custom field has to be added to boards **manually**.\n\nWhen set to `1` the custom field is added **automatically** to **all new** boards and will **not** be added to **existing** boards.\n\nWhen set to `2` the custom field is added **automatically** to **all** boards and **cannot** be removed.","operationId":"addBoardCustomField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateAnyType"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCardPicker"}]},"example":{"$ref":"#\/components\/requestExamples\/BoardCustomFieldCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Custom Fields"],"summary":"Update the properties of a custom field available on a specified board","description":"Update the properties of a custom field available on a specified board.","operationId":"updateBoardCustomField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCardPicker"}]},"example":{"$ref":"#\/components\/requestExamples\/BoardCustomFieldCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Custom Fields"],"summary":"Make a custom field unavailable on a specified board","description":"Make a custom field unavailable on a specified board.","operationId":"removeBoardCustomField","responses":{"204":{"description":"The custom field is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/boards\/{board_id}\/customFields\/{field_id}\/effectiveSettings":{"get":{"tags":["Board Custom Fields"],"summary":"Get the effective settings of a custom field available on a specified board","description":"Get the effective settings of a custom field available on a specified board. If the custom field has **not** been updated on a **board** level, the response body of this request will contain the default values inherited from the **global** settings found in the [customFields\/{field_id} endpoint](#\/operations\/getCustomField#Request).","operationId":"getBoardCustomFieldEffectiveSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataCardPicker"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataCalculatedFieldNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldEffectiveSettingsDataCalculatedFieldDate"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCustomFieldEffectiveSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/boards\/{board_id}\/dataFields":{"get":{"tags":["Board Data Fields"],"summary":"Get a list of a board's data fields","description":"Get a list of the data fields available on a specified board. You can obtain detailed information about the data fields by calling the [dataFields endpoint](#\/operations\/getDataFields#Request).","operationId":"getBoardDataFields","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data fields with their values on the board.","type":"array","items":{"title":"Board data field","type":"object","properties":{"data_field_id":{"description":"The ID of the data field.","format":"int32","type":"integer"},"value":{"description":"The value for data field on the board.","type":"string","nullable":true},"baseline":{"description":"The baseline value for data field on the board.","type":"string","nullable":true},"value_is_locked":{"description":"Indicates whether the value is locked.","format":"int32","type":"integer","enum":[0,1],"default":0},"dropdown_value_id":{"description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","format":"int32","type":"integer","nullable":true},"contributor_user_id":{"description":"The ID of an existing user used if the data field is of type `contributor`.","format":"int32","type":"integer","nullable":true}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDataFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/dataFields\/{data_field_id}":{"get":{"tags":["Board Data Fields"],"summary":"Get a data field data on a specified board","description":"Get a data field data on a specified board.","operationId":"getBoardDataField","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A data field with its values on the board.","type":"object","properties":{"value":{"description":"The value for the data field on the board.","type":"string","nullable":true},"baseline":{"description":"The baseline value for the data field on the board.","type":"string","nullable":true},"value_is_locked":{"description":"Indicates whether the value is locked.","format":"int32","type":"integer","enum":[0,1],"default":0},"dropdown_value_id":{"description":"If the data field is a `dropdown`, this parameter specifies the ID of the value. Cannot be used together with `dropdown_value_reference`.","format":"int32","type":"integer","nullable":true},"dropdown_value_reference":{"description":"This can be used to identify a dropdown value that is being created in the same request as the data field is being added or updated. This is only applicable when the data field is of type `dropdown`.","type":"string","nullable":true},"contributor_user_id":{"description":"The ID of an existing user used if the data field is of type `contributor`.","format":"int32","type":"integer","nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Data Fields"],"summary":"Add or update a data field to\/on a board","description":"Add or update a data field to\/on a board.","operationId":"addBoardDataField","requestBody":{"content":{"application\/json":{"schema":{"description":"Data field item data.","type":"object","properties":{"value":{"type":"string","description":"The value to be set on the board.","nullable":true},"baseline":{"description":"The baseline value to be set on the board.","type":"string","nullable":true},"value_is_locked":{"format":"int32","type":"integer","description":"Indicates whether the value is locked.","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`.","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/BoardDataFieldAddOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A data field with its values on the board.","type":"object","properties":{"value":{"type":"string","description":"The value for data field on the board.","nullable":true},"baseline":{"description":"The baseline value for data field on the board.","type":"string","nullable":true},"value_is_locked":{"format":"int32","type":"integer","description":"Indicates whether the value is locked.","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter will be added to data and specify the ID of the value set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"If the data field is a `contributor`, this parameter will be added to data and specify the ID of the user set.","nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Data Fields"],"summary":"Remove a data field from a board","description":"Remove a data field from a board.","operationId":"removeBoardDataField","responses":{"204":{"description":"The data field is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/boards\/{board_id}\/dataFields\/{data_field_id}\/value":{"patch":{"tags":["Board Data Fields"],"summary":"Update a data field value on a board","description":"Update a data field value on a board. This is mainly for users which have the 'manage data fields' permission in their board role, but can also be used by owners and admins.","operationId":"updateBoardDataField","requestBody":{"content":{"application\/json":{"schema":{"description":"Data field item data.","type":"object","properties":{"value":{"type":"string","description":"The value to be set on the board.","nullable":true},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set. If the value is null it will set empty value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`. If the value is null it will set empty value.","nullable":true}}},"example":{"value":5}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A data field with its values on the board.","type":"object","properties":{"value":{"type":"string","description":"The value for data field on the board.","nullable":true},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a dropdown, this parameter will be added to data and specify the ID of the value set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"If the data field is a contributor, this parameter will be added to data and specify the ID of the user set.","nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDataFieldUpdateValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/boards\/{board_id}\/defaultSettings":{"get":{"tags":["Board Default Settings"],"summary":"Get the default values of the board settings","description":"Get the default values of the board settings.","operationId":"getBoardDefaultSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of settings.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardWorkflowAndLaneDefaultSettings"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDefaultSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/defaultSettings\/{setting_name}":{"get":{"tags":["Board Default Settings"],"summary":"Get the default value of a specific board setting","description":"Get the default value of a specific board setting.","operationId":"getBoardDefaultSetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardWorkflowAndLaneDefaultSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDefaultSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Default Settings"],"summary":"Set the default value of a specific board setting","description":"Set the default value of a specific board setting.","operationId":"setBoardDefaultSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"Contains the new default setting value.","type":"object","properties":{"value":{"description":"The new default value of the setting.","type":"integer","format":"int32"}}},"example":{"$ref":"#\/components\/requestExamples\/BoardDefaultSettingCreateOrUpdateRequestExample"}}}},"responses":{"204":{"description":"The default value of the board setting has been successfully set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Default Settings"],"summary":"Reset the default value of a specific board setting","description":"Reset the default value of a specific board setting. This changes the setting's default value to `null`.","operationId":"resetBoardDefaultSetting","responses":{"204":{"description":"The default value of the board setting has been reset."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/settingName"}]},"\/boards\/{board_id}\/departureRules":{"get":{"tags":["Board Departure Rules"],"summary":"Get a list of the departure rules for a specified board","description":"Get a list of the departure rules for a specified board.","operationId":"getBoardDeparturelRules","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of departure rules.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardRule"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDepartureRulesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Board Departure Rules"],"summary":"Add a departure rule to a specified board","description":"Add a departure rule to a specified board.","operationId":"addBoardDepartureRule","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardDepartureRuleCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardDepatureRuleCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of departure rules.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardRule"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDepartureRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/departureRules\/{rule_id}":{"get":{"tags":["Board Departure Rules"],"summary":"Get a specific departure rule for a specified board","description":"Get a specific departure rule for a specified board.","operationId":"getBoardDepartureRule","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardRule"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDepartureRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Departure Rules"],"summary":"Update a departure rule for a specified board","description":"Update a departure rule for a specified board.","operationId":"updateBoardDepartureRule","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardDepartureRuleUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/BoardDepatureRuleCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardRule"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDepartureRuleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Departure Rules"],"summary":"Delete a departure rule from a specified board","description":"Delete a departure rule from a specifed board.","operationId":"deleteBoardDepartureRule","responses":{"204":{"description":"The departure rule has been deleted from the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/ruleIdInPath"}]},"\/boards\/{board_id}\/discardReasons":{"get":{"tags":["Board Discard Reasons"],"summary":"Get a list of discard reasons available on the specified board","description":"Get a list of the discard reasons available on the specified board. You can get a list of all discard reasons by calling the [discardReasons endpoint](#\/operations\/getDiscardReasons#Request).","operationId":"getBoardDiscardReasons","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of discard reasons.","type":"array","items":{"title":"Board Discard Reason","type":"object","properties":{"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of the discard reason."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardDiscardReasonsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/docs":{"get":{"tags":["Board Docs"],"summary":"Get docs for a board","description":"Get all docs associated with a specific board.","operationId":"getBoardDocs","parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of docs.","type":"array","items":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"position":{"description":"The position of the doc on the board.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"doc_id":123,"title":"My Document","is_important":1,"is_archived":0,"position":0},{"doc_id":124,"title":"Another Document","is_important":0,"is_archived":0,"position":1}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/discardReasons\/{reason_id}":{"get":{"tags":["Board Discard Reasons"],"summary":"Check if a discard reason is available on the specified board","description":"Check if a discard reason is available on the specified board.","operationId":"checkBoardDiscardReason","responses":{"204":{"description":"The discard reason is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Discard Reasons"],"summary":"Make a discard reason available on the specified board","description":"Make a discard reason available on the specified board.","operationId":"addBoardDiscardReason","responses":{"204":{"description":"The discard reason is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Discard Reasons"],"summary":"Make a discard reason unavailable on the specified board","description":"Make a discard reason unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the discard reason from the board and does **not** delete the actual discard reason.","operationId":"removeBoardDiscardReason","responses":{"204":{"description":"The discard reason is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/discardReasonIdInPath"}]},"\/boards\/history":{"get":{"tags":["Board History"],"summary":"Get a list of board management history events","description":"Retrieves a list of events related to board management.\nThis endpoint allows you to review the history of boards and can be tailored using various filtering options.\n","operationId":"getBoardsHistory","parameters":[{"name":"board_ids","in":"query","description":"A list of boards IDs used to filter the boards history to include only boards with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the boards history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types used to filter the boards history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["board_created","board_updated","board_archived","board_unarchived","board_moved","workflow_created","workflow_updated","workflow_deleted","workflow_disabled","workflow_enabled","lane_created","lane_renamed","lane_deleted","lane_moved","column_created","column_renamed","column_deleted","column_moved","cell_limits_updated","lane_section_limits_updated","merged_areas_updated","related_boards_updated","user_assigned","user_unassigned","user_role_changed","discard_reason_added","discard_reason_removed","block_reason_added","block_reason_removed","sticker_added","sticker_removed","card_type_added","card_type_removed","tag_added","tag_removed","card_template_added","card_template_removed","custom_field_added","custom_field_removed","team_added","team_role_changed","team_removed","cell_card_orderings_updated","logged_time_category_added","logged_time_category_removed","cycle_time_columns_added","cycle_time_columns_removed"]}},"example":"board_created,board_updated","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of board management history events.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardHistoryEventsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/loggedTimeCategories":{"get":{"tags":["Board Logged Time Categories"],"summary":"Get a list of the logged time categories for the specified board","description":"Get a list of the logged time categories for the specified board. You can get a list of all logged time categories by calling the [loggedTimeCategories endpoint](#\/operations\/getLoggedTimeCategories#Request).","operationId":"getBoardLoggedTimeCategories","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of logged time categories.","type":"array","items":{"title":"Board logged time category","type":"object","properties":{"category_id":{"format":"int32","type":"integer","description":"The unique identifier of the logged time category."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardLoggedTimeCategoriesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/loggedTimeCategories\/{category_id}":{"get":{"tags":["Board Logged Time Categories"],"summary":"Check if a logged time category is available on the specified board.","description":"Check if a logged time category is added on the specified board.","operationId":"getBoardLoggedTimeCategory","responses":{"204":{"description":"The logged time category is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Logged Time Categories"],"summary":"Make a logged time category available on the specified board","description":"Make a logged time category available on the specified board.","operationId":"addBoardLoggedTimeCategory","responses":{"204":{"description":"The logged time category is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Logged Time Categories"],"summary":"Make a logged time category unavailable on the specified board","description":"Make a logged time category unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the logged time category from the board and does **not** delete the actual logged time category.","operationId":"removeBoardLoggedTimeCategory","responses":{"204":{"description":"The logged time category is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/categoryIdInPath"}]},"\/boards\/{board_id}\/milestones":{"get":{"tags":["Board Milestones"],"summary":"Get a list of milestones available on the specified board","description":"Get a list of the milestones available on the specified board. You can get a list of all milestones by calling the [milestones endpoint](#\/operations\/getMilestones#Request).","operationId":"getBoardMilestones","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of milestones.","type":"array","items":{"title":"Board milestone","type":"object","properties":{"milestone_id":{"format":"int32","type":"integer","description":"The unique identifier of the milestone."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardMilestonesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/milestones\/{milestone_id}":{"get":{"tags":["Board Milestones"],"summary":"Check if a milestone is available on the specified board","description":"Check if a milestone is available on the specified board.","operationId":"checkBoardMilestone","responses":{"204":{"description":"The milestone is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Milestones"],"summary":"Make a milestone available on the specified board","description":"Make a milestone available on the specified board.","operationId":"addBoardMilestone","responses":{"204":{"description":"The milestone is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Milestones"],"summary":"Make a milestone unavailable on the specified board","description":"Make a milestone unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the milestone from the board and does **not** delete the actual milestone.","operationId":"removeBoardMilestone","responses":{"204":{"description":"The milestone is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/boards\/{board_id}\/pointsOfContact":{"get":{"tags":["Board Points Of Contact"],"summary":"Get a list of users assigned as points of contact for the specified board","description":"Get a list of users assigned as points of contact (POCs) for the specified board. These users receive all access requests sent for the board. You can check all board access requests using the [boardAccessRequests endpoint](#\/operations\/getBoardAccessRequests#Request).\n\nOnly an **owner** or a **workspace manager** can be designated as a point of contact for a board.","operationId":"getBoardPointsOfContact","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of points of contact.","type":"array","items":{"title":"Board point of contact","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."},"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardPointsOfContactExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/pointsOfContact\/{user_id}":{"get":{"tags":["Board Points Of Contact"],"summary":"Check if a user is added as point of contact for the specified board","description":"Check if a user is added as point of contact for the specified board.","operationId":"checkBoardPointOfContact","responses":{"204":{"description":"The user is a point of contact for the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Points Of Contact"],"summary":"Add a user as a point of contact for the specified board","description":"Add a user as a point of contact for the specified board.","operationId":"addBoardPointOfContact","responses":{"204":{"description":"The user is added as a point of contact for the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Points Of Contact"],"summary":"Remove a user as a point of contact for the specified board","description":"Remove a user from the list of points of contact for the specified board.","operationId":"removeBoardPointOfContact","responses":{"204":{"description":"The user has been removed as a point of contact for the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/boards\/{board_id}\/settings":{"get":{"tags":["Board Settings"],"summary":"Get the values of the board settings","description":"Get the values of the board settings.","operationId":"getBoardSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Settings"],"summary":"Set the values of the board settings","description":"Set the values of the board settings.","operationId":"setBoardSettings","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/BoardSettings"},"example":{"$ref":"#\/components\/requestExamples\/BoardSettingsRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/stickers":{"get":{"tags":["Board Stickers"],"summary":"Get a list of stickers available on the specified board","description":"Get a list of the stickers available on a board. You can get a list of all stickers by calling the [stickers endpoint](#\/operations\/getStickers#Request).","operationId":"getBoardStickers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of stickers.","type":"array","items":{"title":"Board sticker","type":"object","properties":{"sticker_id":{"format":"int32","type":"integer","description":"The unique identifier of the sticker."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStickersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/stickers\/{sticker_id}":{"get":{"tags":["Board Stickers"],"summary":"Check if a sticker is available on the specified board","description":"Check if a sticker is available on the specified board.","operationId":"checkBoardSticker","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Board sticker","description":"Board sticker data.","type":"object","properties":{"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board.","default":0},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card.","default":0}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStickerExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Stickers"],"summary":"Make a sticker available on the specified board","description":"Make a sticker available on the specified board.","operationId":"addBoardSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"Board sticker data.","type":"object","properties":{"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board.","default":0},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card.","default":0}}},"example":{"$ref":"#\/components\/requestExamples\/BoardStickerRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Board sticker","description":"Board sticker data","type":"object","properties":{"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board.","default":0},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card.","default":0}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStickerExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Board Stickers"],"summary":"Update the properties of a sticker for the specified board","description":"Update the properties of a sticker for the specified board.","operationId":"updateBoardSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"Board sticker data.","type":"object","properties":{"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board.","default":0},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card.","default":0}}},"example":{"$ref":"#\/components\/requestExamples\/BoardStickerRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Board sticker","description":"Board sticker data","type":"object","properties":{"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board.","default":0},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card.","default":0}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStickerExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Stickers"],"summary":"Make a sticker unavailable on the specified board","description":"Make a sticker unavailable on the specified board.","operationId":"removeBoardSticker","responses":{"204":{"description":"The sticker is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/stickerIdInPath"}]},"\/boards\/{board_id}\/currentStructure":{"get":{"tags":["Board Structure"],"summary":"Get the current board structure","description":"Retrieves the complete and current structural configuration of a specific board, including all **workflows**, **lanes**, and **columns**, each uniquely identified by an ID.\n\nA board is composed of one or more **workflows**, which are the top-level organizational units. Each workflow contains horizontal **lanes** and vertical **columns**.\n\n**Lanes** are horizontal swimlanes that span across multiple **columns**. **Columns** are vertical sections that define process stages.\n\nEvery board is initialized with two default workflows: the **Initiatives Workflow** and the **Cards Workflow**. Each of these starts with its own default lane - the **Portfolio Lane** for Initiatives and the **Default Swimlane** for Cards - and a set of default columns: **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive**.\n\nThere are **three** available **workflow types**: **Cards**, **Initiatives**, and **Timeline**.

Related endpoints:<\/h3>\n- [Workflows](#\/operations\/getWorkflows#Request)\n- [Lanes](#\/operations\/getLanes#Request)\n- [Columns](#\/operations\/getColumns#Request)","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardStructure"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStructureExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/currentStructure\/revision":{"get":{"tags":["Board Structure"],"summary":"Get the current revision of the board structure for the specified board","description":"Get the current revision of the board structure for the specified board. The revision number denotes the number of times edits were made to the board structure. A single revision can include multiple edits, if they were done at the same time.","operationId":"getCurrentBoardStructureRevision","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Current board structure revision","description":"Contains the current revision of the board structure.","type":"object","properties":{"revision":{"format":"int32","type":"integer","description":"The current revision of the board structure."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CurrentBoardStructureRevisionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/structureRevisions":{"get":{"tags":["Board Structure Revisions"],"summary":"Get a list of the past revisions of the board structure for the specified board","description":"Get a list of the past revisions of the board structure for the specified board and the date and time at which they were replaced. You can get the current revision by using the [currentStructure\/revision endpoint](#\/operations\/getCurrentBoardStructureRevision#Request).\n\nThe revision number denotes the number of times edits were made to the board structure. A single revision can include multiple edits, if they were done at the same time.","operationId":"getBoardStructureRevisions","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of board structure revisions.","type":"array","items":{"title":"Board structure revision","type":"object","properties":{"revision":{"format":"int32","type":"integer","description":"The revision number of the board structure."},"replaced_at":{"type":"string","format":"date-time","description":"The timestamp indicating when the board structure revision was replaced, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStructureRevisionsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/structureRevisions\/{revision}":{"get":{"tags":["Board Structure Revisions"],"summary":"Get a specific revision of the board structure for the specified board","description":"Get a specific revision of the board structure for the specified board.","operationId":"getBoardStructureRevision","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardStructure"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardStructureRevisionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/revisionInPath"}]},"\/boards\/{board_id}\/tags":{"get":{"tags":["Board Tags"],"summary":"Get a list of the tags available on the specified board","description":"Get a list of the tags available on the specified board.","operationId":"getBoardTags","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of tags.","type":"array","items":{"title":"Board tag","type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The unique identifier of the tag."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardTagsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/tags\/{tag_id}":{"get":{"tags":["Board Tags"],"summary":"Check if a tag is available on the specified board","description":"Check if a tag is available on the specified board.","operationId":"checkBoardTag","responses":{"204":{"description":"The tag is available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Tags"],"summary":"Make a tag available on the specified board","description":"Make a tag available on the specifie board.","operationId":"addBoardTag","responses":{"204":{"description":"The tag is now available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Tags"],"summary":"Make a tag unavailable on a board","description":"Make a tag unavailable on a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the tag from the board and does **not** delete the actual tag.","operationId":"removeBoardTag","responses":{"204":{"description":"The tag is no longer available on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/boards\/{board_id}\/teams":{"get":{"tags":["Board Teams"],"summary":"Get a list of the teams assigned to a specified board","description":"Get a list of the teams assigned to a specified board. You can get a list of all teams by calling the [teams endpoint](#\/operations\/getTeams#Request).","operationId":"getBoardTeams","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of teams and their roles.","type":"array","items":{"title":"Board team","type":"object","properties":{"team_id":{"format":"int32","type":"integer","description":"The unique identifier of the team."},"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role assigned to the team on the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardTeamsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/teams\/{team_id}":{"get":{"tags":["Board Teams"],"summary":"Check if a team is assigned to the specified board","description":"Check if a team is assigned to the specified board.","operationId":"getBoardTeamRole","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A role id.","type":"array","items":{"type":"object","properties":{"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role assigned to the team on the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardTeamExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Teams"],"summary":"Assign or update a team's role for the specified board","description":"Assign or update a team's role for the specified board.","operationId":"addBoardTeam","requestBody":{"content":{"application\/json":{"schema":{"description":"Board role.","type":"object","required":["role_id"],"properties":{"role_id":{"description":"The unique identifier of the role assigned to the team on the board.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/BoardTeamRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Board team","type":"object","description":"Board team data.","properties":{"board_id":{"type":"integer","format":"int32","description":"The unique identifier of the board."},"team_id":{"type":"integer","format":"int32","description":"The unique identifier of the team."},"role_id":{"type":"integer","format":"int32","description":"The unique identifier of the role assigned to the team on the board."}}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardTeamCreateOrUpdateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Teams"],"summary":"Unassign a team from the specified board","description":"Unassign a team from the specified board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the team from the board and does **not** delete the actual team.","operationId":"removeBoardTeam","responses":{"204":{"description":"The team no longer has access to the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/boards\/{board_id}\/visibleStandardFields":{"get":{"tags":["Board Visible Standard Fields"],"summary":"Get a list of standard fields visible on the specified board","description":"Returns a list of standard fields that are visible for each card on the specified board. \r\nThese fields control what metadata is displayed directly on cards in the **UI**, such as:\r\n\r\n- **`last_modified`** \u2013 Shows the date and time the card was last updated.\r\n- **`in_current_position_since`** \u2013 Shows how long the card has been in its current position.\r\n- **`created_at`** \u2013 Displays when the card was originally created.\r\n- **`reporter`** \u2013 Shows the name of the user who created the card.\r\n\r\nAll standard visible fields are **disabled by default** and must be explicitly enabled per board via **PUT** request to the [visibleStandardFields\/{field_name} endpoint](\/operations\/addBoardStandardField#Request).\r\n","operationId":"getBoardVisibleStandardFields","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"},"last_modified":{"description":"Determines whether each card on the board shows the date and time when it was last modified in the **UI**.","format":"int32","type":"integer","enum":[0,1],"default":0},"in_current_position_since":{"description":"Determines whether each card on the board shows the date and time when it was moved to its current position in the **UI**.","format":"int32","type":"integer","enum":[0,1],"default":0},"created_at":{"description":"Determines whether each card on the board shows the date and time when it was created in the **UI**.","format":"int32","type":"integer","enum":[0,1],"default":0},"reporter":{"description":"Determines whether each card on the board shows the name of the user who created it in the **UI**.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"example":{"$ref":"#\/components\/responseExamples\/BoardVisibleStandardFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/visibleStandardFields\/{field_name}":{"get":{"tags":["Board Visible Standard Fields"],"summary":"Check if a standard field is visible on the specified board","description":"Check if a standard field is visible on the specified board.","operationId":"checkBoardStandardField","responses":{"204":{"description":"The standard field is visible on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Board Visible Standard Fields"],"summary":"Make a standard field visible on the specified board","description":"Make a standard field visible on the specified board.","operationId":"addBoardStandardField","responses":{"204":{"description":"The standard field is now visible on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Board Visible Standard Fields"],"summary":"Make a standard field no longer visible on the specified board","description":"Make a standard field no longer visible on the specified board.","operationId":"removeBoardStandardField","responses":{"204":{"description":"The standard field is no longer visible on the board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/fieldName"}]},"\/boards":{"get":{"tags":["Boards"],"summary":"Get a list of boards","description":"Retrieves a list of boards with their relevant details, optionally filtered using various parameters.\r\n\r\nThere are two types of boards:\r\n\r\n - **Team Kanban Board** - Allows your team to visualize, track, and manage their work in a single place. It helps keep the team aligned and organized while working on tasks and goals together.\r\n - **AI Canvas** - Integrates insights, tasks, and collaboration from multiple sources. It operates intelligently across connected boards or systems, enabling proactive project or product management with real-time, AI-driven guidance.","operationId":"getBoards","parameters":[{"name":"board_ids","in":"query","description":"Filters results to include only boards with matching IDs.","required":false,"example":"1,2","schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"workspace_ids","in":"query","description":"Filters results to include only boards belonging to the specified workspace IDs.","required":false,"example":"2,3","schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"is_archived","in":"query","description":"Set to `0` to retrieve only non-archived boards, or `1` to retrieve only archived boards.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"if_assigned","in":"query","description":"Set to `1` to retrieve only boards to which you are assigned.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["board_id","workspace_id","is_archived","name","description","type","revision"]}},"example":"board_id,workspace_id","explode":false},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["workflows","settings","structure","effective_cycle_time_column_ids","data_fields"]}},"example":"workflows,settings","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Board"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/BoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Boards"],"summary":"Create a board","description":"Create a new board.","operationId":"createBoard","requestBody":{"content":{"application\/json":{"schema":{"description":"Board data.","required":["workspace_id","name"],"type":"object","properties":{"workspace_id":{"description":"The ID of the workspace to which the board belongs.","format":"int32","type":"integer"},"name":{"description":"The name of the board.","type":"string","minLength":1,"maxLength":100},"description":{"description":"The description of the board.","type":"string"},"type":{"format":"int32","type":"integer","description":"The type of the board. A value of `1` indicates a **Kanban board**, while a value of `2` indicates an **AI Canvas**.","enum":[1,2],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/BoardCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"},"main_maestro_instance_id":{"description":"The unique identifier of the primary Whiteboard for the board. Applicable **only** to **AI Canvas** boards and automatically generated upon their creation.","format":"int32","type":"integer","default":null}}},{"$ref":"#\/components\/schemas\/Board"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardCreateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}":{"get":{"tags":["Boards"],"summary":"Get the details of a single board","description":"Get the details of a single board.\n\n\n> #### Info\n>\n> You can use the [GET \/boards](#\/operations\/getBoards) endpoint with the `board_ids` query parameter to retrieve multiple boards in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getBoard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Board"}}},"example":{"$ref":"#\/components\/responseExamples\/BoardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Boards"],"summary":"Update a board","description":"Update a board.","operationId":"updateBoard","requestBody":{"content":{"application\/json":{"schema":{"description":"Board data.","type":"object","properties":{"name":{"description":"The name of the board.","type":"string","minLength":1,"maxLength":100},"description":{"description":"The description of the board.","type":"string"},"is_archived":{"description":"Controls whether the board is archived.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"$ref":"#\/components\/requestExamples\/BoardUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"main_maestro_instance_id":{"description":"The unique identifier of the primary Whiteboard for the board. Applicable **only** to **AI Canvas** boards and automatically generated upon their creation.","format":"int32","type":"integer","default":null}}},{"$ref":"#\/components\/schemas\/Board"}]}}},"example":{"$ref":"#\/components\/responseExamples\/BoardUpdateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Boards"],"summary":"Delete a board","description":"Delete a board.","operationId":"deleteBoard","responses":{"204":{"description":"The board has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/businessRules\/activeRulesLimit":{"get":{"tags":["Business Rules Active Rules Limit"],"summary":"Get the active rules limit for the business rules","description":"Get the active rules limit for business rules in the current Businessmap account, based on your subscription plan.","operationId":"getBusinessRulesActiveRulesLimit","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The active rules limit for the business rules.","type":"integer","format":"int32"}}},"example":{"$ref":"#\/components\/responseExamples\/BusinessRulesActiveRulesLimitExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/businessRules\/executionHistory":{"get":{"tags":["Business Rule Execution History"],"summary":"Get a list of business rule executions","description":"Retrieves a list of past business rule executions along with their relevant details.\nThis endpoint allows you to review the execution history of business rules and can be customized using various filtering options.\n","operationId":"getBusinessRulesExecutionHistory","parameters":[{"name":"business_rule_ids","in":"query","description":"A list of business rule IDs to filter the execution history and retrieve executions only for the specified rules.","required":false,"schema":{"items":{"format":"int32","type":"integer"},"example":"2,3"},"explode":false},{"name":"executed_on_card_ids","in":"query","description":"A list of card IDs to filter the execution history and return only executions where these cards were the targets of the business rule.","required":false,"schema":{"items":{"format":"int32","type":"integer"},"example":"10,11"},"explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"description":"A list of business rule execution history events.","type":"array","items":{"$ref":"#\/components\/schemas\/BusinessRulesExecutionHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/BusinessRulesExecutionHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/calculatedOutcomeValueRules\/activeRulesLimit":{"get":{"tags":["Calculated Outcome Value Rules Active Rules Limit"],"summary":"Get the active rules limit for the calculated outcome value rules","description":"Get the active rules limit for calculated outcome value rules in the current Businessmap account.","operationId":"getCalculatedOutcomeValueRulesActiveRulesLimit","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The active rules limit for the calculated outcome value rules.","type":"integer","format":"int32"}}},"example":{"$ref":"#\/components\/responseExamples\/CalculatedOutcomeValueRulesActiveRulesLimitExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/calculatedOutcomeValueRules\/executionHistory":{"get":{"tags":["Calculated Outcome Value Rules Execution History"],"summary":"Get a list of calculated outcome value rule executions","description":"Retrieves a list of past calculated outcome value rule executions and their details.\nThis endpoint lets you review the execution history of calculated outcome value rules and supports various filtering options.\n","operationId":"getCalculatedOutcomeValueRulesExecutionHistory","parameters":[{"name":"rule_ids","in":"query","description":"A list of rule IDs to filter the execution history and return only executions for the specified calculated outcome value rules.","required":false,"schema":{"items":{"format":"int32","type":"integer"},"example":"1,2"},"explode":false},{"name":"card_ids","in":"query","description":"A list of card IDs to filter the execution history and return only executions where a calculated outcome value, generated by rules, is used in the specified cards.","required":false,"schema":{"items":{"format":"int32","type":"integer"},"example":"10,11"},"explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"description":"A list of calculated outcome value rules execution history events.","type":"array","items":{"$ref":"#\/components\/schemas\/CalculatedOutcomeValueRulesExecutionHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/CalculatedOutcomeValueRulesExecutionHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/{card_id}\/attachments":{"get":{"tags":["Card Attachments"],"summary":"Get a list of a card's attachments","description":"Retrieve a list of all attachments associated with a specific card.\n\nThere is an account-wide setting that controls whether attachments are enabled or disabled for all users. This setting also allows administrators to specify the maximum allowed file size for attachments, which can be set to any value between 1 MB and 30 MB.\n\nThe status of this setting can also be checked or modified programmatically via the [getCompanySetting endpoint](#\/operations\/getCompanySetting) and providing the parameter `features.card_attachments.disabled` or `features.card_attachments.max_size`.\n","operationId":"getCardAttachments","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Attachments"],"summary":"Add an attachment to a card","description":"Add a file as an attachment to a card.","operationId":"addCardAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardAttachmentCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/attachments\/{attachment_id}":{"get":{"tags":["Card Attachments"],"summary":"Get the details of an attachment for a card","description":"Get the details of a specific attachment for a card.","operationId":"getCardAttachment","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Attachments"],"summary":"Update the details of an attachment for a card","description":"Update the details of a specific attachment for a card.","operationId":"updateCardAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardAttachmentUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardAttachmentUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Attachments"],"summary":"Delete an attachment from a card","description":"Delete a specific attachment from a card.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the attachment unavailable on the specified card and does **not** delete the actual file which may be referenced by other cards at a later time.","operationId":"deleteCardAttachment","responses":{"204":{"description":"The card attachment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/attachmentIdInPath"}]},"\/cards\/{card_id}\/blockReason":{"get":{"tags":["Card Block Reason"],"summary":"Get the block reason for a specific card","description":"Check whether a specific card is currently blocked and, if so, the reason for the block.","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardBlockReason"}}},"example":{"$ref":"#\/components\/responseExamples\/CardBlockReasonGetExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Block Reason"],"summary":"Block a card","description":"\"Block a card, or update its block reason or comment if it is already blocked.\n\nYou can get all block reasons by calling the [blockReasons](#\/operations\/getBlockReasons#Request) endpoint.\n\nYou can get the block reasons for a specific board by calling the [board blockReasons](#\/operations\/getBoardBlockReasons#Request) endpoint.\"\n","operationId":"setCardBlockReason","requestBody":{"content":{"application\/json":{"schema":{"description":"Block card data.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/CardGenericBlockReason"},{"$ref":"#\/components\/schemas\/CardUserDefinedBlockReason"}]}},"example":{"$ref":"#\/components\/requestExamples\/CardBlockReasonSetExample"}}}},"responses":{"204":{"description":"The card has been successfully blocked using the specified parameters."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Block Reason"],"summary":"Unblock a card","description":"Unblock a card.","operationId":"unblockCard","responses":{"204":{"description":"The card is now unblocked."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/columnChecklistItems":{"get":{"tags":["Card Column Checklist Items"],"summary":"Get a list of checked column checklist items for a card","description":"Retrieves all checklist items (i.e. exit criteria) that have been marked as completed (checked) for a specific card, across all columns.","operationId":"getCardColumnChecklistItems","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of checked column checklist items.","type":"array","items":{"$ref":"#\/components\/schemas\/CardColumnChecklistItem"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardColumnChecklistItemsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/columnChecklistItems\/{item_id}":{"get":{"tags":["Card Column Checklist Items"],"summary":"Get the details of a checked column checklist item for a card","description":"Get the details of a specific checked column checklist item (i.e. exit criterion) for a card.","operationId":"getCardColumnChecklistItem","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardColumnChecklistItem"}}},"example":{"$ref":"#\/components\/responseExamples\/CardColumnChecklistItemExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Column Checklist Items"],"summary":"Check a column checklist item for a card","description":"Mark a column checklist item as completed for a card.","operationId":"checkCardColumnChecklistItem","requestBody":{"content":{"application\/json":{"schema":{"description":"An optional comment about the checklist item.","type":"object","properties":{"comment":{"description":"A comment about the checklist item.","type":"string","maxLength":65000}}},"example":{"$ref":"#\/components\/requestExamples\/CardColumnChecklistItemCheckRequestExample"}}}},"responses":{"204":{"description":"The column checklist item has been marked as completed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Column Checklist Items"],"summary":"Uncheck a column checklist item for a card","description":"Mark a column checklist item as not completed for a card.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action does **not** delete the checklist item (i.e. exit criterion), it only marks it as unchecked for the current card. The checklist item will still be available in the list of column checklist items for the card.","operationId":"uncheckCardColumnChecklistItem","responses":{"204":{"description":"The column checklist item has been marked as not completed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/checklistItemIdInPath"}]},"\/cards\/{card_id}\/comments\/{comment_id}\/attachments":{"get":{"tags":["Card Comment Attachments"],"summary":"Get a card comment's attachments","description":"Retrieve all attachments associated with a specific comment on a card.","operationId":"getCardCommentAttachments","responses":{"200":{"description":"The list of attachments for the specified card comment.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardCommentAttachmentWithId"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentAttachmentsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Comment Attachments"],"summary":"Add an attachment to a card comment.","description":"Add an attachment to a card comment.\n\nYou can get a list of all of the card's attachments by calling the [card attachments endpoint](#\/operations\/getCardAttachments#Request).\n","operationId":"addCardCommentAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CommentAttachmentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CommentAttachmentCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardCommentAttachmentWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentAttachmentIDExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/commentIdInPath"}]},"\/cards\/{card_id}\/comments\/{comment_id}\/attachments\/{attachment_id}":{"get":{"tags":["Card Comment Attachments"],"summary":"Get the details of a specific attachment for a card comment","description":"Retrieves detailed information about a specific attachment associated with a comment on a card.","operationId":"getCardCommentAttachment","responses":{"200":{"description":"The details of the specified attachment have been successfully retrieved.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardCommentAttachment"}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Comment Attachments"],"summary":"Delete an attachment for a card comment","description":"Delete a specific attachment for a card comment.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the attachment unavailable on the specified card comment and does **not** delete the actual file which may be referenced by other cards and card comments at a later time.","operationId":"deleteCardCommentAttachment","responses":{"204":{"description":"The card comment attachment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/commentIdInPath"},{"$ref":"#\/components\/parameters\/attachmentIdInPath"}]},"\/cards\/{card_id}\/comments":{"get":{"tags":["Card Comments"],"summary":"Get a card's comments","description":"Get a list of all comments associated with a specific card.","operationId":"getCardComments","responses":{"200":{"description":"The list of comments for the specified card has been successfully retrieved.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardComment"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Comments"],"summary":"Add a comment to a card.","description":"Create a new comment to a specific card.\nOnly comments of type `plain` can be created using the API.\n","operationId":"addCardComment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CommentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCommentCreatedRequestExample"}}}},"responses":{"200":{"description":"The comment has been successfully added to the specified card.\nThe response includes the details of the newly created comment.\n","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/CardCommentCreatedResponse"},{"$ref":"#\/components\/schemas\/CardCommentAuthor"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentCreatedResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/comments\/{comment_id}":{"get":{"tags":["Card Comments"],"summary":"Get the details of a comment for a card","description":"Retrieves detailed information about a specific comment associated with a card.","operationId":"getCardComment","responses":{"200":{"description":"The details of the specified comment have been successfully retrieved.\n","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/CardCommentDataCommon"},{"$ref":"#\/components\/schemas\/CardCommentDataAuthorOrSenderAndRecipient"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentIDResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Comments"],"summary":"Update the details of a comment on a card","description":"Updates the details of a specific comment associated with a card.\nOnly comments of type `plain` can be updated using the API.\n","operationId":"updateCardComment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CommentUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCommentUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/CardCommentDataCommon"},{"$ref":"#\/components\/schemas\/CardCommentAuthor"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentIDResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Comments"],"summary":"Delete a comment from a card","description":"Delete a specific comment associated with a card.","operationId":"deleteCardComment","responses":{"204":{"description":"The card comment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/commentIdInPath"}]},"\/cards\/{card_id}\/coverImage":{"get":{"tags":["Card Cover Image"],"summary":"Get the details of the card's cover image","description":"Retrieve information about a card's cover image.","operationId":"getCardCoverImage","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CoverImage"}}},"example":{"$ref":"#\/components\/responseExamples\/CardCoverImageExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}],"put":{"tags":["Card Cover Image"],"summary":"Set the card's cover image","description":"Set an attached image file as the card's cover image.\n\nOnly users with both \u201cEdit card details\u201d and \u201cCard attachments\u201d permissions can make and remove card covers.\n\nOnly attached image files in the formats **jpg**, **jpeg**, **png**, and **webp** can be set as cover images. Additionally, the attachment for the cover image cannot be uploaded from Google Drive and One Drive.\n\nThe maximum width and height for covers is 210x210 pixels. If the uploaded image is larger than that, the system will crop it to that size.\n","operationId":"setCardCoverImage","requestBody":{"content":{"application\/json":{"schema":{"description":"The link of the cover image","type":"object","properties":{"cover_image_link":{"description":"The link to the attached image file to be used as a cover image. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","example":"\/files\/abc123xyz","type":"string","minLength":1}}},"example":{"$ref":"#\/components\/requestExamples\/CardCoverImageSetRequestExample"}}}},"responses":{"204":{"description":"The cover image has been set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Cover Image"],"summary":"Remove the card's cover image","description":"Remove the cover image previously set for the card.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action does **not** delete the image file, it only unsets it as a cover image for the current card. The file remains as an attachment on the card.","operationId":"removeCardCoverImage","responses":{"204":{"description":"The card's cover image has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/{card_id}\/coOwners":{"get":{"tags":["Card Co Owners"],"summary":"Get a card's co-owners","description":"Retrieve a list of a card's co-owners.","operationId":"getCardCoOwners","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card co-owners.","type":"array","items":{"title":"Card co-owner","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of a user who is a co-owner of the card."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCoOwnersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/coOwners\/{user_id}":{"get":{"tags":["Card Co Owners"],"summary":"Check if a user is a co-owner of a card","description":"Check if a user is assigned as a co-owner of a card.","operationId":"checkCardCoOwner","responses":{"204":{"description":"The user is a co-owner of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Co Owners"],"summary":"Add a user as a co-owner of a card","description":"Assign a user as a co-owner of a card.","operationId":"addCardCoOwner","responses":{"204":{"description":"The user is now a co-owner of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Co Owners"],"summary":"Remove a user as a co-owner of a card","description":"Remove a user as a co-owner of a card.","operationId":"removeCardCoOwner","responses":{"204":{"description":"The user is no longer a co-owner of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/contributors":{"get":{"tags":["Card Custom Field Contributors"],"summary":"Get a list of the contributors for a custom field of type contributor on a card","description":"Retrieve a list of the contributors assigned to a custom field of type contributor that has been added to a specific card.","operationId":"getCardCustomFieldContributors","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of contributors.","type":"array","items":{"title":"Contributor","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of a user who is a contributor for the custom field of the card."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldContributorsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/contributors\/{user_id}":{"get":{"tags":["Card Custom Field Contributors"],"summary":"Check if a user is a contributor for a custom field of type contributor added to a card","description":"Check if a user is assigned as a contributor to a custom field of type contributor that has been added to a card.","operationId":"checkCardCustomFieldContributor","responses":{"204":{"description":"The user is a contributor for the custom field of type contibutor on the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Custom Field Contributors"],"summary":"Add a user as a contributor for a custom field of type contributor added to a card","description":"Assign a user as a contributor for a custom field of type contributor that has been added to a card.","operationId":"addCardCustomFieldContributor","responses":{"204":{"description":"The user is now a contributor for the custom field of type contributor on the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Field Contributors"],"summary":"Remove a user as a contributor from a custom field of type contributor added to a card","description":"Remove a user as a contributor from a custom field of type contributor that has been added to a card.","operationId":"removeCardCustomFieldContributor","responses":{"204":{"description":"The user is no longer a contributor for the custom field of type contributor on the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/files":{"get":{"tags":["Card Custom Field Files"],"summary":"Get a list of files for a custom field of type file added to a card","description":"Retrieve a list of files uploaded to a custom field of type file that has been added to a specific card.","operationId":"getCardCustomFieldFiles","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of files.","type":"array","items":{"allOf":[{"type":"object","properties":{"id":{"description":"The ID of the file.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardCustomFieldFile"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldFilesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Custom Field Files"],"summary":"Add a file to a custom field of type file on a card","description":"Add a file to a custom field of type file that has been added to a card.","operationId":"addCardCustomFieldFile","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardCustomFieldFileCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldFileUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"id":{"description":"The ID of the file.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardCustomFieldFile"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldFileCreatedExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/files\/{id}":{"get":{"tags":["Card Custom Field Files"],"summary":"Get the details of a single file from a custom field of type file on a card","description":"Get the details of a specific file from a custom field of type file that has been added to a card.","operationId":"getCardCustomFieldFile","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardCustomFieldFile"}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Custom Field Files"],"summary":"Update a file from a custom field of type file on a card","description":"Update a specific file from a custom field of type file that has been added to a card.","operationId":"updateCardCustomFieldFile","requestBody":{"content":{"application\/json":{"schema":{"description":"Card custom field file data.","type":"object","properties":{"file_name":{"description":"The name of the file.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link to the file. This link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","example":"\/files\/abc123xyz","type":"string"},"position":{"description":"The postition of the file in the list of files for the custom field. `0` represents the top-most position.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldFileUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardCustomFieldFile"}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldFileExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Field Files"],"summary":"Delete a file from a custom field of type file on a card","description":"Delete a specific file from a custom field of type file that has been added to a card.","operationId":"deleteCardCustomFieldFile","responses":{"204":{"description":"The file has been deleted from the custom field of type file."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"name":"id","in":"path","description":"A file id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/customFields\/{field_id}\/selectedCards":{"get":{"tags":["Card Custom Field Selected Cards"],"summary":"Get a list of the selected cards for a custom field of type card picker for a card","description":"Retrieves a list of cards selected for a custom field of type `card picker` associated with a specific card.\n","operationId":"getCardCustomFieldSelectedCards","responses":{"200":{"description":"Successfully retrieved the list of selected cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of selected cards for the specified custom field of type `card picker`.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldSelectedCard"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/selectedCards\/{selected_card_id}":{"get":{"tags":["Card Custom Field Selected Cards"],"summary":"Get the details of a selected card for a custom field of a card","description":"Retrieve the position of a specific card selected for a custom field of type `card picker` associated with a given card.\n","operationId":"getCardCustomFieldSelectedCard","responses":{"200":{"description":"Successfully retrieved the details of the selected card.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the selected card.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the selected card within the list of selected cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Custom Field Selected Cards"],"summary":"Add or update a selected card for a custom field of a card","description":"Modify the position of a card selected for a custom field of type `card picker` associated with a specific card.\n","operationId":"addOrUpdateCardCustomFieldSelectedCards","requestBody":{"content":{"application\/json":{"schema":{"description":"Card custom field selected card data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the card within the list of selected cards. `0` represents the top-most position."}}},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldSelectedCardAddOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the selected card.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the selected card within the list of selected cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedCardExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Field Selected Cards"],"summary":"Remove a selected card for a custom field of a card","description":"Remove a selected card for a custom field of type `card picker` associated with a specific card.","operationId":"removeCardCustomFieldSelectedCards","responses":{"204":{"description":"The selected card has been removed from the custom field of type `card picker`."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/selectedCardIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/selectedValues":{"get":{"tags":["Card Custom Field Selected Values"],"summary":"Get a list of the selected values for a custom field of type dropdown for a card","description":"Retrieve the list of values selected for a custom field of type `dropdown` associated with a specific card.","operationId":"getCardCustomFieldSelectedValues","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of selected values for the specified custom field of type `dropdown`.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldSelectedValue"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedValuesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/selectedValues\/{value_id}":{"get":{"tags":["Card Custom Field Selected Values"],"summary":"Get the details of a selected value for a custom field of type dropdown for a card","description":"Retrieve the position of a specific value selected for a custom field of type `dropdown` associated with a given card.","operationId":"getCardCustomFieldSelectedValue","responses":{"200":{"description":"Successfully retrieved the position of the selected dropdown value.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the selected value.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of selected values. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Custom Field Selected Values"],"summary":"Update the position of a selected dropdown value for a card's custom field","description":"Modify the position of a selected value in a custom field of type `dropdown` associated with a specific card.","operationId":"addOrUpdateCardCustomFieldSelectedValues","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardCustomFieldSelectedValueAddOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldSelectedValueAddOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the value within the list of selected values.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of selected values. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedValueExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Field Selected Values"],"summary":"Delete a selected dropdown value from a card's custom field","description":"Remove a specific value from the list of selected values in a custom field of type `dropdown` associated with a given card.","operationId":"removeCardCustomFieldSelectedValues","responses":{"204":{"description":"The selected value has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/valueIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/votes":{"get":{"tags":["Card Custom Field Votes"],"summary":"Get a list of the votes for a custom field of type vote on a card","description":"Retrieve a list of the votes for a custom field of type vote that has been added to a card.","operationId":"getCardCustomFieldVotes","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of votes.","type":"array","items":{"title":"Card Custom Field - Votes","type":"object","properties":{"vote":{"type":"integer","format":"int32","enum":[0,1],"description":"The user's vote for the custom field of type vote. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote."},"comment":{"type":"string","description":"A comment left by the user when casting the vote."},"user_id":{"type":"integer","format":"int32","description":"The ID of the user who cast the vote."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldVotesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}\/votes\/my":{"get":{"tags":["Card Custom Field Votes"],"summary":"Get your vote for a custom field of of type vote on a card","description":"Get the value of the vote submitted by the authenticated user to a custom field of type vote that has been added to a card.","operationId":"getMyCardCustomFieldVote","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Card Custom Field - Vote","description":"A vote.","type":"object","properties":{"vote":{"format":"int32","type":"integer","enum":[0,1],"description":"The authenticated user's vote for the custom field of type vote. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote."},"comment":{"type":"string","description":"A comment left by the user when casting the vote."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldVoteExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Custom Field Votes"],"summary":"Set your vote for a custom field of type vote on a card","description":"Cast a vote for a custom field of type vote that has been added to a card.","operationId":"setMyCardCustomFieldVote","requestBody":{"content":{"application\/json":{"schema":{"description":"Card custom field vote data.","type":"object","properties":{"vote":{"description":"The vote of the authenticated user. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote.","format":"int32","type":"integer","enum":[0,1]},"comment":{"description":"A comment left by the user when casting the vote.","type":"string"}}},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldVoteSetRequestExample"}}}},"responses":{"204":{"description":"The user's vote has been cast."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Custom Field Votes"],"summary":"Update your vote for a custom field of type vote on a card","description":"Update your vote for a custom field of type vote that has been added to a card.","operationId":"updateMyCardCustomFieldVote","requestBody":{"content":{"application\/json":{"schema":{"description":"Card custom field vote data.","type":"object","properties":{"vote":{"description":"The vote of the authenticated user. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote.","format":"int32","type":"integer","enum":[0,1]},"comment":{"description":"A comment left by the user when casting the vote.","type":"string"}}},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldVoteSetRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"Card custom field vote data.","type":"object","properties":{"data":{"description":"A vote.","type":"object","title":"Card Custom Field - Vote","properties":{"vote":{"description":"The authenticated user's vote for the custom field of type vote. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote.","format":"int32","type":"integer","enum":[0,1]},"comment":{"description":"A comment left by the user when casting the vote.","type":"string"}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldVoteExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Field Votes"],"summary":"Delete your vote for a custom field of type vote on a card","description":"Remove your vote for a custom field of type vote that has been added to a card.","operationId":"deleteMyCardCustomFieldVote","responses":{"204":{"description":"Your vote for the custom field of the card was deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/customFields":{"get":{"tags":["Card Custom Fields"],"summary":"Get a list of card custom field values","description":"Retrieve a list of the custom fields added to a specific card along with their associated values.","operationId":"getCardCustomFields","responses":{"200":{"description":"Successfully retrieved the list of custom fields and their values.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of custom fields and their values associated with the card.","type":"array","items":{"type":"object","allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedDateWithFieldId"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/customFields\/{field_id}":{"get":{"tags":["Card Custom Fields"],"summary":"Get the details of a custom field of a card if the field is added","description":"Retrieve the details of a specific custom field associated with a card, if the field has been added to it.","operationId":"getCardCustomField","responses":{"200":{"description":"Successfully retrieved the details of the custom field.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPicker"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedDateWithFieldId"}],"description":"The details of the custom field."}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Custom Fields"],"summary":"Add or update a custom field on a card","description":"Add a new custom field to a card or update the specified custom field if it is already added to the card.\n\nYou can get a list of all custom fields added to a card by calling the [customFields endpoint](#\/operations\/getCardCustomFields).\n","operationId":"addCardCustomField","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardCustomFieldAddOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldAddRequestExample"}}}},"responses":{"200":{"description":"Successfully added or updated the custom field.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The details of the custom field, including its type and associated data.","oneOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedDateWithFieldId"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldExample"}}}},"204":{"description":"The custom field was successfully added or updated, but you do not have the permissions required to view the results."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Custom Fields"],"summary":"Remove a custom field from a card","description":"Remove a custom field from a card.","operationId":"removeCardCustomField","responses":{"204":{"description":"The custom field was removed from the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cards\/{card_id}\/linkedCards":{"get":{"tags":["Card Linked Cards"],"summary":"Get a list of a card's linked cards","description":"Retrieve a list of the cards that are linked to a given card ordered by position.","operationId":"getLinkedCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of linked cards.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkedCardWithType"}}}},"example":{"$ref":"#\/components\/responseExamples\/LinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/milestones":{"get":{"tags":["Card Milestones"],"summary":"Get a list of a card's milestones","description":"Get a list of the milestones added to a card.","operationId":"getCardMilestones","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of milestones.","type":"array","items":{"title":"List of milestones","type":"object","properties":{"milestone_id":{"format":"int32","type":"integer","description":"The ID of the milestone."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardMilestonesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/milestones\/{milestone_id}":{"get":{"tags":["Card Milestones"],"summary":"Check if a milestone is added to a card","description":"Check if a specific milestone is added to a card.","operationId":"checkCardMilestone","responses":{"204":{"description":"The milestone is added to the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Milestones"],"summary":"Add a milestone to a card","description":"Make a milestone available on a card.","operationId":"addCardMilestone","responses":{"204":{"description":"The milestone is now available on the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Milestones"],"summary":"Remove a milestone from a card","description":"Remove a milestone from a card.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the milestone unavailable on the specified card and does **not** actually delete the milestone itself.","operationId":"removeCardMilestone","responses":{"204":{"description":"The milestone is now removed from the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/cards\/{card_id}\/cardOutcomes":{"get":{"tags":["Card Outcomes"],"summary":"Get a list of outcomes linked to a card","description":"Retrieve a list of outcomes linked to a card, ordered by position. Each item includes outcome_id and position.","operationId":"getCardOutcomes","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card outcomes (outcome_id and position).","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeListItem"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/cardOutcomes\/{outcome_id}":{"get":{"tags":["Card Outcomes"],"summary":"Get a card outcome by outcome ID","description":"Retrieve the position of a specific outcome linked to a card.","operationId":"getCardOutcome","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomePositionResponse"}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomePositionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Outcomes"],"summary":"Update a card outcome position","description":"Add a new outcome to a card or update the position of an existing outcome linked to a card.","operationId":"updateCardOutcome","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardOutcomePositionSetRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardOutcomePositionSetRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomePositionResponse"}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomePositionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Outcomes"],"summary":"Remove an outcome from a card","description":"Remove an outcome from a card. The outcome definition is not deleted; it is only unlinked from the card.","operationId":"deleteCardOutcome","responses":{"204":{"description":"The outcome has been removed from the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/outcomeIdInPath"}]},"\/cards\/{card_id}\/parents":{"get":{"tags":["Card Parent Cards"],"summary":"Get a list of parent cards","description":"Retrieve a list of the parent cards of a given card.","operationId":"getParentCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of parent cards.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the parent card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/parents\/{parent_card_id}":{"get":{"tags":["Card Parent Cards"],"summary":"Check if a card is a parent of a given card","description":"Check if a card is a parent of a given card and get its position in the child card's list of linked cards.","operationId":"checkParentCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Parent Cards"],"summary":"Make a card a parent of a given card","description":"Establishes a parent-child relationship between two cards by designating one card as the parent of a specified card. This operation also allows specifying the positions of the cards in each other's list of linked cards.","operationId":"addParentCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Link data.","type":"object","properties":{"linked_card_position":{"description":"The position of the parent card within the child's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the child card within the parent's list of linked cards.","format":"int32","type":"integer"},"exceeding_reason":{"description":"The reason for exceeding the specified limit.","type":"string","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/CardParentCardCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the parent card within the child's list of linked cards."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Parent Cards"],"summary":"Remove the link between a child card and a parent card","description":"Remove the parent-child link between two cards, effectively making them independent of each other.","operationId":"removeParentCard","parameters":[{"name":"exceeding_reason","in":"query","description":"The reason for exceeding the specified limit. This query parameter can be appended to the request URL to filter cards with a specific exceeding reason.","example":"?exceeding_reason=Reason","required":false,"schema":{"type":"string","nullable":true}}],"responses":{"204":{"description":"The two cards are no longer a child and a parent."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"parent_card_id","in":"path","description":"A parent card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/parentGraph":{"get":{"tags":["Card Parent Cards"],"summary":"Get a list of parent cards including their parent cards too","description":"Retrieves not only the immediate parent cards of a specified card, but also the parent cards of those parent cards-effectively providing a complete hierarchy up to the \"grandparent\" level.","operationId":"getParentCardGraph","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of child cards.","type":"array","items":{"$ref":"#\/components\/schemas\/ParentChildLink"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardParentGraphExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/relatives":{"get":{"tags":["Card Relative Cards"],"summary":"Get a list of a card's related cards","description":"Retrieve a list of the relative cards associated with a given card.","operationId":"getRelatedCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of related cards.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the related card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/predecessors":{"get":{"tags":["Card Predecessor Cards"],"summary":"Get a list of predecessor cards","description":"Retrieve a list of cards that are predecessors to the specified card. Predecessor cards are linked cards that must be completed before the given card can proceed.","operationId":"getPredecessorCards","responses":{"200":{"description":"Successfully retrieved the list of predecessor cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of predecessor cards associated with the specified card.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the predecessor card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/predecessors\/{predecessor_card_id}":{"get":{"tags":["Card Predecessor Cards"],"summary":"Check if a card is a predecessor of a given card","description":"Determine whether a card is a predecessor of the specified card and retrieve its position in the successor's list of linked cards.","operationId":"checkPredecessorCard","responses":{"200":{"description":"Successfully verified the predecessor relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Predecessor Cards"],"summary":"Establish or update the predecessor relationship between two cards","description":"Create or update a predecessor-successor relationship between two cards by designating one card as the predecessor of the specified card. If the cards are already linked, this operation allows updating their positions in each other's list of linked cards.","operationId":"addPredecessorCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to establish or update the predecessor relationship between two cards.","type":"object","properties":{"linked_card_position":{"description":"The position of the predecessor card within the successor's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the successor card within the predecessor's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/CardLinkCardCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the predecessor card within the successor's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the predecessor card within the successor's list of linked cards."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Predecessor Cards"],"summary":"Delete the link between a successor card and a predecessor card","description":"Delete the link between a successor card and a predecessor card, effectively removing the predecessor-successor relationship between them.","operationId":"removePredecessorCard","responses":{"204":{"description":"The predecessor-successor relationship between the two cards has been successfully deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"predecessor_card_id","in":"path","description":"A predecessor card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/predecessorGraph":{"get":{"tags":["Card Predecessor Cards"],"summary":"Get a list of all predecessor cards linked to a specified card, including predecessors of its predecessors","description":"Get the full list of predecessor cards for a given card, including the predecessor cards of those predecessor cards.\nThis endpoint provides a hierarchical view of all linked predecessor cards.\n","operationId":"getPredecessorCardGraph","responses":{"200":{"description":"Successfully retrieved the graph of predecessor cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of predecessor cards, including their linked predecessor cards.","type":"array","items":{"$ref":"#\/components\/schemas\/PredecessorSuccessorLink"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardPredecessorGraphExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/relatives\/{related_card_id}":{"get":{"tags":["Card Relative Cards"],"summary":"Check if a card is a relative of a given card","description":"Check if a card is a relative of a given card and get its position in that card's list of linked cards.","operationId":"checkRelatedCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Relative Cards"],"summary":"Make a card a relative of a given card","description":"Establishes a relationship between two cards by designating one card as a relative of the specified card. This operation also allows specifying the positions of the cards in each other's list of linked cards.","operationId":"addRelatedCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Link data.","type":"object","properties":{"linked_card_position":{"description":"The position of the related card within the card's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the card within the related card's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/CardLinkCardCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the related card within the card's list of linked cards."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Relative Cards"],"summary":"Remove the link between a card and a related card","description":"Remove the link between two related cards, effectively making them independent of each other.","operationId":"removeRelatedCard","responses":{"204":{"description":"The two cards are no longer related."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"related_card_id","in":"path","description":"A related card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/revisions":{"get":{"tags":["Card Revisions"],"summary":"Get a list of revisions of the card","description":"Retrieve a list of all revisions made to the specified card, including the date and time each revision was replaced.","operationId":"getCardRevisions","responses":{"200":{"description":"Successfully retrieved the list of card revisions.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Contains the list of revisions for the specified card.","type":"array","items":{"type":"object","properties":{"revision":{"format":"int32","type":"integer","description":"The ID of the revision."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who made the revision."},"replaced_at":{"format":"date-time","type":"string","description":"The timestamp indicating when the revision was replaced."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardRevisionsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/revisions\/{revision}":{"get":{"tags":["Card Revisions"],"summary":"Get a specific revision of a card","description":"Retrieve the details of a specific revision for a card","operationId":"getCardRevision","responses":{"200":{"description":"Successfully retrieved the details of the specified card revision.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CardRevisionCard"},{"$ref":"#\/components\/schemas\/CardRevisionInitiative"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardRevisionExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/revisionInPath"}]},"\/cards\/{card_id}\/stickers":{"get":{"tags":["Card Stickers"],"summary":"Get a list of card stickers","description":"Get a list of the stickers added to a card. The stickers are listed in the order in which they were added. You can get a list of all stickers available on the board where the card is located by calling the [boardStickers endpoint](#\/operations\/getBoardStickers#Request).","operationId":"getCardStickers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card stickers.","type":"array","items":{"$ref":"#\/components\/schemas\/CardSticker"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardStickersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Stickers"],"summary":"Add a sticker to a card","description":"Add a sticker to a card. A single sticker can be added **multiple** times by default. If you want to prevent adding a sticker that has already been added to the card, set the `if_not_present` parameter to `1`. In this case, if the sticker has already been added to the card, a `409` response will be sent.","operationId":"addCardSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"Sticker data.","required":["sticker_id"],"type":"object","properties":{"sticker_id":{"description":"The ID of the sticker to add to the card.","format":"int32","type":"integer"},"if_not_present":{"description":"If set to `1` and the sticker has already been added to the card, it will not be added again. In this case a `409` response will be sent.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"example":{"$ref":"#\/components\/requestExamples\/CardStickerCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardSticker"}}},"example":{"$ref":"#\/components\/responseExamples\/CardStickerExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/stickers\/{id}":{"delete":{"tags":["Card Stickers"],"summary":"Remove a sticker from a card","description":"Remove a sticker from a card.","operationId":"removeCardSticker","responses":{"204":{"description":"The sticker has now been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"id","in":"path","description":"The unique identifier of the sticker added to the card.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/subtasks\/{subtask_id}\/attachments":{"get":{"tags":["Card Subtask Attachments"],"summary":"Get the attachments of a card subtask","description":"Get the attachments of a card subtask.","operationId":"getCardSubtaskAttachments","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskAttachmentsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Subtask Attachments"],"summary":"Add an attachment to a card subtask","description":"Add an attachment to a card subtask.","operationId":"addCarSubtaskAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardSubtaskAttachmentCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"}]},"\/cards\/{card_id}\/subtasks\/{subtask_id}\/attachments\/{attachment_id}":{"get":{"tags":["Card Subtask Attachments"],"summary":"Get the details of an attachment for a card subtask","description":"Get the details of an attachment for a card subtask.","operationId":"getCardSubtaskAttachment","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Subtask Attachments"],"summary":"Update the details of an attachment for a card subtask","description":"Update the details of an attachment for a card subtask.","operationId":"updateCardSubtaskAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardAttachmentUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardSubtaskAttachmentUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Subtask Attachments"],"summary":"Delete an attachment for a card subtask","description":"Delete a specific attachment from a card subtask.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the attachment unavailable on the specified card subtask and does **not** delete the actual file which may be referenced by other cards or card subtasks at a later time.","operationId":"deleteCardSubtaskAttachment","responses":{"204":{"description":"The card subtask attachment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"},{"$ref":"#\/components\/parameters\/attachmentIdInPath"}]},"\/cards\/{card_id}\/subtasks":{"get":{"tags":["Card Subtasks"],"summary":"Get a card's subtasks","description":"Retrieve a list of a card's subtasks.","operationId":"getCardSubtasks","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtasksExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Subtasks"],"summary":"Add a subtask to a card","description":"Create a new subtask for a card.","operationId":"addCardSubtask","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SubtaskCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardSubtaskCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/subtasks\/{subtask_id}":{"get":{"tags":["Card Subtasks"],"summary":"Get the details of a subtask for a card","description":"Get the details of a specific subtask for a card.","operationId":"getCardSubtask","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Subtasks"],"summary":"Update the details of a subtask for a card","description":"Update the details of a subtask for a card.","operationId":"updateCardSubtask","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/SubtaskUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardSubtaskUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardSubtaskExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Subtasks"],"summary":"Delete a subtask for a card","description":"Remove a subtask from a card.","operationId":"deleteCardSubtask","responses":{"204":{"description":"The card subtask has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"}]},"\/cards\/{card_id}\/successors":{"get":{"tags":["Card Successor Cards"],"summary":"Get a list of successor cards","description":"Retrieve a list of cards that are successors to the given card. Successor cards are linked cards that depend on the completion of the specified card to proceed.","operationId":"getSuccessorCards","responses":{"200":{"description":"Successfully retrieved the list of successor cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of successor cards linked to the specified card.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the successor card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/successors\/{successor_card_id}":{"get":{"tags":["Card Successor Cards"],"summary":"Check if a card is a successor of a given card","description":"Determine whether a card is a successor of the given card and retrieve its position in the predecessor's list of linked cards. Successor cards are linked cards that depend on the completion of the specified card to proceed.","operationId":"checkSuccessorCard","responses":{"200":{"description":"Successfully verified the successor relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Successor Cards"],"summary":"Establish or update the successor relationship between two cards","description":"Create or update a successor-predecessor relationship between two cards by designating one card as the successor of the specified card. If the cards are already linked, this operation allows updating their positions in each other's list of linked cards.","operationId":"addSuccessorCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to establish or update the successor relationship between two cards.","type":"object","properties":{"linked_card_position":{"format":"int32","type":"integer","description":"The position of the successor card within the predecessor's list of linked cards."},"card_position":{"format":"int32","type":"integer","description":"The position of the predecessor card within the successor's list of linked cards."}}},"example":{"$ref":"#\/components\/requestExamples\/CardLinkCardCreateRequestExample"}}}},"responses":{"200":{"description":"Successfully established or updated the successor relationship between the two cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Details of the successor card's position in the predecessor's list.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the successor card within the predecessor's list of linked cards."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"204":{"description":"The change was made but you do not have the permission required to view the result."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Successor Cards"],"summary":"Remove the successor-predecessor relationship between two cards","description":"Delete the link between a predecessor card and a successor card, effectively removing the successor-predecessor relationship between them.","operationId":"removeSuccessorCard","responses":{"204":{"description":"Successfully removed the successor-predecessor relationship between the two cards."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"successor_card_id","in":"path","description":"A successor card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/successorGraph":{"get":{"tags":["Card Successor Cards"],"summary":"Get a list of all successor cards linked to a specified card, including successors of its successors","description":"Get the full list of successor cards for a given card, including the successor cards of those successor cards.\nThis endpoint provides a hierarchical view of all linked successor cards.\n","operationId":"getSuccessorCardGraph","responses":{"200":{"description":"Successfully retrieved the graph of successor cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of successor cards, including their linked successor cards.","type":"array","items":{"$ref":"#\/components\/schemas\/SuccessorPredecessorLink"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardSuccessorGraphExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/tags":{"get":{"tags":["Card Tags"],"summary":"Get a list of card tags","description":"Get a list of all tags that have been added to the specified card.","operationId":"getCardTags","responses":{"200":{"description":"Successfully retrieved the list of tags associated with the card.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of tags associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTag"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTagsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/tags\/{tag_id}":{"get":{"tags":["Card Tags"],"summary":"Check if a tag is added to a card","description":"Verify if a specific tag is associated with a card","operationId":"checkCardTag","responses":{"204":{"description":"The tag is added to the card! Otherwise, you would have gotten a 404 error."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Tags"],"summary":"Add a tag to a card","description":"Add a tag to a card.\n\nYou can see the list of all tags in the [tags](#\/operations\/getTags#Request) endpoint.\n\nYou can see the list of tags for a specific board in the [board tags](#\/operations\/getBoardTags#Request) endpoint.\n","operationId":"addCardTag","responses":{"204":{"description":"Successfully added the tag to the card, making it available for use."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Tags"],"summary":"Remove a tag from a card","description":"Remove a tag from a card.","operationId":"removeCardTag","responses":{"204":{"description":"The tag is now removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/attachments":{"get":{"tags":["Card Template Card Attachments"],"summary":"Get a list of attachments of a card of a card template","description":"Get a list of attachments that are associated with a card within a card template.","operationId":"getCardTemplateCardAttachments","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Attachments"],"summary":"Add an attachment to a card of a card template","description":"Add an attachment to a card that is present within a card template.","operationId":"addCardTemplateCardAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardAttachmentCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/attachments\/{attachment_id}":{"get":{"tags":["Card Template Card Attachments"],"summary":"Get the details of an attachment of a card of a card template","description":"Get the details of specific attachment associated with a card within a card template.","operationId":"getCardTemplateCardAttachment","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Template Card Attachments"],"summary":"Update the details of an attachment of a card of a card template","description":"Update the details of specific attachment associated with a card within a card template.","operationId":"updateCardTemplateCardAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardAttachmentUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardAttachmentExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Attachments"],"summary":"Delete an attachment of a card of a card template","description":"Remove an attachment associated with a card within a card template.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the attachment unavailable on the specified template card and does **not** delete the actual file which may be referenced by other cards at a later time.","operationId":"deleteCardTemplateCardAttachment","responses":{"204":{"description":"The attachment of the card of the card template has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/attachmentIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/children":{"get":{"tags":["Card Template Card Child Cards"],"summary":"Get a list of child cards for a card within a card template","description":"Retrieve a list of all child cards associated with a specific card in a card template.","operationId":"getCardTemplateCardChildCards","responses":{"200":{"description":"Successfully retrieved the list of child cards for the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of child cards linked to the specified card in the card template.","type":"array","items":{"allOf":[{"type":"object","properties":{"template_card_id":{"description":"The ID of the template card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/children\/{child_card_id}":{"get":{"tags":["Card Template Card Child Cards"],"summary":"Check if a card is a child of a given card of a card template","description":"Determine whether a card is a child of the specified card within a card template and retrieve its position in the parent's list of linked cards.","operationId":"checkCardTemplateCardChildCard","responses":{"200":{"description":"Successfully verified the child relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Child Cards"],"summary":"Establish a parent-child relationship between two cards within a card template","description":"Create a parent-child relationship between two cards within a card template by designating one card as the parent of the specified child card. This operation also allows specifying the positions of the cards in each other's list of linked cards.","operationId":"addCardTemplateCardChildCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Optional data to establish the parent-child relationship between two cards within a card template.","type":"object","properties":{"template_card_position":{"description":"The position of the parent card within the child's list of linked cards.","format":"int32","type":"integer"},"linked_template_card_position":{"description":"The position of the child card within the parent's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/TemplateCardLinkCardRequestExample"}}}},"responses":{"200":{"description":"Successfully established the parent-child relationship between the two cards within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Details of the child card's position in the parent's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the child card within the parent's list of linked cards."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Child Cards"],"summary":"Remove the parent-child link between two cards within a card template","description":"Delete the link between a parent card and a child card within a card template, effectively removing the parent-child relationship between them.","operationId":"removeCardTemplateCardChildCard","responses":{"204":{"description":"Successfully removed the parent-child relationship between the two cards."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"child_card_id","in":"path","description":"A child card ID.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/coOwners":{"get":{"tags":["Card Template Card Co Owners"],"summary":"Get a list of co-owners of a card of a card template","description":"Retrieve a list of co-owners for a card that is within a card template.","operationId":"getCardTemplateCardCoOwners","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of co-owners of a card of a card template.","type":"array","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The user id of the co-owner."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCoOwnersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/coOwners\/{user_id}":{"get":{"tags":["Card Template Card Co Owners"],"summary":"Check if a user is a co-owner of a card of a card template","description":"Check if a user is assigned as a co-owner of a card within a card template.","operationId":"checkCardTemplateCardCoOwner","responses":{"204":{"description":"The user is a co-owner of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Co Owners"],"summary":"Add a user as a co-owner of a card of a card template","description":"Assign a user as a co-owner of a card within a card template.","operationId":"addCardTemplateCardCoOwner","responses":{"204":{"description":"The user is now a co-owner of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Co Owners"],"summary":"Remove a user as a co-owner of a card of a card template","description":"Remove a user as a co-owner of a card within a card template.","operationId":"removeCardTemplateCardCoOwner","responses":{"204":{"description":"The user is no longer a co-owner of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields":{"get":{"tags":["Card Template Card Custom Fields"],"summary":"Get a list of custom fields of a card of a card template","description":"Retrieve a list of the custom fields added to a card within a card template along with their associated values.","operationId":"getCardTemplateCardCustomFields","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of custom fields of a card of a card template.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedDateWithFieldId"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCustomFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}":{"get":{"tags":["Card Template Card Custom Fields"],"summary":"Get the details of a custom field of a card of a card template if the field is added to the card","description":"Get the details of a specific custom field of a card within a card template if the field is added to the card.","operationId":"getCardTemplateCardCustomField","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCardPicker"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedNumber"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedDate"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Custom Fields"],"summary":"Add or update a custom field to a card of a card template","description":"Add a new custom field to a card or update the specified custom field if it is already added to the card in a card template.","operationId":"addCardTemplateCardCustomField","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldAddOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardCustomFieldAddRequestExample"}}}},"responses":{"200":{"description":"Successfully added or updated the custom field of the card of the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The details of the custom field, including its type and associated data.","oneOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedDateWithFieldId"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldExample"}}}},"204":{"description":"The custom field was successfully added or updated, but you do not have the permissions required to view the results."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Custom Fields"],"summary":"Remove a custom field from a card of a card template","description":"Remove a custom field from a card within a card template.","operationId":"removeCardTemplateCardCustomField","responses":{"204":{"description":"The custom field was removed from the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/contributors":{"get":{"tags":["Card Template Card Custom Field Contributors"],"summary":"Get a list of the default contributors for a custom field of a card of a card template","description":"Get a list of default contributors assigned to a specific custom field of a card within a card template.","operationId":"getCardTemplateCardCustomFieldContributors","responses":{"200":{"description":"Successfully retrieved the list of default contributors for the custom field.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of default contributors assigned to the custom field.","type":"array","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of the contributor."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldContributorsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/contributors\/{user_id}":{"get":{"tags":["Card Template Card Custom Field Contributors"],"summary":"Verify if a user is a contributor for a custom field in a card within a card template","description":"Determine whether a specific user is assigned as a contributor to a custom field of a card within a card template.","operationId":"checkCardTemplateCardCustomFieldContributor","responses":{"204":{"description":"The user is successfully verified as a contributor for the custom field of the card within the card template. If the user is not a contributor, a 404 error will be returned."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Custom Field Contributors"],"summary":"Assign a user as a contributor for a custom field in a card within a card template","description":"Add a user as a contributor to a specific custom field of a card within a card template.\n\nYou can see the list of all users in the [users](#\/operations\/getUsers#Request) endpoint.\n\nYou can see the list of all users assigned to board in the [board users](#\/operations\/getBoardAssignees#Request) endpoint.\n","operationId":"addCardTemplateCardCustomFieldContributor","responses":{"204":{"description":"Successfully assigned the user as a contributor for the custom field of the card within the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Custom Field Contributors"],"summary":"Remove a user as a contributor for a custom field in a card template","description":"Delete the association of a user as a contributor for a specific custom field of a card within a card template. This action removes the user's contributor role for the custom field.","operationId":"removeCardTemplateCardCustomFieldContributor","responses":{"204":{"description":"Successfully removed the user as a contributor for the custom field of the card within the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/files":{"get":{"tags":["Card Template Card Custom Field Files"],"summary":"Get a list of the files for a custom field of a card of a card template","description":"Get a list of files uploaded to a specific custom field of a card within a card template.","operationId":"getCardTemplateCardCustomFieldFiles","responses":{"200":{"description":"Successfully retrieved the list of files for the custom field of a card within a card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of files linked to the custom field.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFile"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFilesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Custom Field Files"],"summary":"Add a file for a custom field of a card of a card template","description":"Add a file to a specific custom field of a card within a card template.","operationId":"addCardTemplateCardCustomFieldFile","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFileCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardCustomFieldFileRequestExample"}}}},"responses":{"200":{"description":"Successfully uploaded the file to the custom field of the card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFile"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/files\/{file_id}":{"get":{"tags":["Card Template Card Custom Field Files"],"summary":"Get the details of a specific file associated with a custom field in a card template","description":"Get the details of a specific file that is linked to a custom field of a card within a card template.","operationId":"getCardTemplateCardCustomFieldFile","responses":{"200":{"description":"Successfully retrieved the details of the file associated with the custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFile"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Template Card Custom Field Files"],"summary":"Update the details of a file associated with a custom field in a card template","description":"Update the details of a specific file linked to a custom field of a card within a card template.","operationId":"updateCardTemplateCardCustomFieldFile","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFileUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardCustomFieldFileRequestExample"}}}},"responses":{"200":{"description":"Successfully updated the file associated with the custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFile"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileUpdateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Custom Field Files"],"summary":"Remove a file associated with a custom field in a card template","description":"Remove a specific file linked to a custom field of a card within a card template. This action removes the file's association with the custom field but does not delete the actual file, which may still be referenced elsewhere.","operationId":"deleteCardTemplateCardCustomFieldFile","responses":{"204":{"description":"Successfully removed the file associated with the custom field in the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/fileIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/selectedValues":{"get":{"tags":["Card Template Card Custom Field Selected Values"],"summary":"Get a list of the selected values for a custom field of type dropdown of a card of a card template","description":"Get a list of values selected for a dropdown custom field associated with a specific card within a card template.","operationId":"getCardTemplateCardCustomFieldSelectedValues","responses":{"200":{"description":"Successfully retrieved the list of selected values for the dropdown custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Contains the list of selected values for the dropdown custom field.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldSelectedValue"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedValuesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Custom Field Selected Values"],"summary":"Add or update a selected value for a dropdown custom field in a card template","description":"Add a new selected value or update an existing value for a dropdown custom field associated with a specific card in a card template.","operationId":"addCardTemplateCardCustomFieldSelectedValues","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldSelectedValueAddOrUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardCustomFieldSelectedValueAddRequestExample"}}}},"responses":{"200":{"description":"Successfully added or updated the selected value for the dropdown custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldSelectedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldSelectedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/customFields\/{field_id}\/selectedValues\/{value_id}":{"get":{"tags":["Card Template Card Custom Field Selected Values"],"summary":"Get the details of a selected value for a dropdown custom field of a card of a card template","description":"Get the details of a selected value for a dropdown custom field of a card of a card template.","operationId":"getCardTemplateCardCustomFieldSelectedValue","responses":{"200":{"description":"Successfully retrieved the details of the selected value for the dropdown custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An object containing the position of the selected value within the list.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of dropdown values. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Custom Field Selected Values"],"summary":"Add or update a selected value for a dropdown custom field of a card of a card template","description":"Add a new selected value or update the position of an existing value for a dropdown custom field associated with a specific card in a card template.","operationId":"addOrUpdateCardTemplateCardCustomFieldSelectedValues","requestBody":{"content":{"application\/json":{"schema":{"description":"Represents the data to add or update a selected value for a dropdown custom field in a card template.","type":"object","properties":{"position":{"description":"The position of the selected value within the list of dropdown values. `0` represents the top-most position.","format":"int32","type":"integer"}}},"example":{"position":0}}}},"responses":{"200":{"description":"Successfully added or updated the selected value for the dropdown custom field in the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An object containing the position of the selected value within the list.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the selected value within the list of dropdown values."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCustomFieldSelectedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Custom Field Selected Values"],"summary":"Remove a selected value for a dropdown custom field of a card of a card template","description":"Remove a specific value from the list of selected values in a dropdown custom field associated with a card in a card template.\nThis action unlinks the value from the custom field but does not delete the value itself.\n","operationId":"removeCardTemplateCardCustomFieldSelectedValues","responses":{"204":{"description":"Successfully removed the selected value from the dropdown custom field in the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/valueIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/milestones":{"get":{"tags":["Card Template Card Milestones"],"summary":"Get a list of milestones of a card of a card template","description":"Retrieve a list of milestones added to a card within a card template.","operationId":"getCardTemplateCardMilestones","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of milestones.","type":"array","items":{"title":"List of milestones","type":"object","properties":{"milestone_id":{"format":"int32","type":"integer","description":"The unique identifier of the milestone."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardMilestonesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/milestones\/{milestone_id}":{"get":{"tags":["Card Template Card Milestones"],"summary":"Check if a milestone is added to a card of a card template","description":"Check if a specific milestone is added to a card within a card template.","operationId":"checkCardTemplateCardMilestone","responses":{"204":{"description":"The milestone is added to the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Milestones"],"summary":"Add a milestone to a card of a card template","description":"Add a milestone to a card within a card template.","operationId":"addCardTemplateCardMilestone","responses":{"204":{"description":"The milestone is now available on the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Milestones"],"summary":"Remove a milestone from a card of a card template","description":"Remove a milestone from a card within a card template.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only makes the milestone unavailable on the specified card within the template and does **not** actually delete the milestone itself.","operationId":"removeCardTemplateCardMilestone","responses":{"204":{"description":"The milestone is now removed from the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/parents":{"get":{"tags":["Card Template Card Parent Cards"],"summary":"Get a list of parent cards of a card of a card template","description":"Get a list of parent cards associated with a specific card in a card template.","operationId":"getCardTemplateCardParentCards","responses":{"200":{"description":"Successfully retrieved the list of parent cards for the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of parent cards linked to the specified card in the card template.","type":"array","items":{"allOf":[{"type":"object","properties":{"template_card_id":{"description":"The ID of the parent card within the card template.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/parents\/{parent_card_id}":{"get":{"tags":["Card Template Card Parent Cards"],"summary":"Check if a card is a parent of a given card of a card template","description":"Determine whether a card is a parent of the specified card within a card template and retrieve its position in the child card's list of linked cards.","operationId":"checkCardTemplateCardParentCard","responses":{"200":{"description":"Successfully verified the parent-child relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Parent Cards"],"summary":"Establish a parent-child relationship between two cards within a card template","description":"Create a parent-child relationship between two cards within a card template by designating one card as the parent of the specified child card. This operation also allows specifying the positions of the cards in each other's list of linked cards.","operationId":"addCardTemplateCardParentCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to establish the parent-child relationship between two cards within a card template.","type":"object","properties":{"template_card_position":{"description":"The position of the child card within the parent's list of linked cards.","format":"int32","type":"integer"},"linked_template_card_position":{"description":"The position of the parent card within the child's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/TemplateCardLinkCardRequestExample"}}}},"responses":{"200":{"description":"Successfully established the parent-child relationship between the two cards within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An object containing the position of the parent card within the child's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the parent card within the child's list of linked cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Parent Cards"],"summary":"Remove the parent-child relationship between two cards within a card template","description":"Delete the link between a child card and a parent card within a card template, effectively removing the parent-child relationship between them.","operationId":"removeCardTemplateCardParentCard","responses":{"204":{"description":"Successfully removed the parent-child relationship between the two cards."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"parent_card_id","in":"path","description":"A parent card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/predecessors":{"get":{"tags":["Card Template Card Predecessor Cards"],"summary":"Get a list of predecessor cards for a card within a card template","description":"Get a list of predecessor cards associated with a specific card in a card template.","operationId":"getCardTemplateCardPredecessorCards","responses":{"200":{"description":"Successfully retrieved the list of predecessor cards for the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of predecessor cards linked to the specified card in the card template.","type":"array","items":{"allOf":[{"type":"object","properties":{"template_card_id":{"description":"The ID of the predecessor card within the card template.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/predecessors\/{predecessor_card_id}":{"get":{"tags":["Card Template Card Predecessor Cards"],"summary":"Check if a card is a predecessor of a specified card within a card template","description":"Determine whether a card is a predecessor of the specified card within a card template and retrieve its position in the successor's list of linked cards.","operationId":"checkCardTemplateCardPredecessorCard","responses":{"200":{"description":"Successfully verified the predecessor relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Predecessor Cards"],"summary":"Establish a predecessor relationship between two cards within a card template","description":"Create a predecessor-successor relationship between two cards within a card template by designating one card as the predecessor of the specified card. This operation also allows specifying the positions of the cards in each other's list of linked cards","operationId":"addCardTemplateCardPredecessorCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to establish the predecessor relationship between two cards within a card template.","type":"object","properties":{"linked_card_position":{"description":"The position of the predecessor card within the successor's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the successor card within the predecessor's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/TemplateCardLinkCardRequestExample"}}}},"responses":{"200":{"description":"Successfully established the predecessor-successor relationship between the two cards within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the predecessor card within the successor's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the predecessor card within the successor's list of linked cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Predecessor Cards"],"summary":"Remove the predecessor-successor relationship between two cards within a card template","description":"Delete the link between a successor card and a predecessor card within a card template, effectively removing the predecessor-successor relationship between them.","operationId":"removeCardTemplateCardPredecessorCard","responses":{"204":{"description":"Successfully removed the predecessor-successor relationship between the two cards."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"predecessor_card_id","in":"path","description":"A predecessor card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/relatives":{"get":{"tags":["Card Template Card Relative Cards"],"summary":"Get a list of relative cards for a card within a card template","description":"Get a list of relative cards associated with a specific card in a card template.","operationId":"getCardTemplateCardRelativeCards","responses":{"200":{"description":"Successfully retrieved the list of relative cards for the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of relative cards linked to the specified card in the card template.","type":"array","items":{"allOf":[{"type":"object","properties":{"template_card_id":{"description":"The ID of the relative card within the card template.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/relatives\/{related_card_id}":{"get":{"tags":["Card Template Card Relative Cards"],"summary":"Check if a card is a relative of a specified card within a card template","description":"Determine whether a card is a relative of the specified card within a card template and retrieve its position in the linked card's list of linked cards.","operationId":"checkCardTemplateCardRelatedCard","responses":{"200":{"description":"Successfully verified the relative relationship and retrieved the card's position.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Relative Cards"],"summary":"Establish a relative relationship between two cards within a card template","description":"Create a relative relationship between two cards within a card template by designating one card as related to the specified card. This operation also allows specifying the positions of the cards in each other's list of linked cards.","operationId":"addCardTemplateCardRelatedCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to establish the relative relationship between two cards within a card template.","type":"object","properties":{"template_card_position":{"description":"The position of the card within the related card's list of linked cards.","format":"int32","type":"integer"},"linked_template_card_position":{"description":"The position of the related card within the card's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/TemplateCardLinkCardRequestExample"}}}},"responses":{"200":{"description":"Successfully established the relative relationship between the two cards within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Details of the related card's position in the card's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the related card within the card's list of linked cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Relative Cards"],"summary":"Remove the relationship between two related cards within a card template","description":"Delete the link between two related cards within a card template, effectively removing the relationship between them. This action makes the cards independent of each other.","operationId":"removeCardTemplateCardRelatedCard","responses":{"204":{"description":"Successfully removed the relationship between the two cards within the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"related_card_id","in":"path","description":"A related card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/stickers":{"get":{"tags":["Card Template Card Stickers"],"summary":"Get a list of stickers for a card within a card template","description":"Get a list of stickers associated with a specific card in a card template. The stickers are displayed in the order they were added to the card.","operationId":"getCardTemplateCardStickers","responses":{"200":{"description":"Successfully retrieved the list of stickers for the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of stickers linked to the specified card in the card template.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardSticker"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardStickersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Stickers"],"summary":"Add a sticker to a card within a card template","description":"Attach a sticker to a specific card within a card template.","operationId":"addCardTemplateCardSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"Represents the data required to add a sticker to a card within a card template.","type":"object","properties":{"sticker_id":{"description":"The ID of the sticker to be added.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/CardStickerCreateRequestExample"}}}},"responses":{"200":{"description":"Successfully added the sticker to the specified card within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCardSticker"}}},"example":{"$ref":"#\/components\/responseExamples\/CardStickerExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/stickers\/{id}":{"delete":{"tags":["Card Template Card Stickers"],"summary":"Remove a sticker from a card within a card template","description":"Delete a specific sticker associated with a card in a card template.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action removes the sticker from the card but does not delete the sticker itself from the system.","operationId":"removeCardTemplateCardSticker","responses":{"204":{"description":"Successfully removed the sticker from the specified card within the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"id","in":"path","description":"The template card sticker id. It is the 'id' returned by GET|POST \/cardTemplates\/{template_id}\/cards\/{card_id}\/stickers.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/subtasks\/{subtask_id}\/attachments":{"get":{"tags":["Card Template Card Subtask Attachments"],"summary":"Get a list of attachments for a subtask within a card template","description":"Get a list of attachments associated with a specific subtask of a card within a card template.","operationId":"getCardTemplateCardSubtaskAttachments","responses":{"200":{"description":"Successfully retrieved the list of attachments for the specified subtask within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of attachments linked to the specified subtask in the card template.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFilesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Subtask Attachments"],"summary":"Attach a file to a subtask within a card template","description":"Add an attachment to a specific subtask of a card within a card template.","operationId":"addCardTemplateCarSubtaskAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardCustomFieldFileRequestExample"}}}},"responses":{"200":{"description":"Successfully added the attachment to the specified subtask within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/subtasks\/{subtask_id}\/attachments\/{attachment_id}":{"get":{"tags":["Card Template Card Subtask Attachments"],"summary":"Get the details of an attachment for a subtask within a card template","description":"Get information about a specific attachment associated with a subtask of a card within a card template.","operationId":"getCardTemplateCardSubtaskAttachment","responses":{"200":{"description":"Successfully retrieved the details of the attachment for the specified subtask within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Template Card Subtask Attachments"],"summary":"Update the details of an attachment for a subtask within a card template","description":"Update the properties of a specific attachment associated with a subtask of a card within a card template.","operationId":"updateCardTemplateCardSubtaskAttachment","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskAttachmentUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardCustomFieldFileRequestExample"}}}},"responses":{"200":{"description":"Successfully updated the details of the attachment for the specified subtask within the card template.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardCustomFieldFileExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Subtask Attachments"],"summary":"Remove an attachment from a subtask within a card template","description":"Delete a specific attachment associated with a subtask of a card within a card template. This action removes the attachment from the subtask but does not delete the actual file, which may still be referenced elsewhere.","operationId":"deleteCardTemplateCardSubtaskAttachment","responses":{"204":{"description":"Successfully removed the attachment from the subtask within the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"},{"$ref":"#\/components\/parameters\/attachmentIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/subtasks":{"get":{"tags":["Card Template Card Subtasks"],"summary":"Get a list of the subtasks of a card of a card template","description":"Retrieve a list of the subtasks of a card within a card template.","operationId":"getCardTemplateCardSubtasks","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardSubtaskWithPosition"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardSubtasksExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Card Subtasks"],"summary":"Add a subtask of a card of a card template","description":"Add a subtask to a card within a card template.","operationId":"addCardTemplateCardSubtask","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardSubtaskCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCardSubtaskWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardSubtaskExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/subtasks\/{subtask_id}":{"get":{"tags":["Card Template Card Subtasks"],"summary":"Get the details of a subtask of a card of a card template","description":"Get the details of a specific subtask of a card within a card template.","operationId":"getCardTemplateCardSubtask","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCardSubtaskWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardSubtaskExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Template Card Subtasks"],"summary":"Update the details of a subtask of a card of a card template","description":"Update the details of a specific subtask of a card within a card template.","operationId":"updateCardTemplateCardSubtask","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardSubtaskUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCardSubtaskWithPosition"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardSubtaskExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Subtasks"],"summary":"Delete a subtask of a card of a card template","description":"Remove a subtask of a card within a card template.","operationId":"deleteCardTemplateCardSubtask","responses":{"204":{"description":"The subtask of the card of the card template has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/subtaskIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/successors":{"get":{"tags":["Card Template Card Successor Cards"],"summary":"Get a list of successor cards of a card of a card template","description":"Get a list of successor cards associated with a specific card in a card template.","operationId":"getCardTemplateCardSuccessorCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of successor cards.","type":"array","items":{"allOf":[{"type":"object","properties":{"template_card_id":{"description":"Template card id.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/successors\/{successor_card_id}":{"get":{"tags":["Card Template Card Successor Cards"],"summary":"Check if a card is a successor of a given card of a card template","description":"Determine whether a card is a successor of the specified card within a card template and retrieve its position in the predecessor's list of linked cards.","operationId":"checkCardTemplateCardSuccessorCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Successor Cards"],"summary":"Make a card a successor of a given card of a card template","description":"Create a predecessor-successor relationship between two cards within a card template by designating one card as the successor of the specified card. This operation also allows specifying the positions of the cards in each other's list of linked cards","operationId":"addCardTemplateCardSuccessorCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Link data.","type":"object","properties":{"linked_card_position":{"description":"The position of the successor card within the predecessor's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the predecessor card within the successor's list of linked cards.","format":"int32","type":"integer"}}},"example":{"$ref":"#\/components\/requestExamples\/TemplateCardLinkCardRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The position of the successor card within the predecessor's list of linked cards.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The updated position of the successor card within the predecessor's list of linked cards. `0` represents the top-most position."}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Successor Cards"],"summary":"Remove the link between a predecessor card and a successor card","description":"Delete the link between a successor card and a predecessor card within a card template, effectively removing the predecessor-successor relationship between them.","operationId":"removeCardTemplateCardSuccessorCard","responses":{"204":{"description":"Successfully removed the predecessor-successor relationship between the two cards."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"successor_card_id","in":"path","description":"A successor card id.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/tags":{"get":{"tags":["Card Template Card Tags"],"summary":"Get a list of tags of a card of a card template","description":"Retrieve a list of the tags associated with a specific card in a card template.","operationId":"getCardTemplateCardTags","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTag"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardTagsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/tags\/{tag_id}":{"get":{"tags":["Card Template Card Tags"],"summary":"Check if a tag is added to a card of a card template","description":"Determine if a tag is added to a card within a card template.","operationId":"checkCardTemplateCardTag","responses":{"204":{"description":"The tag is added to the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Tags"],"summary":"Add a tag to a card of a card template","description":"Add a tag to a card within a card template.","operationId":"addCardTemplateCardTag","responses":{"204":{"description":"The tag is now available on the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Tags"],"summary":"Remove a tag from a card of a card template","description":"Remove a tag from a card within a card template.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action removes the tag from the card but does not delete the tag itself from the system.","operationId":"removeCardTemplateCardTag","responses":{"204":{"description":"The tag is now removed from the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/watchers":{"get":{"tags":["Card Template Card Watchers"],"summary":"Get a list of watchers of a card of a card template","description":"Get a list of watchers for a specific card within a card template.","operationId":"getCardTemplateCardWatchers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"title":"Watcher","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The user id of the watcher."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardWatchersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}\/watchers\/{user_id}":{"get":{"tags":["Card Template Card Watchers"],"summary":"Check if a user is a watcher of a card of a card template","description":"Determine if a user is a watcher of a specific card within a card template.","operationId":"checkUserIsCardTemplateCardWatcher","responses":{"204":{"description":"The user is a watcher of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Template Card Watchers"],"summary":"Add a watcher of a card of a card template","description":"Add a user as a watcher of a specific card within a card template.","operationId":"addCardTemplateCardWatcher","responses":{"204":{"description":"The user is now a watcher of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Card Watchers"],"summary":"Remove a watcher of a card of a card template","description":"Remove a user as a watcher of a specific card within a card template.","operationId":"removeCardTemplateCardWatcher","responses":{"204":{"description":"The user is no longer a watcher of the card of the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cardTemplates\/{template_id}\/cards":{"get":{"tags":["Card Template Cards"],"summary":"Get a list of cards for the card template","description":"Retrieve a list of cards associated with a specific card template.","operationId":"getCardTemplateCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards for the card template.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCard"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Template Cards"],"summary":"Add a card to the card template","description":"Add a new card to a card template.","operationId":"addCardTemplateCard","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCardInExistingTemplateCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardInExistingTemplateCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"}]},"\/cardTemplates\/{template_id}\/cards\/{card_id}":{"get":{"tags":["Card Template Cards"],"summary":"Get the details of a single card of a card template","description":"Retrieve the details of a specific card within a template.","operationId":"getCardTemplateCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Template Cards"],"summary":"Update a card of a card template","description":"Update a card that is within a card template.","operationId":"updateCardTemplateCard","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCardUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCardUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplateCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Template Cards"],"summary":"Delete a card of a card template","description":"Delete a card from within a card template","operationId":"deleteCardTemplateCard","responses":{"204":{"description":"The card has been deleted from the card template."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"},{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cardTemplates":{"get":{"tags":["Card Templates"],"summary":"Get a list of card templates","description":"Retrieves a list of card templates with their relevant details, optionally filtered using various parameters.","operationId":"getCardTemplates","parameters":[{"name":"template_ids","in":"query","description":"Filters results to include only templates with matching IDs.","required":false,"example":"1,2","schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"name","in":"query","description":"Filters the results to include only templates that match the specified name.","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the card templates.\n\nA value of `0` represents **On-demand**, meaning the card template can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card template is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card template is automatically added to all boards across all workspaces. Once a card template's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"example":"0,1"},{"name":"is_enabled","in":"query","description":"Filters card templates based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["template_id","name","description","primary_template_card_id","availability","is_enabled"]}},"example":"template_id,name","explode":false},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["board_ids","board_count","template_cards"]}},"example":"board_ids, board_count","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card templates.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplates"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplatesResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Templates"],"summary":"Create a new card template","description":"Creates a new card template.\n\nEach template always contains a **primary card**, represented by the `primary_card` object, which holds the data used to create the template.\n\nTemplates can also include multiple **additional cards** linked to the primary card, e.g. child, relative, etc. These are represented in the `other_cards` array.\n","operationId":"createCardTemplate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplate"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTemplates\/{template_id}":{"get":{"tags":["Card Templates"],"summary":"Get the details of a single card template","description":"Get the details of a single card template.\n\n\n> #### Info\n>\n> You can use the [GET \/cardTemplates](#\/operations\/getCardTemplates) endpoint with the `template_ids` query parameter to retrieve multiple card templates in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getCardTemplate","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplate"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Templates"],"summary":"Update a card template","description":"Update a card template.","operationId":"updateCardTemplate","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardTemplateUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardTemplateUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardTemplate"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplateUpdateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Templates"],"summary":"Delete a card template","description":"Delete a card template.","operationId":"deleteCardTemplate","responses":{"204":{"description":"The card template has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/templateIdInPath"}]},"\/cardTemplates\/history":{"get":{"tags":["Card Templates History"],"summary":"Get a list of card templates creation, deletion and update events","description":"Get a list of events related to the creation, deletion, and updates of card templates. The results can be filtered using optional criteria.","operationId":"getCardTemplatesHistory","parameters":[{"name":"template_ids","in":"query","description":"A list of template IDs to filter the history results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},{"name":"user_ids","in":"query","description":"A list of user IDs who performed the actions.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"The types of actions performed on the card templates.","required":false,"schema":{"items":{"type":"string","enum":["template_created","template_updated","template_disabled","template_enabled","template_deleted","template_added_to_board","template_updated_for_board","template_removed_from_board","template_structure_updated"]}},"explode":false,"example":"template_created,template_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 12:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 12:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer","default":1},"example":1},{"name":"per_page","in":"query","description":"The number of results per page. Defaults to `100` and has a maximum value of `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200},"example":100}],"responses":{"200":{"description":"Successfully retrieved the list of card template events.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the result set.","type":"integer"},"current_page":{"description":"The current page number.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of events related to card templates.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTemplatesHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTemplates\/deleteMany":{"post":{"tags":["Card template Delete Many"],"summary":"Delete many card templates","description":"Schedule multiple card templates for deletion in a single request. Card templates are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyCardTemplates","requestBody":{"content":{"application\/json":{"schema":{"description":"Card template IDs data.","type":"object","required":["template_ids"],"properties":{"template_ids":{"description":"A list of card template IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"template_ids":[1,2]}}}},"responses":{"204":{"description":"The card templates have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTemplates\/disableMany":{"post":{"tags":["Card template Disable Many"],"summary":"Disable many card templates","description":"Schedule multiple card templates for disabling in a single request. Card templates are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyCardTemplates","requestBody":{"content":{"application\/json":{"schema":{"description":"Card template IDs data.","type":"object","required":["template_ids"],"properties":{"template_ids":{"description":"A list of card template IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"template_ids":[1,2]}}}},"responses":{"204":{"description":"The card templates have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTemplates\/enableMany":{"post":{"tags":["Card template Enable Many"],"summary":"Enable many card templates","description":"Schedule multiple card templates for enabling in a single request. Card templates are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyCardTemplates","requestBody":{"content":{"application\/json":{"schema":{"description":"Card template IDs data.","type":"object","required":["template_ids"],"properties":{"template_ids":{"description":"A list of card template IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"template_ids":[1,2]}}}},"responses":{"204":{"description":"The card templates have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTypes":{"get":{"tags":["Card Types"],"summary":"Get a list of card types","description":"Retrieves a list of card types with their relevant details, optionally filtered using various parameters.","operationId":"getCardTypes","parameters":[{"name":"type_ids","in":"query","description":"Filters results to include only types with matching IDs.","example":"1,2","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"name","in":"query","description":"Filters the results to include only card types that match the specified name.","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the card types.\n\nA value of `0` represents **On-demand**, meaning the card type can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card type is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card type is automatically added to all boards across all workspaces. Once a card type's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"example":"0,1","explode":false},{"name":"is_enabled","in":"query","description":"Filters card types based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["type_id","icon_type","icon_id","name","description","color","card_color_sync","all_properties_are_locked","availability","is_enabled"]}},"example":"type_id, name","explode":false},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["boards","board_count","card_count","business_rules"]}},"example":"boards, card_count","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card types.","type":"array","items":{"$ref":"#\/components\/schemas\/CardType"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Card Types"],"summary":"Create a card type","description":"Create a new card type.","operationId":"createCardType","requestBody":{"content":{"application\/json":{"schema":{"description":"Card type data.","required":["name"],"type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","default":0,"enum":[0,1]},"icon_id":{"description":"The unique identifier for the icon associated with the card type.","format":"int32","type":"integer","default":0},"name":{"description":"The **unique** name assigned to the card type.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the card type.","type":"string","default":null},"color":{"description":"The color of the card type in hexadecimal format.","type":"string","default":""},"card_color_sync":{"description":"Apply the color of the card type to any card to which it's assigned.","format":"int32","type":"integer","enum":[0,1],"default":0},"all_properties_are_locked":{"description":"Controls whether the icon_type, icon_id, color and card_color_sync properties can be modified per board.","format":"int32","type":"integer","enum":[0,1],"default":0},"availability":{"description":"The availability level of the card type.\n\nA value of `0` represents **On-demand**, meaning the card type can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card type is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card type is automatically added to all boards across all workspaces. Once a card type's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the card type is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/CardTypeCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardType"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTypes\/{type_id}":{"get":{"tags":["Card Types"],"summary":"Get the details of a single card type","description":"Get the details of a single card type.\n\n\n> #### Info\n>\n> You can use the [GET \/cardTypes](#\/operations\/getCardTypes) endpoint with the `type_ids` query parameter to retrieve multiple card types in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getCardType","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardType"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Card Types"],"summary":"Update a card type","description":"Update a card type.","operationId":"updateCardType","requestBody":{"content":{"application\/json":{"schema":{"description":"Card type data.","type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","default":0,"enum":[0,1]},"icon_id":{"description":"The unique identifier for the icon associated with the card type.","format":"int32","type":"integer","default":0},"name":{"description":"The **unique** name assigned to the card type.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the card type.","type":"string","default":null},"color":{"description":"The color of the card type in hexadecimal format.","type":"string","default":""},"card_color_sync":{"description":"Apply the color of the card type to any card to which it's assigned.","format":"int32","type":"integer","enum":[0,1],"default":0},"all_properties_are_locked":{"description":"Controls whether the icon_type, icon_id, color and card_color_sync properties can be modified per board.","format":"int32","type":"integer","enum":[0,1],"default":0},"availability":{"description":"The availability level of the card type.\n\nA value of `0` represents **On-demand**, meaning the card type can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card type is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card type is automatically added to all boards across all workspaces. Once a card type's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the card type is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/CardTypeCreateOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardType"}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Types"],"summary":"Delete a card type","description":"Delete a card type.","operationId":"deleteCardType","parameters":[{"name":"replace_with_type_id","in":"query","description":"The ID of the card type that will replace the deleted card type for **all** affected cards.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The card type has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/cardTypes\/{type_id}\/boards":{"get":{"tags":["Card Type Boards"],"summary":"Get a list of boards where a specific card type is available","description":"Get a list of boards on which the specified card type is available. \n\n You can see a list of all card types in the [card types](#operations\/getCardTypes#Request) endpoint.","operationId":"getCardTypeBoards","responses":{"200":{"description":"Successfully retrieved the list of boards where the card type is available.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"type":"object","title":"Card Type Board","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board where the card type is available."},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon used for the card type on the board.","enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The ID of the icon used for the card type on the board.","default":0},"color":{"type":"string","description":"The color of the card type on the board, represented as a hexadecimal string.","default":""},"card_color_sync":{"format":"int32","type":"integer","description":"Indicates whether the card color is synchronized with the card type color. `0` - not synchronized, `1` - synchronized.","enum":[0,1]}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypeBoardsResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/cardTypes\/{type_id}\/batchBoardOperations":{"post":{"tags":["Card Type Boards"],"summary":"Manage the availability of a card type on multiple boards","description":"Add or update the availability of a card type on several boards, or remove it from specified boards. This operation allows you to configure the card type's settings for each board. \n\n You can see a list of all card types in the [card types](#operations\/getCardTypes#Request) endpoint. \n\n You can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.","operationId":"updateCardTypeBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to manage the availability of a card type on multiple boards.","type":"object","properties":{"boards_to_add_or_update":{"description":"A list of board IDs where the card type should be added or updated.","type":"array","items":{"required":["board_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board."},"icon_type":{"format":"int32","type":"integer","enum":[0,1],"description":"The type of icon associated with the card type on the board."},"icon_id":{"format":"int32","type":"integer","description":"The ID of the icon associated with the card type.","default":0},"color":{"type":"string","default":"","description":"The color associated with the card type on the board."},"card_color_sync":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the card color is synchronized with the card type color. `0` - not synchronized, `1` - synchronized."}}}},"board_ids_to_remove":{"description":"A list of board IDs where the card type should be removed.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/CardTypeBoardsUpdateRequestExample"}}}},"responses":{"200":{"description":"Successfully updated the availability of the card type on the specified boards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of boards with updated card type settings.","type":"array","items":{"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board where the card type is available."},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon used for the card type on the board.","enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The ID of the icon used for the card type on the board.","default":0},"color":{"type":"string","description":"The color of the card type on the board, represented as a hexadecimal string.","default":""},"card_color_sync":{"format":"int32","type":"integer","description":"Indicates whether the card color is synchronized with the card type color. `0` - not synchronized, `1` - synchronized.","enum":[0,1]}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypeBoardsResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/cardTypes\/{type_id}\/cards":{"get":{"tags":["Card Type Cards"],"summary":"Get a list of cards associated with a specific card type","description":"Get a list of cards where the specified card type is applied. \n\n You can see a list of all card types in the [card types](#operations\/getCardTypes#Request) endpoint.","operationId":"getCardTypeCards","responses":{"200":{"description":"Successfully retrieved the list of cards associated with the specified card type.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of cards associated with the card type.","type":"array","items":{"title":"Card Type Card","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of the card."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/TokenCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/typeIdInPath"}]},"\/cardTypes\/history":{"get":{"tags":["Card Type History"],"summary":"Get a list of card types creation, deletion and update events","description":"Get a list of events related to the creation, deletion, and updates of card types. The results can be filtered using optional criteria.","operationId":"getCardTypesHistory","parameters":[{"name":"type_ids","in":"query","description":"A list of card type IDs to filter the history results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},{"name":"user_ids","in":"query","description":"A list of user IDs who performed the actions.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"The types of actions performed on the card types.","required":false,"schema":{"items":{"type":"string","enum":["type_created","type_updated","type_disabled","type_enabled","type_deleted","type_added_to_board","type_updated_for_board","type_removed_from_board"]}},"explode":false,"example":"type_created,type_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of card types creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTypeHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardTypesHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTypes\/deleteMany":{"post":{"tags":["Card type Delete Many"],"summary":"Delete many card types","description":"Schedule multiple card types for deletion in a single request. Card types are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyCardTypes","requestBody":{"content":{"application\/json":{"schema":{"description":"Card type IDs data.","type":"object","required":["type_ids"],"properties":{"type_ids":{"description":"A list of card type IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"type_ids":[1,2]}}}},"responses":{"204":{"description":"The card types have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTypes\/disableMany":{"post":{"tags":["Card type Disable Many"],"summary":"Disable many card types","description":"Schedule multiple card types for disabling in a single request. Card types are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyCardTypes","requestBody":{"content":{"application\/json":{"schema":{"description":"Card type IDs data.","type":"object","required":["type_ids"],"properties":{"type_ids":{"description":"A list of card type IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"type_ids":[1,2]}}}},"responses":{"204":{"description":"The card types have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cardTypes\/enableMany":{"post":{"tags":["Card type Enable Many"],"summary":"Enable many card types","description":"Schedule multiple card types for enabling in a single request. Card types are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyCardTypes","requestBody":{"content":{"application\/json":{"schema":{"description":"Card type IDs data.","type":"object","required":["type_ids"],"properties":{"type_ids":{"description":"A list of card type IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"type_ids":[1,2]}}}},"responses":{"204":{"description":"The card types have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/{card_id}\/watched":{"get":{"tags":["Card Watched"],"summary":"Check if the current user is a watcher of a card","description":"Check whether the current user is a watcher of the specified card. If the user is not a watcher, a 404 error will be returned. \n\n You can see a list of all cards in the [cards](#operations\/getCards#Request) endpoint.","operationId":"checkCurrentUserIsCardWatcher","responses":{"204":{"description":"The current user is a watcher of the card. Otherwise, you would have gotten a 404 error."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Watched"],"summary":"Add the current user as a watcher of a card","description":"Add the current user as a watcher of the specified card. This action allows the user to receive updates and notifications related to the card. \n\n You can see a list of all cards in the [cards](#operations\/getCards#Request) endpoint.","operationId":"addCurrentUserForCardWatcher","responses":{"204":{"description":"The current user has been successfully added as a watcher of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Watched"],"summary":"Remove the current user as a watcher of a card","description":"Remove the current user as a watcher of the specified card. This action stops the user from receiving updates and notifications related to the card. \n\n You can see a list of all cards in the [cards](#operations\/getCards#Request) endpoint.","operationId":"removeCurrentUserCardWatcher","responses":{"204":{"description":"The current user has been successfully removed as a watcher of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/watchers":{"get":{"tags":["Card Watchers"],"summary":"Get a card's watchers","description":"Retrieve a list of the users assigned as a card's watchers.","operationId":"getCardWatchers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of card watchers.","type":"array","items":{"title":"Watcher","type":"object","properties":{"user_id":{"description":"The ID of a user who is a watcher of the card.","format":"int32","type":"integer"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardWatchersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/watchers\/{user_id}":{"get":{"tags":["Card Watchers"],"summary":"Check if a user is a watcher of a card","description":"Determine if a user is assigned as a watcher of a specific card.","operationId":"checkUserIsCardWatcher","responses":{"204":{"description":"The user is a watcher of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Card Watchers"],"summary":"Add a watcher of a card","description":"Assign a user as a watcher of a specific card. Watching cards allows users to receive notifications for any changes that have been made on a certain card, even if they are not subscribed to get notifications from the board where the card is located.","operationId":"addCardWatcher","responses":{"204":{"description":"The user is now a watcher of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Card Watchers"],"summary":"Remove a watcher of a card","description":"Remove a user as a watcher of a specific card.","operationId":"removeCardWatcher","responses":{"204":{"description":"The user is no longer a watcher of the card."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/cards":{"get":{"tags":["Cards"],"summary":"Get a list of cards","description":"Retrieve a list of all of the cards on an account. The results can be filtered using optional criteria.","operationId":"getCards","parameters":[{"name":"card_ids","in":"query","description":"Get a list of details for specific cards by their IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"board_ids","in":"query","description":"A list of board IDs for which you want get a list of cards.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},{"name":"workflow_ids","in":"query","description":"A list of workflows IDs for which you want to get a list of cards.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"20,21"},{"name":"state","in":"query","description":"Get a list of cards according to their current state.","schema":{"type":"string","enum":["active","archived","discarded"]},"explode":false},{"name":"created_from","in":"query","description":"The earliest creation date and time for cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"created_from_date","in":"query","description":"The earliest creation date for cards to include in the results, , in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"created_to","in":"query","description":"The latest creation date and time for cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"created_to_date","in":"query","description":"The latest creation date for cards to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"last_modified_from","in":"query","description":"The earliest date and time a card was last modified to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"last_modified_from_date","in":"query","description":"The earliest date a card was last modified to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"last_modified_to","in":"query","description":"The latest date and time a card was last modified to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"last_modified_to_date","in":"query","description":"The latest date a card was last modified to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"in_current_position_since_from","in":"query","description":"The earliest date and time when a card entered its current position to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"in_current_position_since_from_date","in":"query","description":"The earliest date when a card entered its current position to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"in_current_position_since_to","in":"query","description":"The latest date and time when a card entered its current position to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"in_current_position_since_to_date","in":"query","description":"The latest date and time when a card entered its current position to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"is_blocked","in":"query","description":"Set to `1` to return only blocked cards, or `0` to return only non-blocked cards.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"custom_ids","in":"query","description":"A list of the custom card IDs for which you want to get the results.","required":false,"schema":{"items":{"type":"string"}},"explode":false,"example":"custom-id-1,custom-id-2"},{"name":"owner_user_ids","in":"query","description":"A list of user IDs. Returns cards where each specified user is assigned as the owner.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"type_ids","in":"query","description":"A list of card type IDs. Returns cards that have any of the specified card types assigned.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},{"name":"sizes","in":"query","description":"A list of size values. Returns cards that match any of the specified sizes.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2,3"},{"name":"priorities","in":"query","description":"A list of priority values. Returns cards that have any of the specified priorities assigned.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","required":false,"schema":{"items":{"format":"int32","type":"integer","minimum":1,"maximum":250}},"explode":false,"example":"2,3"},{"name":"colors","in":"query","description":"A list of colors. Returns cards that have any of the specified colors assigned.","required":false,"schema":{"items":{"type":"string"}},"explode":false,"example":"ff0000,00ff00,0000ff"},{"name":"deadline_from","in":"query","description":"The earliest deadline date and time for cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"deadline_from_date","in":"query","description":"The earliest deadline date for cards to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"deadline_to","in":"query","description":"The latest deadline date and time for cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"deadline_to_date","in":"query","description":"The latest deadline date for cards to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"first_start_from","in":"query","description":"The earliest date and time when a card was first started to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"first_start_to","in":"query","description":"The latest date and time when a card was first started to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"first_start_from_date","in":"query","description":"The earliest date when a card was first started to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"first_start_to_date","in":"query","description":"The latest date when a card was first started to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"first_end_from","in":"query","description":"The earliest date and time when a card was first completed (first end) to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"first_end_to","in":"query","description":"The latest date and time when a card was first completed (first end) to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"first_end_from_date","in":"query","description":"The earliest date when a card was first completed (first end) to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"first_end_to_date","in":"query","description":"The latest date when a card was first completed (first end) to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"last_start_from","in":"query","description":"The earliest date and time when a card was last started to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"last_start_to","in":"query","description":"The latest date and time when a card was last started to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"last_start_from_date","in":"query","description":"The earliest date when a card was last started to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"last_start_to_date","in":"query","description":"The latest date when a card was last started to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"last_end_from","in":"query","description":"The earliest date and time when a card was last completed (last end) to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"last_end_to","in":"query","description":"The latest date and time when a card was last completed (last end) to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"last_end_from_date","in":"query","description":"The earliest date when a card was last completed (last end) to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"last_end_to_date","in":"query","description":"The latest date when a card was last completed (last end) to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"column_ids","in":"query","description":"A list of the column IDs for which you want to get the results. Applied only if 'state' parameter is 'active'.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"23,24"},{"name":"lane_ids","in":"query","description":"A list of the lane IDs for which you want to get the results. Applied only if 'state' parameter is 'active'.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"33,34"},{"name":"sections","in":"query","description":"A list of board sections for which you want to get the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"last_column_ids","in":"query","description":"A list of last column IDs. Returns cards where the last column matches any of the specified IDs. This filter is only applied when the 'state' parameter is set to 'archived' or 'discarded'.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"23,24"},{"name":"last_lane_ids","in":"query","description":"A list of last lane IDs. Returns cards where the last lane matches any of the specified IDs. This filter is only applied when the 'state' parameter is set to 'archived' or 'discarded'.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"33,34"},{"name":"version_ids","in":"query","description":"A list of card version IDs. Returns cards that are associated with any of the specified versions.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"archived_from","in":"query","description":"The earliest date and time when an archived card should be included in the results, in `YYYY-MM-DD HH:mm:ss` format. Should be used with parameter `state=archived`.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"archived_from_date","in":"query","description":"The earliest date when an archived card should be included in the results, in `YYYY-MM-DD` format.Should be used with parameter `state=archived`.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"archived_to","in":"query","description":"The latest date and time when an archived card should be included in the results, in `YYYY-MM-DD HH:mm:ss` format. Should be used with parameter `state=archived`.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"archived_to_date","in":"query","description":"The latest date when an archived card should be included in the results, in `YYYY-MM-DD` format. Should be used with parameter `state=archived`.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"reason_ids","in":"query","description":"A list of the reasons IDs for which you want to get the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"discarded_from","in":"query","description":"TThe earliest date and time for discarded cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format. Should be used with parameter `state=discarded`.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"discarded_from_date","in":"query","description":"The earliest date for discarded cards to include in the results, in `YYYY-MM-DD` format. Should be used with parameter `state=discarded`.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"discarded_to","in":"query","description":"The latest date and time for discarded cards to include in the results, in `YYYY-MM-DD HH:mm:ss` format. Should be used with parameter `state=discarded`.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"discarded_to_date","in":"query","description":"The latest date for discarded cards to include in the results, in `YYYY-MM-DD` format. Should be used with parameter `state=discarded`.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"include_logged_time_for_subtasks","in":"query","description":"Controls whether logged times for subtasks are included.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"include_logged_time_for_child_cards","in":"query","description":"Controls whether logged times for child cards are included.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `200` and the maximum is `1000`.","required":false,"schema":{"format":"int","type":"integer","default":200,"maximum":1000}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["card_id","title","description","custom_id","owner_user_id","type_id","size","priority","color","deadline","reporter","created_at","revision","last_modified","in_current_position_since","board_id","workflow_id","column_id","lane_id","section","position","last_column_id","last_lane_id","version_id","archived_at","reason_id","discard_comment","discarded_at","is_blocked","block_reason","current_block_time","current_logged_time","current_cycle_time","child_card_stats","finished_subtask_count","unfinished_subtask_count","comment_count","last_comment","first_request_time","first_start_time","first_end_time","last_request_time","last_start_time","last_end_time"]}},"explode":false},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["custom_fields","stickers","tag_ids","milestone_ids","co_owner_ids","watcher_ids","attachments","cover_image","checked_column_checklist_items","initiative_details","annotations","subtasks","linked_cards","transitions","block_times","logged_times","logged_times_for_child_cards","lead_time_per_column","card_outcomes","last_comment"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of cards.","type":"array","items":{"$ref":"#\/components\/schemas\/Cards"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Cards"],"summary":"Create a card","description":"Cards always require the lane and column of the board where they will be created. For more information about a board's structure, please see the **[Current structure](#\/paths\/boards-board_id--currentStructure\/get#Requestt)** endpoint.\n\nMost cards are initially placed in the **Requested** column of a specific lane, depending on the workflow. Standard cards are typically created in the **Cards Workflow**, while initiatives belong to the **Initiatives Workflow**.\n\nCards can also be created in a **Timeline Workflow**, depending on the use case and board setup.\n\n\n> #### Info\n>\n> If you'd like to create multiple cards at once, you can use the [\/cards\/createMany](#\/operations\/createManyCards) endpoint to create several cards at once.\n>\n> This bulk creation method helps you reduce network overhead, speed up your workflows, and improve overall performance by batching operations into a single API call.\n","operationId":"createCard","requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/CardCreateRequest"},{"type":"object","properties":{"exceeding_reason":{"description":"The reason for exceeding a limit, such as the maximum number of cards in a lane or column.","type":"string","nullable":true},"reporter_user_id":{"description":"The user ID of the reporter if the card is created on behalf of someone else.","type":"integer","nullable":true},"reporter_email":{"description":"The email of the reporter if the card is created on behalf of someone else without a known user ID.","format":"email","type":"string","nullable":true}}}]},"example":{"$ref":"#\/components\/requestExamples\/CardCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards.","type":"array","items":{"allOf":[{"$ref":"#\/components\/schemas\/Card"},{"$ref":"#\/components\/schemas\/CardInitiativeDetails"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/{card_id}":{"get":{"tags":["Cards"],"summary":"Get the details of a specific card","description":"Retrieve the details of a specific card.\n\n\n> #### Info\n>\n> You can use the [GET \/cards](#\/operations\/getCards) endpoint with the `card_ids` query parameter to retrieve multiple cards in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/Card"},{"$ref":"#\/components\/schemas\/CardInitiativeDetails"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Cards"],"summary":"Update a card","description":"Make an update to a card's details.\n\n\n\n> #### Info\n>\n> If you'd like to update multiple cards at once, you can use the [\/cards\/updateMany](#\/operations\/updateManyCards) endpoint to update several cards at once.\n>\n> This bulk update method helps you reduce network overhead, speed up your workflows, and improve overall performance by batching operations into a single API call.\n","operationId":"updateCard","requestBody":{"content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/CardUpdateRequest"},{"type":"object","properties":{"exceeding_reason":{"description":"The reason for exceeding a limit, such as the maximum number of cards in a lane or column.","type":"string","nullable":true},"reporter_user_id":{"description":"The user ID of the reporter of converted subtasks if the subtasks are converted on behalf of someone else.","type":"integer","nullable":true},"reporter_email":{"description":"The email of the reporter of converted subtasks if the subtasks are converted on behalf of someone else without a known user ID.","format":"email","type":"string","nullable":true}}}]},"example":{"$ref":"#\/components\/requestExamples\/CardUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/Card"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Cards"],"summary":"Delete a card","description":"Delete an existing card card. The card is **permanently** deleted from the account and **cannot** be recovered.\n\n\n\n> #### Info\n>\n> If you'd like to delete multiple cards at once, you can use the [\/cards\/deleteMany](#\/operations\/deleteManyCards) endpoint to delete several cards at once.\n>\n> This bulk deletion method helps you reduce network overhead, speed up your workflows, and improve overall performance by batching operations into a single API call.\n","operationId":"deleteCard","parameters":[{"name":"exceeding_reason","in":"query","description":"Reason to exceed a limit.","required":false,"schema":{"type":"string","nullable":true}}],"responses":{"204":{"description":"The card has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/comments":{"get":{"tags":["Cards Comments"],"summary":"Get comments for multiple cards","description":"Retrieve comments associated with multiple cards.","operationId":"getCommentsForMultipleCards","parameters":[{"name":"card_ids","in":"query","description":"A list of card IDs for which you want to retrieve comments.","schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"12345,67890"},{"name":"comment_ids","in":"query","description":"A list of specific comment IDs to retrieve.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"54321,98765"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `200` and the maximum is `1000`.","required":false,"schema":{"format":"int","type":"integer","default":200,"maximum":1000}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of comments.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the card associated with the comment.","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardComment"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCommentsWithCardIdExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/createMany":{"post":{"tags":["Cards Create Many"],"summary":"Create many cards","description":"Create multiple cards in a single request.","operationId":"createManyCards","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to create multiple cards.","type":"object","required":["cards"],"properties":{"cards":{"description":"An array containing the details of the cards to be created.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCreateRequest"}},"exceeding_reason":{"description":"The reason for exceeding limits, if applicable.","type":"string","nullable":true},"reporter_user_id":{"description":"The ID of the created cards' reporter, if created on behalf of someone else.","type":"integer","nullable":true},"reporter_email":{"description":"The email address of the reporter if the cards are created on behalf of someone else without a known user ID.","format":"email","type":"string","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/CardCreateManyRequestExample"}}}},"responses":{"200":{"description":"Successfully created the cards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of the created cards.","type":"array","items":{"$ref":"#\/components\/schemas\/Card"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/deleteMany":{"post":{"tags":["Cards Delete Many"],"summary":"Delete many cards","description":"Delete multiple cards in a single request.","operationId":"deleteManyCards","requestBody":{"content":{"application\/json":{"schema":{"description":"Card ids data.","type":"object","required":["card_ids"],"properties":{"card_ids":{"description":"A list of card IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}},"exceeding_reason":{"description":"Reason to exceed a limit.","type":"string","nullable":true}}},"example":{"card_ids":[12345,67890],"exceeding_reason":"Important"}}}},"responses":{"204":{"description":"The cards have been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/updateMany":{"post":{"tags":["Cards Update Many"],"summary":"Update many cards","description":"Update many cards in a single request.","operationId":"updateManyCards","requestBody":{"content":{"application\/json":{"schema":{"description":"Cards data.","type":"object","required":["cards"],"properties":{"cards":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardUpdateWithCardIdRequest"}},"exceeding_reason":{"description":"Exceeding reason data.","type":"string","nullable":true},"reporter_user_id":{"description":"The user ID of the reporter of converted subtasks if the subtasks are converted on behalf of someone else.","type":"integer","nullable":true},"reporter_email":{"description":"The email of the reporter of converted subtasks if the subtasks are converted on behalf of someone else without a known user ID.","format":"email","type":"string","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/CardUpdateManyRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards.","type":"array","items":{"$ref":"#\/components\/schemas\/Card"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/cellLimits":{"get":{"tags":["Cell Limits"],"summary":"Get a list of cell limits","description":"Get a list of the cell limits for the specified board. A response containing an **empty array** indicates that there are **no cell limits** set for the board.\n\nYou can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.","operationId":"getCellLimits","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cell limits.","type":"array","items":{"$ref":"#\/components\/schemas\/CellLimit"}}}},"example":{"$ref":"#\/components\/responseExamples\/CellLimitsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Cell Limits"],"summary":"Set a cell limit","description":"Set a cell limit for a specific lane and column in the specified board. If a limit **already exists** for the specified lane and column, it will be **updated**. If the limit is set to `0`, it will be **removed**.","operationId":"setCellLimit","requestBody":{"content":{"application\/json":{"schema":{"description":"Cell limit data.","required":["lane_id","column_id","limit"],"type":"object","properties":{"lane_id":{"description":"The unique identifier of the lane.","format":"int32","type":"integer"},"column_id":{"description":"The unique identifier of the column.","format":"int32","type":"integer"},"limit":{"description":"The work in progress (WIP) limit of cards in the cell. You can set it to `0` to remove the limit.","format":"int32","type":"integer","maximum":10000}}},"example":{"lane_id":1085,"column_id":4423,"limit":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CellLimit"}}},"example":{"$ref":"#\/components\/responseExamples\/CellLimitExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/checkDKIMRecord":{"post":{"tags":["Check DKIM Record"],"summary":"Check if the DKIM record of a domain matches the stored key","description":"Check if a domain has a valid DKIM TXT record that matches the stored public key.","operationId":"checkDKIMRecord","requestBody":{"content":{"application\/json":{"schema":{"description":"Domain data.","required":["domain"],"type":"object","properties":{"domain":{"description":"The domain name to be checked for a DKIM record matching the stored key.","type":"string","example":"businessmap.io"}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"boolean"}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/checkSPFRecord":{"post":{"tags":["Check SPF Record"],"summary":"Check if the SPF record of a domain includes mail.kanbanize.com","description":"Check if a domain has a valid SPF record including mail.kanbanize.com.","operationId":"checkSPFRecord","requestBody":{"content":{"application\/json":{"schema":{"description":"Domain data.","required":["domain"],"type":"object","properties":{"domain":{"description":"The domain name to be checked for an SPF record that includes `mail.kanbanize.com`.","type":"string","example":"businessmap.io"}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"boolean"}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/cards\/{card_id}\/children":{"get":{"tags":["Child Cards"],"summary":"Get a list of child cards of a specified parent card","description":"Retrieves a list of child cards associated with the specified parent card.","operationId":"getChildCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of child cards.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The unique identifier of the child card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/LinkedCard"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/cards\/{card_id}\/children\/{child_card_id}":{"get":{"tags":["Child Cards"],"summary":"Check if a card is a child of a specified parent card","description":"Checks if a card is a child of the specified parent card and returns its position within the parent's list of linked cards.","operationId":"checkChildCard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LinkedCard"}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Child Cards"],"summary":"Set a card as a child of a specified parent card","description":"Assigns the specified card as a child of a specified parent card, establishing a parent\u2013child relationship between them.","operationId":"addChildCard","requestBody":{"content":{"application\/json":{"schema":{"description":"Link data.","type":"object","properties":{"linked_card_position":{"description":"The position of the child card within the parent's list of linked cards. `0` represents the first position.","format":"int32","type":"integer"},"card_position":{"description":"The position of the parent card within the child's list of linked cards. `0` represents the first position.","format":"int32","type":"integer"},"exceeding_reason":{"description":"The reason for exceeding the specified limit.","type":"string","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/CardAddChildCardExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"position":{"description":"The position of the child card within the parent's list of linked cards.","format":"int32","type":"integer"}}}}},"example":{"$ref":"#\/components\/responseExamples\/CardLinkedCardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Child Cards"],"summary":"Remove the link between a parent card and a child card","description":"Remove the link between a parent card and a child card.","operationId":"removeChildCard","parameters":[{"name":"exceeding_reason","in":"query","description":"The reason for exceeding the specified limit.","required":false,"schema":{"type":"string","nullable":true}}],"responses":{"204":{"description":"The parent\u2013child relationship between the two cards has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"},{"name":"child_card_id","in":"path","description":"A child card ID.","required":true,"schema":{"format":"int32","type":"integer"}}]},"\/cards\/{card_id}\/childGraph":{"get":{"tags":["Child Cards"],"summary":"Get a hierarchical graph of a card's children","description":"Retrieves the hierarchical structure of a specified card's child relationships in the form of a graph.\nA card can have one or more direct children (Level 1), and each child can have its own children (Level 2).\nThe `depth` parameter indicates the level of the child in the hierarchy, relative to the original parent card:\n- `1` - Direct child of the specified card.\n- `2` - Child of a Level 1 card.\n- `3` - Child of a Level 2 card, and so on.\n","operationId":"getChildCardGraph","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of child cards.","type":"array","items":{"$ref":"#\/components\/schemas\/ParentChildLink"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardChildGraphExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/cardIdInPath"}]},"\/boards\/{board_id}\/columns":{"get":{"tags":["Columns"],"summary":"Get a list of columns for a specific board","description":"Get a list of columns available on the specified board. \n\n You can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.","operationId":"getColumns","parameters":[{"name":"fields","in":"query","description":"A list of specific fields to include in the response.","schema":{"items":{"type":"string","enum":["column_id","workflow_id","section","parent_column_id","position","name","description","color","limit","cards_per_row","flow_type","card_ordering","card_progress","card_progress_size_type"]}},"example":"column_id, workflow_id, section, parent_column_id, position, name, description, color, limit, cards_per_row, flow_type, card_ordering, card_progress card_progress_size_type","explode":false}],"responses":{"200":{"description":"Successfully retrieved the list of columns for the specified board.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of columns with their details.","type":"array","items":{"allOf":[{"type":"object","properties":{"column_id":{"description":"The ID of the column.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Column"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/ColumnsGetResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Columns"],"summary":"Create a column","description":"Create a new column.\n\n You can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.\n\n You can see a list of all workflows in a board in the [workflows](#operations\/getWorkflows#Request) endpoint.","operationId":"createColumn","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to create a new column.","oneOf":[{"title":"Column main","description":"Data required to create a new main column.","required":["workflow_id","section","position","name"],"allOf":[{"$ref":"#\/components\/schemas\/ColumnMain"},{"$ref":"#\/components\/schemas\/ColumnCreated"}]},{"title":"Column subcolumn","description":"Column data for a subcolumn.","required":["parent_column_id","position","name"],"allOf":[{"$ref":"#\/components\/schemas\/ColumnSubcolumn"},{"$ref":"#\/components\/schemas\/ColumnCreated"}]}]},"example":{"$ref":"#\/components\/requestExamples\/ColumnCreateExample"}}}},"responses":{"200":{"description":"Successfully created the column.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"$ref":"#\/components\/schemas\/ColumnMain"},{"$ref":"#\/components\/schemas\/ColumnCreated"},{"$ref":"#\/components\/schemas\/ColumnSubcolumn"},{"type":"object","properties":{"column_id":{"description":"The ID of the created column.","format":"int32","type":"integer"}}}]}}},"example":{"$ref":"#\/components\/responseExamples\/ColumnCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/columns\/{column_id}":{"get":{"tags":["Columns"],"summary":"Get the details of a specific column","description":"Get the details of a specific column on a board.\n\n You can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.\n\n You can see a list of all columns in a board in the [columns](#operations\/getColumns#Request) endpoint.","operationId":"getColumn","responses":{"200":{"description":"Successfully retrieved the details of the specified column.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Column"}}},"example":{"$ref":"#\/components\/responseExamples\/ColumnGetResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Columns"],"summary":"Update a column","description":"Update the details of a specific column\n\n You can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.\n\n You can see a list of all columns in a board in the [columns](#operations\/getColumns#Request) endpoint.\n\n You can see a list of all workflows in a board in the [workflows](#operations\/getWorkflows#Request) endpoint.","operationId":"updateColumn","requestBody":{"content":{"application\/json":{"schema":{"description":"Data required to update a column.","oneOf":[{"title":"Update main column","description":"Data to update a main column.","allOf":[{"type":"object","properties":{"section":{"description":"The section of the workflow where the column is located. Valid values are:\n - `1` - Backlog\n - `2` - Requested\n - `3` - Progress\n - `4` - Done\n Adding columns to the **Archive area**, section `5`, is not allowed.","format":"int32","type":"integer","enum":[1,2,3,4]}}},{"$ref":"#\/components\/schemas\/ColumnUpdated"}]},{"title":"Update subcolumn","description":"Data to update a subcolumn.","allOf":[{"type":"object","properties":{"parent_column_id":{"description":"The ID of the parent column, if the column is part of a hierarchical structure.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/ColumnUpdated"}]}]},"example":{"$ref":"#\/components\/requestExamples\/ColumnUpdateExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Column"}}},"example":{"$ref":"#\/components\/responseExamples\/ColumnUpdateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Columns"],"summary":"Delete a column from a board","description":"Delete a specific column from a board. Optionally, you can specify another column to move the cards and\/or cycle time data from the deleted column. If no column is specified for the cycle time data, it will be discarded.","operationId":"deleteColumn","parameters":[{"name":"move_cards_to_column_id","in":"query","description":"The ID of the column to which the cards from the deleted column should be moved, if any.","required":false,"schema":{"format":"int32","type":"integer"},"example":{"move_cards_to_column_id":1001}},{"name":"move_metrics_to_column_id","in":"query","description":"The ID of the column to which the cycle time data from the deleted column should be moved, if any. If not provided or set to `null`, the cycle time data will be discarded.","required":false,"schema":{"format":"int32","type":"integer"},"example":{"move_metrics_to_column_id":1001}}],"responses":{"204":{"description":"The column has been successfully deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/columnIdInPath"}]},"\/companySettings":{"get":{"tags":["Company Settings"],"summary":"Get a list of all company settings and their values","description":"Get a list of all company settings and their values.","operationId":"getCompanySettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of settings.","type":"array","items":{"$ref":"#\/components\/schemas\/Setting"}}}},"example":{"$ref":"#\/components\/responseExamples\/CompanySettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/companySettings\/{setting_name}":{"get":{"tags":["Company Settings"],"summary":"Get the details of a company setting and its current value","description":"Get the details of a company setting and its current value.","operationId":"getCompanySetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Setting"}}},"example":{"$ref":"#\/components\/responseExamples\/CompanySettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Company Settings"],"summary":"Set the value of a company setting","description":"Set the value of a company setting.","operationId":"setCompanySetting","requestBody":{"content":{"application\/json":{"schema":{"description":"Represents the setting's value, which can be either an `integer` or a `string`.","required":["value"],"type":"object","properties":{"value":{"description":"The value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}]}}},"example":{"$ref":"#\/components\/requestExamples\/CompanySettingUpdateExample"}}}},"responses":{"204":{"description":"The setting's value was successfully updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Company Settings"],"summary":"Remove the value of a company setting","description":"Removes the value of a company setting and sets it to `null`. When a company setting is `null`, it behaves according to its default value.\n\nAfter removing a setting, the [companySettings endpoint](#\/operations\/getCompanySettings#Request) will return the default value of the setting, while the [companySetting\/{setting_name} endpoint](#\/operations\/getCompanySetting#Request) will return `null`.","operationId":"removeCompanySetting","responses":{"204":{"description":"The setting's value has been set to `null` and reverted to its default value."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/settingName"}]},"\/customFields\/{field_id}\/allowedValues":{"get":{"tags":["Custom Field Allowed Values"],"summary":"Get a list of the allowed values for a custom field of type dropdown","description":"Get a list of the allowed values for a custom field of type `dropdown`.\n\n You can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"getCustomFieldAllowedValues","responses":{"200":{"description":"Successfully retrieved the list of allowed values for the specified custom field.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of allowed values for the `dropdown` custom field.","type":"array","items":{"allOf":[{"type":"object","properties":{"value_id":{"description":"The ID of the allowed value.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldAllowedValue"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldAllowedValuesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Custom Field Allowed Values"],"summary":"Create a new allowed value for a dropdown custom field","description":"Add a new allowed value to a dropdown custom field.\n\nYou can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.\n\n\n> #### Info\n>\n> If the allowed value is created at the **global** level after the custom field has already been assigned to a board, it will not appear on the existing board. **Globally** added allowed values will only be applied to boards after the custom field is assigned to them.\n","operationId":"createCustomFieldAllowedValue","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to create a new allowed value for a dropdown custom field.","required":["value"],"type":"object","properties":{"position":{"description":"The position of the value within the dropdown list. `0` represents the first position.","format":"int32","type":"integer"},"is_enabled":{"description":"Indicates whether the value is enabled.\n - `0`: Not enabled\n - `1`: Enabled","format":"int32","type":"integer","default":1,"enum":[0,1]},"is_default":{"description":"Indicates whether the value is selected by default.\n - `0`: Not default\n - `1`: Default","format":"int32","type":"integer","default":0,"enum":[0,1]},"value":{"description":"The actual value to be added to the dropdown.","type":"string","minLength":1,"maxLength":250}}},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldAllowedValueExample"}}}},"responses":{"200":{"description":"Successfully created the allowed value.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"value_id":{"description":"The ID of the created allowed value.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldAllowedValue"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldAllowedValueCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/{field_id}\/allowedValues\/{value_id}":{"get":{"tags":["Custom Field Allowed Values"],"summary":"Get the details of a specific allowed value for a dropdown custom field","description":"Get the details of a specific allowed value for a `dropdown` custom field.\n\n You can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"getCustomFieldAllowedValue","responses":{"200":{"description":"Successfully retrieved the details of the specified allowed value.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldAllowedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Custom Field Allowed Values"],"summary":"Update an allowed value","description":"Update the properties of a specific allowed value for a `dropdown` custom field.\n\n You can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"updateCustomFieldAllowedValue","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to update an allowed value for a dropdown custom field.","type":"object","properties":{"position":{"description":"The position of the value within the dropdown list. `0` represents the first position.","format":"int32","type":"integer"},"is_enabled":{"description":"Indicates whether the value is enabled.\n - `0`: Not enabled\n - `1`: Enabled","format":"int32","type":"integer","enum":[0,1]},"is_default":{"description":"Indicates whether the value is selected by default.\n - `0`: Not default\n - `1`: Default","format":"int32","type":"integer","enum":[0,1]},"value":{"description":"The updated value for the dropdown option.","type":"string","minLength":1,"maxLength":250}}},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldAllowedValueExample"}}}},"responses":{"200":{"description":"Successfully updated the allowed value.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValue"}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldAllowedValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Custom Field Allowed Values"],"summary":"Delete an allowed value from a dropdown custom field","description":"Delete a specific allowed value from a dropdown custom field.\n\n Optionally, you can specify another value to replace the deleted value on cards where it is currently used. If no replacement value is provided, the deleted value will simply be removed.\n\n You can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"deleteCustomFieldAllowedValue","parameters":[{"name":"replace_with_value_id","in":"query","description":"The ID of the value to replace the deleted value on cards where it is currently used. If not provided, the value will be removed without replacement.","required":false,"schema":{"format":"int32","type":"integer"},"example":{"replace_with_value_id":1001}}],"responses":{"204":{"description":"The allowed value has been successfully deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"},{"$ref":"#\/components\/parameters\/valueIdInPath"}]},"\/customFields\/{field_id}\/batchAllowedValueOperations":{"post":{"tags":["Custom Field Allowed Values"],"summary":"Manage allowed values for a dropdown custom field","description":"Perform batch operations to create, update, or delete allowed values for a dropdown custom field.\n\nYou can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.\n\n\n> #### Info\n>\n> If the allowed value is created at the **global** level after the custom field has already been assigned to a board, it will not appear on the existing board. **Globally** added allowed values will only be applied to boards after the custom field is assigned to them.\n","operationId":"updateCustomFieldAllowedValues","requestBody":{"content":{"application\/json":{"schema":{"description":"Data to manage allowed values for a dropdown custom field.","type":"object","properties":{"values_to_create":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValueCreateRequest"},"values_to_update":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValueUpdateRequest"},"values_to_delete":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValueDeleteRequest"}}},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldAllowedValueBatchOperationsExample"}}}},"responses":{"200":{"description":"Successfully performed the batch operations on allowed values.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CustomFieldAllowedValueBatchOperationsResponse"}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldAllowedValueBatchOperationsResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/{field_id}\/boards":{"get":{"tags":["Custom Field Boards"],"summary":"Get a list of the boards where the specified custom field is available","description":"Retrieve a list of the boards where the specified custom field is available, including the properties of the field on each board.\n\nIf the values of the custom field's properties are set to `null`, it means that no changes were done on a board level, and the properties are set to their default values. To check the default values of the custom field properties, you can call the [customFields\/{field_id} endpoint](#operations\/getCustomFields#Request) endpoint.\n\nYou can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"getCustomFieldBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of board custom field properties.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/{field_id}\/batchBoardOperations":{"post":{"tags":["Custom Field Boards"],"summary":"Change the availability of a custom field on one or more boards","description":"Change the availability of a custom field on one or more boards.\n\nThe response body **will not** include boards from which the custom field is removed, even if you attempt to remove it from a board where it is **already unavailable**\r\n\r\n> ### Info\r\n>\r\n> If the request body contains only `board_ids_to_remove`, the response will contain an **empty array**.","operationId":"updateCustomFieldBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Custom field boards data.","type":"object","properties":{"boards_to_add_or_update":{"description":"A list of board IDs where the custom field should be made available or its availability updated.","type":"array","items":{"required":["board_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board where the custom field should be made available or have its availability updated."},"color":{"type":"string","description":"The color of the custom field on a board level in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards on the board.","enum":[0,1],"default":0,"nullable":true},"position":{"description":"The position of the custom field on a board level. `0` is the first position. If you don't specify a position, the custom field will be added to the **end** of the list.","format":"int32","type":"integer","default":0}}}},"board_ids_to_remove":{"description":"A list of board IDs where the custom field should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldBoardsBatchOperationsExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLineWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLineWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumberWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDateWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLinkWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdownWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributorWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFileWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVoteWithBoardId"},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPickerWithBoardId"}]}}]}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldBoardsBatchOperationsResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/{field_id}\/cards":{"get":{"tags":["Custom Field Cards"],"summary":"Get a list of cards with a specific custom field and their values","description":"Get a list of cards to which a specific custom field has been added, along with the associated values for that field.\n\n You can see a list of all custom fields in the [customFields](#operations\/getCustomFields#Request) endpoint.","operationId":"getCustomFieldCards","responses":{"200":{"description":"Successfully retrieved the list of cards and their custom field values.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of custom field values for the cards.","type":"array","items":{"allOf":[{"type":"object","properties":{"card_id":{"description":"The ID of the card.","format":"int32","type":"integer"}}},{"oneOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPicker"}]}]}}}},"example":{"data":[{"card_id":1000,"value":"string","display_value":"string"},{"card_id":1001,"value":"string","display_value":"#string#"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/history":{"get":{"tags":["Custom Field History"],"summary":"Get a list of custom field management history events.","description":"Get a list of custom field management history events.","operationId":"getCustomFieldHistory","parameters":[{"name":"field_ids","in":"query","description":"A list of IDs of the custom fields for which you want to retrieve the history.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101"},{"name":"event_types","in":"query","description":"The types of actions performed on the custom fields. Possible values include:\n - `field_created`: Custom field was created\n - `field_updated`: Custom field was updated\n - `field_disabled`: Custom field was disabled\n - `field_enabled`: Custom field was enabled\n - `field_deleted`: Custom field was deleted\n - `field_added_to_board`: Custom field was added to a board\n - `field_updated_for_board`: Custom field was updated for a board\n - `field_removed_from_board`: Custom field was removed from a board\n - `allowed_value_created`: Allowed value was created\n - `allowed_value_updated`: Allowed value was updated\n - `allowed_value_deleted`: Allowed value was deleted\n - `allowed_value_disabled`: Allowed value was disabled\n - `allowed_value_enabled`: Allowed value was enabled\n - `allowed_value_added_to_board`: Allowed value was added to a board\n - `allowed_value_updated_for_board`: Allowed value was updated for a board\n - `allowed_value_removed_from_board`: Allowed value was removed from a board\n - `default_contributor_added_to_board`: Default contributor was added to a board\n - `default_contributor_removed_from_board`: Default contributor was removed from a board","required":false,"schema":{"items":{"type":"string","enum":["field_created","field_updated","field_disabled","field_enabled","field_deleted","field_added_to_board","field_updated_for_board","field_removed_from_board","allowed_value_created","allowed_value_updated","allowed_value_deleted","allowed_value_disabled","allowed_value_enabled","allowed_value_added_to_board","allowed_value_updated_for_board","allowed_value_removed_from_board","default_contributor_added_to_board","default_contributor_removed_from_board"]}},"explode":false,"example":"field_created,field_added_to_board,field_updated"},{"name":"user_ids","in":"query","description":"A list of user IDs who performed the actions.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2"},{"name":"from","in":"query","description":"The starting date and time for retrieving results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The ending date and time for retrieving results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The starting date for retrieving results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The ending date for retrieving results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"The page number to retrieve. Defaults to the **first** page if not specified. Results are always paginated.","required":false,"schema":{"format":"int32","type":"integer"},"example":1},{"name":"per_page","in":"query","description":"The number of results to return per page. Defaults to `100`, with a maximum of `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200},"example":100}],"responses":{"200":{"description":"Successfully retrieved the list of custom field management history events.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of custom field management history events.","type":"array","items":{"$ref":"#\/components\/schemas\/CustomFieldHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/customFields":{"get":{"tags":["Custom Fields"],"summary":"Get a list of custom fields","description":"Retrieves a list of custom fields with their relevant details, optionally filtered using various parameters.\nThe available custom field types are:\n- `single_line_text` \u2013 A single-line text input.\n- `multi_line_text` \u2013 A multi-line text input for longer content.\n- `number` \u2013 A numeric value.\n- `date` \u2013 A calendar date. It can include a time component, if `include_time` is enabled.\n- `link` \u2013 A valid URL, typically used to reference external resources.\n- `dropdown` \u2013 A selection from a predefined list of options.\n- `contributor` \u2013 One or more users assigned as contributors.\n- `file` \u2013 A file upload field.\n- `vote` \u2013 A voting-style field for gathering preferences.\n- `card_picker` \u2013 A field for selecting a card reference based on the specified filters.\n- `calculated_number` \u2013 A number field with a value calculated from card fields (which can include other custom fields) or manually input values.\n- `calculated_date` \u2013 A date field with a value calculated from card fields (which can include other custom fields) or manually input values.\n","operationId":"getCustomFields","parameters":[{"name":"field_ids","in":"query","description":"A list of custom field IDs used to filter the returned custom fields.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"name","in":"query","description":"Filters custom fields by their exact name.","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the custom fields.\n\nA value of `0` represents **On-demand**, meaning the custom field can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the custom field is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the custom field is automatically added to all boards across all workspaces. Once a custom field's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"example":"0,1","explode":false},{"name":"is_enabled","in":"query","description":"Filters custom fields based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_immutable","in":"query","description":"Filters custom fields based on whether they are immutable, i.e. once the custom field is added to a card and a value is set, that value can't be changed anymore.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_always_present","in":"query","description":"Filters custom fields based on whether they are always present, i.e. they must be present on all cards on the board to which the custom field is added.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"types","in":"query","description":"A list of the types of custom fields you want to retrieve.","schema":{"items":{"type":"string","enum":["single_line_text","multi_line_text","number","date","link","dropdown","contributor","file","vote","card_picker","calculated_number","calculated_date"]}},"example":"single_line_text,multi_line_text","explode":false},{"name":"expand","in":"query","description":"A list of properties for which additional details should be included in the response.","schema":{"items":{"type":"string","enum":["allowed_values","boards","board_count","card_count","outcome_count","default_contributors","business_rules"]}},"example":"allowed_values,boards","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of custom fields.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedDateWithFieldId"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Custom Fields"],"summary":"Create a custom field","description":"Create a new custom field. In order to add a custom field to one or more boards you can use the [customFields\/{field_id}\/batchBoardOperations endpoint](#\/operations\/updateCustomFieldBoards).","operationId":"createCustomField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestSingleLine"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestMultiLine"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestNumber"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestDate"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestLink"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestDropdown"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestContributor"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestFile"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestVote"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCardPicker"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCalculatedNumber"},{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCalculatedDate"}]},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCardPickerWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedDateWithFieldId"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/customFields\/{field_id}":{"get":{"tags":["Custom Fields"],"summary":"Get the details of the specified custom field","description":"Get the details of the specified custom field.\n\n\n> #### Info\n>\n> You can use the [GET \/customFields](#\/operations\/getCustomFields) endpoint with the `field_ids` query parameter to retrieve multiple custom fields in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getCustomField","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CustomFieldDataCardPicker"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedNumber"},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedDate"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Custom Fields"],"summary":"Update a custom field","description":"Update a custom field.","operationId":"updateCustomField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestSingleLine"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestMultiLine"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestNumber"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestDate"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestLink"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestDropdown"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestContributor"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestFile"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestVote"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCardPicker"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCalculatedNumber"},{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCalculatedDate"}]},"example":{"$ref":"#\/components\/requestExamples\/CustomFieldUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CustomFieldDataCardPicker"}]}}},"example":{"$ref":"#\/components\/responseExamples\/CustomFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Custom Fields"],"summary":"Delete a custom field","description":"Delete a custom field.\r\n\r\n\r\n> ### Warning\r\n>\r\n> This will remove the custom field from **all boards and cards** associated with it. All information entered in the field will be **lost** as well. This action **cannot** be reversed.\r\n","operationId":"deleteCustomField","responses":{"204":{"description":"The custom field has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/fieldIdInPath"}]},"\/customFields\/deleteMany":{"post":{"tags":["Custom field Delete Many"],"summary":"Delete many custom fields","description":"Schedule multiple custom fields for deletion in a single request. Custom fields are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyCustomFields","requestBody":{"content":{"application\/json":{"schema":{"description":"Custom field IDs data.","type":"object","required":["field_ids"],"properties":{"field_ids":{"description":"A list of custom field IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"field_ids":[1,2]}}}},"responses":{"204":{"description":"The custom fields have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/customFields\/disableMany":{"post":{"tags":["Custom field Disable Many"],"summary":"Disable many custom fields","description":"Schedule multiple custom fields for disabling in a single request. Custom fields are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyCustomFields","requestBody":{"content":{"application\/json":{"schema":{"description":"Custom field IDs data.","type":"object","required":["field_ids"],"properties":{"field_ids":{"description":"A list of custom field IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"field_ids":[1,2]}}}},"responses":{"204":{"description":"The custom fields have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/customFields\/enableMany":{"post":{"tags":["Custom field Enable Many"],"summary":"Enable many custom fields","description":"Schedule multiple custom fields for enabling in a single request. Custom fields are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyCustomFields","requestBody":{"content":{"application\/json":{"schema":{"description":"Custom field IDs data.","type":"object","required":["field_ids"],"properties":{"field_ids":{"description":"A list of custom field IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"field_ids":[1,2]}}}},"responses":{"204":{"description":"The custom fields have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/customFieldCategories\/deleteMany":{"post":{"tags":["Custom field category Delete Many"],"summary":"Delete many custom field categories","description":"Schedule multiple custom field categories for deletion in a single request. Custom field categories are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyCustomFieldCategories","requestBody":{"content":{"application\/json":{"schema":{"description":"Custom field category IDs data.","type":"object","required":["category_ids"],"properties":{"category_ids":{"description":"A list of custom field category IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"category_ids":[1,2]}}}},"responses":{"204":{"description":"The custom field categories have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/dataFields":{"get":{"tags":["Data Fields"],"summary":"Get a list of data fields","operationId":"getDataFields","description":"Retrieves a list of data fields with their relevant details, optionally filtered using various parameters.\nThe available data field types are:\n- `single_line_text` \u2013 A single-line text input.\n- `number` \u2013 A numeric value.\n- `date` \u2013 A calendar date.\n- `dropdown` \u2013 A selection from a predefined list of options.\n- `contributor` \u2013 One user assigned as contributor.\n- `calculated_number` \u2013 A number field with manually input values for boards and calculated by a formula type for workspaces based on board values.\n","parameters":[{"name":"data_field_ids","in":"query","description":"A list of data field IDs used to filter the returned data fields.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"name","in":"query","description":"Find a data field by its exact name.","schema":{"type":"string"}},{"name":"is_enabled","in":"query","description":"Filters data fields based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"types","in":"query","description":"A list of the types of data fields you want to retrieve.","schema":{"items":{"type":"string","enum":["single_line_text","number","date","dropdown","contributor","calculated_number"]}},"example":"single_line_text,number","explode":false},{"name":"expand","in":"query","description":"A list of properties for which additional details should be included in the response.","schema":{"items":{"type":"string","enum":["allowed_values","board_ids","board_count","workspace_ids","workspace_count"]}},"example":"board_ids,board_count","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data fields.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataDropdownWithoutAllowedValuesWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataCalculatedNumberWithFieldId"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Data Fields"],"summary":"Create a data field","description":"Create a new data field.\n\nIn order to add a data field to one or more boards you can use the [dataFields\/{data_field_id}\/batchBoardOperations endpoint](#\/operations\/updateDataFieldBoards) and to add a data field to one or more workspaces you can use the [dataFields\/{data_field_id}\/batchWorkspaceOperations endpoint](#\/operations\/updateDataFieldWorkspaces).\n","operationId":"createDataField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestSingleLine"},{"$ref":"#\/components\/schemas\/DataFieldCreateRequestNumber"},{"$ref":"#\/components\/schemas\/DataFieldCreateRequestDate"},{"$ref":"#\/components\/schemas\/DataFieldCreateRequestDropdown"},{"$ref":"#\/components\/schemas\/DataFieldCreateRequestContributor"},{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCalculatedNumber"}]},"example":{"$ref":"#\/components\/requestExamples\/DataFieldCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataDropdownWithFullAllowedValuesAndFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/DataFieldDataCalculatedNumberWithFieldId"}]}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/dataFields\/{data_field_id}":{"get":{"tags":["Data Fields"],"summary":"Get the details of a data field","description":"Get the details of the specified data field.","operationId":"getDataField","parameters":[{"name":"expand","in":"query","description":"A list of properties for which additional details should be included in the response.","schema":{"items":{"type":"string","enum":["allowed_values","boards","workspaces"]}},"example":"allowed_values,boards","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data field data with potential data for boards, workspaces and allowed_values.","type":"array","items":{"title":"Data Field data","type":"object","properties":{"name":{"description":"The name of the data field.","type":"string","minLength":1,"maxLength":255},"description":{"description":"The description of the data field.","type":"string","maxLength":65535,"default":""},"color":{"description":"The color of the data field. This is a hex color code.","type":"string","example":"eceff1"},"is_enabled":{"description":"Indicates whether the data field is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1},"boards":{"description":"A list of boards where the data field is available. This is only returned if the `boards` value is specified in the `expand` query parameter.","type":"array","items":{"title":"Board data field data","type":"object","properties":{"board_id":{"description":"The ID of the board where the data field is available.","format":"int32","type":"integer"},"value":{"description":"The value of the data field on the board.","type":"string","nullable":true},"baseline":{"description":"The baseline value of the data field on the board.","type":"string","nullable":true},"value_is_locked":{"description":"Indicates whether the value is locked on the board.","format":"int32","type":"integer","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type `contributor`.","nullable":true}}}},"workspaces":{"description":"A list of workspaces where the data field is available. This is only returned if the `workspaces` value is specified in the `expand` query parameter.","type":"array","items":{"title":"Workspace data field settings","type":"object","properties":{"value_is_locked_for_all_boards_in_workspace_ids":{"description":"A list of workspaces IDs where the data field has a locked value for all boards in the workspace.","type":"array","items":{"format":"int32","type":"integer"}},"apply_to_all_boards_in_workspace_ids":{"description":"A list of workspaces IDs where the data field is enabled for all boards in the workspace.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_data_fields":{"description":"A list of workspaces where the data field is available.","type":"array","items":{"title":"Workspace data field data","type":"object","properties":{"workspace_id":{"description":"The ID of the workspace where the data field is available.","format":"int32","type":"integer"},"value":{"description":"The value of the data field on the workspace.","type":"string","nullable":true},"baseline":{"description":"The baseline value of the data field on the workspace.","type":"string","nullable":true},"show_in_dashboard":{"description":"Indicates whether to show the data field in the dashboard.","format":"int32","type":"integer","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a dropdown, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type contributor.","nullable":true}}}}}}}}}}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Data Fields"],"summary":"Update a data field","description":"Update a data field.","operationId":"updateDataField","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestSingleLine"},{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestNumber"},{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestDate"},{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestDropdown"},{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestContributor"},{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCalculatedNumber"}]},"example":{"$ref":"#\/components\/requestExamples\/DataFieldUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"$ref":"#\/components\/schemas\/DataFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/DataFieldDataNumber"},{"$ref":"#\/components\/schemas\/DataFieldDataDate"},{"$ref":"#\/components\/schemas\/DataFieldDataDropdownWithFullAllowedValues"},{"$ref":"#\/components\/schemas\/DataFieldDataContributor"},{"$ref":"#\/components\/schemas\/DataFieldDataCalculatedNumber"}]}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Data Fields"],"summary":"Delete a data field","description":"Delete a data field.\r\n\r\n\r\n> ### Warning\r\n>\r\n> This will remove the data field from **all boards and workspaces** associated with it. All information entered in the field will be **lost** as well. This action **cannot** be reversed.\r\n","operationId":"deleteDataField","responses":{"204":{"description":"The data field has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/docs":{"get":{"tags":["Docs"],"summary":"Get a list of docs","description":"Retrieve a list of all docs on an account which the user can access. The results can be filtered using optional criteria.","operationId":"getDocs","parameters":[{"name":"doc_ids","in":"query","description":"Get a list of details for specific docs by their IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"title","in":"query","description":"Filters results to include only docs that match the specified title.","required":false,"schema":{"type":"string"}},{"name":"is_archived","in":"query","description":"Set to `1` to return only archived docs, or `0` to return only non-archived docs.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"show_in_main_doc_list","in":"query","description":"Set to `1` to return only docs that are shown in the main doc list, or `0` to return only docs that are hidden from the main doc list.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_important","in":"query","description":"Set to `1` to return only important docs, or `0` to return only non-important docs.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"for_welcome","in":"query","description":"Set to `1` to return only docs shown on the welcome screen, or `0` to exclude them.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_indexed_for_ai","in":"query","description":"Set to `1` to return only docs indexed for AI, or `0` to return only non-indexed docs.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"parent_doc_ids","in":"query","description":"A list of parent doc IDs. Returns docs that have any of the specified parent doc IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},{"name":"show_predecessors_of_accessible_docs","in":"query","description":"Set to `1` to include predecessor docs of accessible docs in the results.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["fully_hidden_docs","docs_without_owners","permissions"]}},"example":"fully_hidden_docs,docs_without_owners","explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"result":{"description":"A list of docs.","type":"array","items":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"title":{"description":"The title of the doc.","type":"string"},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"author_id":{"description":"The ID of the user who created the doc.","format":"int32","type":"integer"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}},"fully_hidden_docs":{"description":"A list of fully hidden docs. This is only returned if `fully_hidden_docs` is specified in the `expand` query parameter.","type":"array","items":{"type":"object"}},"docs_without_owners":{"description":"A list of docs without owners. This is only returned if `docs_without_owners` is specified in the `expand` query parameter.","type":"array","items":{"type":"object"}}}}}},"example":{"data":{"result":[{"doc_id":123,"parent_doc_id":10,"title":"My Document","is_archived":0,"is_important":1,"position":0,"show_in_main_doc_list":1,"updated_at":"2025-01-15T14:20:00Z","author_id":2,"size":1024},{"doc_id":124,"parent_doc_id":null,"title":"Another Document","is_archived":0,"is_important":0,"position":1,"show_in_main_doc_list":1,"updated_at":"2025-01-14T09:10:00Z","author_id":3,"size":512}],"fully_hidden_docs":[{"doc_id":125,"parent_doc_id":null,"title":"Hidden Document","is_archived":0,"is_important":0,"position":2,"show_in_main_doc_list":0,"updated_at":"2025-01-13T08:00:00Z","author_id":2,"size":256}],"docs_without_owners":[{"doc_id":126,"parent_doc_id":null,"title":"Document Without Owners","is_archived":0,"is_important":0,"position":3,"show_in_main_doc_list":1,"updated_at":"2025-01-12T07:00:00Z","author_id":3,"size":768}]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Docs"],"summary":"Create a doc","description":"Create a new doc.","operationId":"createDoc","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"description":"The title of the doc.","type":"string","minLength":1,"maxLength":250},"content":{"description":"The content of the doc.","type":"string","maxLength":65535,"default":""},"is_important":{"description":"Set to `1` to mark the doc as important, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1],"default":0},"for_welcome":{"description":"Set to `1` to show the doc on the welcome screen, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1],"default":0},"is_archived":{"description":"Set to `1` to create the doc as archived, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1],"default":0},"is_indexed_for_ai":{"description":"Set to `1` to index the doc for AI, or `0` otherwise. Omit to use account default.","format":"int32","type":"integer","enum":[0,1]},"parent_doc_id":{"description":"The ID of the parent doc, if this doc should be a child of another doc.","format":"int32","type":"integer","nullable":true},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","minimum":0},"show_in_main_doc_list":{"description":"Set to `1` to show the doc in the main doc list, or `0` to hide it.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"title":"My New Document","content":"This is the content of my document.","is_important":0,"is_archived":0,"parent_doc_id":null,"position":0,"show_in_main_doc_list":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the created doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_edit":{"description":"Indicates whether everyone with access can edit the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_comment":{"description":"Indicates whether everyone with access can comment on the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_view":{"description":"Indicates whether everyone with access can view the doc.","format":"int32","type":"integer","enum":[0,1]},"author_id":{"description":"The ID of the user who created the doc.","format":"int32","type":"integer"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}}},"example":{"data":{"doc_id":123,"parent_doc_id":null,"title":"My New Document","content":"This is the content of my document.","is_archived":0,"is_important":0,"position":0,"show_in_main_doc_list":1,"everyone_can_edit":0,"everyone_can_comment":1,"everyone_can_view":1,"author_id":2,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-15T10:30:00Z","size":1024}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}":{"get":{"tags":["Docs"],"summary":"Get the details of a single doc","description":"Get the details of a single doc.\n","operationId":"getDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_edit":{"description":"Indicates whether everyone with access can edit the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_comment":{"description":"Indicates whether everyone with access can comment on the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_view":{"description":"Indicates whether everyone with access can view the doc.","format":"int32","type":"integer","enum":[0,1]},"author_id":{"description":"The ID of the user who created the doc.","format":"int32","type":"integer"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}}},"example":{"data":{"doc_id":123,"parent_doc_id":10,"title":"My Document","content":"This is the content of the document.","is_archived":0,"is_important":1,"position":0,"show_in_main_doc_list":1,"everyone_can_edit":0,"everyone_can_comment":1,"everyone_can_view":1,"author_id":2,"created_at":"2025-01-10T08:15:00Z","updated_at":"2025-01-15T14:20:00Z","size":1024}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Docs"],"summary":"Update a doc","description":"Update a doc.\n","operationId":"updateDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"title":{"description":"The title of the doc.","type":"string","minLength":1,"maxLength":250},"content":{"description":"The content of the doc.","type":"string","maxLength":65535},"is_important":{"description":"Set to `1` to mark the doc as important, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1]},"for_welcome":{"description":"Set to `1` to show the doc on the welcome screen, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1]},"is_archived":{"description":"Set to `1` to archive the doc, or `0` to unarchive it.","format":"int32","type":"integer","enum":[0,1]},"parent_doc_id":{"description":"The ID of the parent doc, if this doc should be a child of another doc. Set to `null` to remove the parent.","format":"int32","type":"integer","nullable":true},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","minimum":0},"is_indexed_for_ai":{"description":"Set to `1` to index the doc for AI, or `0` otherwise. Requires permission to manage AI indexation.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"title":"My Updated Document","content":"This is the updated content of the document.","is_important":1,"for_welcome":0,"is_archived":0,"is_indexed_for_ai":1,"parent_doc_id":10,"position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"for_welcome":{"description":"Set to `1` to show the doc on the welcome screen, or `0` otherwise.","format":"int32","type":"integer","enum":[0,1]},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_edit":{"description":"Indicates whether everyone with access can edit the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_comment":{"description":"Indicates whether everyone with access can comment on the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_view":{"description":"Indicates whether everyone with access can view the doc.","format":"int32","type":"integer","enum":[0,1]},"is_indexed_for_ai":{"description":"Indicates whether the doc is indexed for AI.","format":"int32","type":"integer","enum":[0,1]},"author_id":{"description":"The ID of the user who created the doc.","format":"int32","type":"integer"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}}},"example":{"data":{"doc_id":123,"parent_doc_id":10,"title":"Updated Document Title","content":"This is the updated content of the document.","is_archived":0,"is_important":1,"for_welcome":0,"is_indexed_for_ai":1,"position":0,"show_in_main_doc_list":1,"everyone_can_edit":0,"everyone_can_comment":1,"everyone_can_view":1,"author_id":2,"created_at":"2025-01-10T08:15:00Z","updated_at":"2025-01-15T16:45:00Z","size":2048}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Docs"],"summary":"Delete a doc","description":"Delete a doc. The user must be an owner of the doc.\nFirst-level docs that are shown in the main doc list may require doc manager permission to delete.\n","operationId":"deleteDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}},{"name":"replace_with_doc_id","in":"query","description":"The ID of a doc to replace this doc with when deleting. All child docs will be moved to the replacement doc.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The doc has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/clone":{"post":{"tags":["Docs"],"summary":"Clone a doc","description":"Creates a copy of the specified doc. The authenticated user must be an owner of the doc.\nOptionally include all child docs in the clone.\n","operationId":"cloneDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc to clone.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"include_children":{"description":"If set to `1`, all child docs (descendants) are included in the clone.\nIf set to `0` or omitted, only the specified doc is cloned.\n","format":"int32","type":"integer","enum":[0,1]}}},"example":{"include_children":1}}}},"responses":{"200":{"description":"The doc was successfully cloned. Returns the created doc(s).","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The cloned doc(s).","type":"array","items":{"type":"object","properties":{"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"is_important":{"description":"Indicates whether the doc is marked as important.","format":"int32","type":"integer","enum":[0,1]},"for_welcome":{"description":"Indicates whether the doc is used for welcome.","format":"int32","type":"integer","enum":[0,1]},"is_indexed_for_ai":{"description":"Indicates whether the doc is indexed for AI.","format":"int32","type":"integer","enum":[0,1]},"author_id":{"description":"The ID of the user who created the doc.","format":"int32","type":"integer"},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"depth":{"description":"The depth of the doc in the hierarchy.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size of the doc content.","format":"int32","type":"integer"},"is_archived":{"description":"Indicates whether the doc is archived.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_edit":{"description":"Indicates whether everyone can edit the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_comment":{"description":"Indicates whether everyone can comment on the doc.","format":"int32","type":"integer","enum":[0,1]},"everyone_can_view":{"description":"Indicates whether everyone can view the doc.","format":"int32","type":"integer","enum":[0,1]},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"is_personal":{"description":"Indicates whether the doc is personal.","format":"int32","type":"integer","enum":[0,1]},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"title":"Pamphlet","content":"This is the content of the pamphlet.","parent_doc_id":null,"is_important":0,"for_welcome":0,"is_indexed_for_ai":0,"author_id":3,"position":16,"depth":null,"size":9784,"is_archived":0,"everyone_can_edit":0,"everyone_can_comment":0,"everyone_can_view":0,"show_in_main_doc_list":1,"is_personal":0,"created_at":"2026-03-11T08:04:01+00:00","updated_at":"2026-03-11T08:04:01+00:00","doc_id":949}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/attachments":{"get":{"tags":["Docs"],"summary":"Get attachments for a doc","description":"Get all attachments for a specific doc.","operationId":"getDocAttachments","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of attachments for the doc.","type":"array","items":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment (relative to the environment domain).","type":"string"},"position":{"description":"The position of the attachment in the doc's attachment list.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"id":101,"file_name":"Report.pdf","link":"\/files\/abc123def456ghi78901","position":0},{"id":102,"file_name":"Screenshot.png","link":"\/files\/xyz987wvu654rts32109","position":1}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Docs"],"summary":"Add an attachment to a doc","description":"Add an attachment to a doc.","operationId":"addDocAttachment","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The display name of the attachment file (1-250 characters).","type":"string","minLength":1,"maxLength":250},"link":{"description":"The path or URL of the attachment (e.g. path returned after file upload).","type":"string"},"position":{"description":"Optional position in the attachment list. If omitted, the attachment is appended.","format":"int32","type":"integer","minimum":0}}},"example":{"file_name":"Project brief.pdf","link":"\/files\/abc123def456ghi78901","position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"},"size":{"description":"The size of the attachment in bytes (for uploaded files).","format":"int32","type":"integer"}}}}},"example":{"data":{"id":103,"doc_id":123,"file_name":"Project brief.pdf","link":"\/files\/abc123def456ghi78901","position":0,"size":102400}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/attachments\/{attachment_id}":{"get":{"tags":["Docs"],"summary":"Get an attachment for a doc","description":"Get the details of a specific attachment for a doc.","operationId":"getDocAttachment","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"}}}}},"example":{"data":{"id":101,"doc_id":123,"file_name":"Report.pdf","link":"\/files\/abc123def456ghi78901","position":0}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Docs"],"summary":"Update an attachment for a doc","description":"Update the properties of an attachment.","operationId":"updateDocAttachment","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"file_name":{"description":"The display name of the attachment file (1-250 characters).","type":"string","minLength":1,"maxLength":250},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The new position in the attachment list.","format":"int32","type":"integer","minimum":0}}},"example":{"file_name":"Updated report.pdf","position":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"}}}}},"example":{"data":{"id":101,"doc_id":123,"file_name":"Updated report.pdf","link":"\/files\/abc123def456ghi78901","position":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Docs"],"summary":"Delete an attachment from a doc","description":"Remove an attachment from a doc.","operationId":"deleteDocAttachment","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The attachment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/history":{"get":{"tags":["Docs"],"summary":"Get history for a doc","description":"Get the history of changes for a specific doc.","operationId":"getDocHistory","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of history events.","type":"array","items":{"type":"object","properties":{"history_id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"event_type":{"description":"The type of event.","type":"string"},"user_id":{"description":"The ID of the user who performed the action.","format":"int32","type":"integer"},"details":{"description":"Details about the event.","type":"object"},"time":{"description":"The date and time when the event occurred.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"history_id":1001,"doc_id":123,"user_id":2,"event_type":"doc_created","time":"2025-01-10T08:15:00Z","details":{}},{"history_id":1002,"doc_id":123,"user_id":2,"event_type":"doc_updated","time":"2025-01-15T14:20:00Z","details":{}}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/locations":{"get":{"tags":["Docs"],"summary":"Get locations for a doc","description":"Get the boards and cards where a doc is located.","operationId":"getDocLocations","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_boards":{"description":"A list of boards where the doc is located.","type":"array","items":{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"},"position":{"description":"The position of the doc on the board.","format":"int32","type":"integer"}}}},"doc_card_ids":{"description":"A list of card IDs where the doc is located.","type":"array","items":{"format":"int32","type":"integer"}}}}}},"example":{"data":{"doc_boards":[{"board_id":10,"position":0},{"board_id":11,"position":1}],"doc_card_ids":[101,102,103]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Docs"],"summary":"Update locations for a doc","description":"Update the boards and cards where a doc is located.","operationId":"updateDocLocations","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"card_ids_to_add":{"description":"A list of card IDs to add the doc to.","type":"array","items":{"format":"int32","type":"integer"}},"card_ids_to_remove":{"description":"A list of card IDs to remove the doc from.","type":"array","items":{"format":"int32","type":"integer"}},"boards_to_add_or_update":{"description":"A list of boards to add or update the doc on.","type":"array","items":{"type":"object","required":["board_id"],"properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"},"position":{"description":"The position of the doc on the board.","format":"int32","type":"integer","minimum":0}}},"example":[{"board_id":10,"position":0},{"board_id":11,"position":1}]},"board_ids_to_remove":{"description":"A list of board IDs to remove the doc from.","type":"array","items":{"format":"int32","type":"integer"}},"show_in_main_doc_list":{"description":"Set to `1` to show the doc in the main doc list, or `0` to hide it.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"card_ids_to_add":[101,102],"card_ids_to_remove":[103],"boards_to_add_or_update":[{"board_id":10,"position":0},{"board_id":11,"position":1}],"board_ids_to_remove":[12],"show_in_main_doc_list":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_boards":{"description":"A list of boards where the doc is located.","type":"array","items":{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"},"position":{"description":"The position of the doc on the board.","format":"int32","type":"integer"}}}},"doc_card_ids":{"description":"A list of card IDs where the doc is located.","type":"array","items":{"format":"int32","type":"integer"}}}}}},"example":{"data":{"doc_boards":[{"board_id":10,"position":0},{"board_id":11,"position":1}],"doc_card_ids":[101,102]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/permissions":{"get":{"tags":["Docs"],"summary":"Get permissions for a doc","description":"Get the permissions of the current user for a specific doc.","operationId":"getDocPermissions","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"can_view":{"description":"Indicates whether the user can view the doc.","type":"boolean"},"can_edit":{"description":"Indicates whether the user can edit the doc.","type":"boolean"},"can_comment":{"description":"Indicates whether the user can comment on the doc.","type":"boolean"},"is_owner":{"description":"Indicates whether the user is an owner of the doc.","type":"boolean"}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/revisions":{"get":{"tags":["Docs"],"summary":"Get revisions for a doc","description":"Get a list of content revisions for a specific doc.","operationId":"getDocRevisions","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of revisions.","type":"array","items":{"type":"object","properties":{"revision":{"description":"The revision number.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who created this revision.","format":"int32","type":"integer"},"replaced_at":{"description":"The date and time when this revision was replaced.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"revision":1,"user_id":2,"replaced_at":"2025-01-10T08:15:00Z"},{"revision":2,"user_id":2,"replaced_at":"2025-01-15T14:20:00Z"},{"revision":3,"user_id":3,"replaced_at":"2025-01-20T10:30:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/revisions\/{revision}":{"get":{"tags":["Docs"],"summary":"Get a specific revision for a doc","description":"Get the content of a specific revision for a doc.","operationId":"getDocRevision","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}},{"name":"revision","in":"path","required":true,"description":"The revision number.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"revision":{"description":"The revision number.","format":"int32","type":"integer"},"content":{"description":"The content of the revision.","type":"string"},"replaced_at":{"description":"The date and time when this revision was replaced.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":123,"revision":2,"content":"This is the content of the document at revision 2.","user_id":2,"replaced_at":"2025-01-15T14:20:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/sharedWith":{"get":{"tags":["Docs"],"summary":"Get sharing information for a doc","description":"Get information about who a doc is shared with.","operationId":"getDocSharedWith","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"owner_ids":{"description":"A list of user IDs who are owners of the doc.","type":"array","items":{"format":"int32","type":"integer"}},"shared_with_editors":{"description":"Information about who can edit the doc. If `everyone_can_edit` is set to `1`, the doc can be edited by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_edit":{"description":"Set to `1` if everyone can edit the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"user_ids":[2,3],"team_ids":[5],"role_ids":[],"board_ids":[10],"workspace_ids":[]}},"shared_with_commenters":{"description":"Information about who can comment on the doc. If `everyone_can_comment` is set to `1`, the doc can be commented on by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_comment":{"description":"Set to `1` if everyone can comment on the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"everyone_can_comment":1}},"shared_with_viewers":{"description":"Information about who can view the doc. If `everyone_can_view` is set to `1`, the doc can be viewed by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_view":{"description":"Set to `1` if everyone can view the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"user_ids":[2,3,4],"team_ids":[5,6],"role_ids":[1],"board_ids":[],"workspace_ids":[2]}}}}}},"example":{"data":{"owner_ids":[2,3],"shared_with_editors":{"user_ids":[2,3],"team_ids":[5],"role_ids":[],"board_ids":[10],"workspace_ids":[]},"shared_with_commenters":{"everyone_can_comment":1},"shared_with_viewers":{"user_ids":[2,3,4],"team_ids":[5,6],"role_ids":[1],"board_ids":[],"workspace_ids":[2]}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Docs"],"summary":"Update sharing information for a doc","description":"Update who a doc is shared with.","operationId":"updateDocSharedWith","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"owner_ids_to_add":{"description":"A list of user IDs to add as owners.","type":"array","items":{"format":"int32","type":"integer"}},"owner_ids_to_remove":{"description":"A list of user IDs to remove as owners.","type":"array","items":{"format":"int32","type":"integer"}},"shared_with_editors":{"description":"Information about who can edit the doc.","type":"object","properties":{"share_with_everyone":{"description":"Set to `1` to allow everyone to edit the doc, or `0` to remove this permission.","format":"int32","type":"integer","enum":[0,1]},"specific_user_ids_to_add":{"description":"A list of user IDs to add as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_user_ids_to_remove":{"description":"A list of user IDs to remove as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_add":{"description":"A list of team IDs to add as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_remove":{"description":"A list of team IDs to remove as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_add":{"description":"A list of role IDs to add as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_remove":{"description":"A list of role IDs to remove as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_add":{"description":"A list of board IDs to add as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_remove":{"description":"A list of board IDs to remove as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_add":{"description":"A list of workspace IDs to add as editors.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_remove":{"description":"A list of workspace IDs to remove as editors.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"share_with_everyone":0,"specific_user_ids_to_add":[2,3],"specific_team_ids_to_add":[5],"specific_board_ids_to_remove":[10]}},"shared_with_commenters":{"description":"Information about who can comment on the doc.","type":"object","properties":{"share_with_everyone":{"description":"Set to `1` to allow everyone to comment on the doc, or `0` to remove this permission.","format":"int32","type":"integer","enum":[0,1]},"specific_user_ids_to_add":{"description":"A list of user IDs to add as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_user_ids_to_remove":{"description":"A list of user IDs to remove as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_add":{"description":"A list of team IDs to add as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_remove":{"description":"A list of team IDs to remove as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_add":{"description":"A list of role IDs to add as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_remove":{"description":"A list of role IDs to remove as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_add":{"description":"A list of board IDs to add as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_remove":{"description":"A list of board IDs to remove as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_add":{"description":"A list of workspace IDs to add as commenters.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_remove":{"description":"A list of workspace IDs to remove as commenters.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"share_with_everyone":1}},"shared_with_viewers":{"description":"Information about who can view the doc.","type":"object","properties":{"share_with_everyone":{"description":"Set to `1` to allow everyone to view the doc, or `0` to remove this permission.","format":"int32","type":"integer","enum":[0,1]},"specific_user_ids_to_add":{"description":"A list of user IDs to add as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_user_ids_to_remove":{"description":"A list of user IDs to remove as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_add":{"description":"A list of team IDs to add as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_team_ids_to_remove":{"description":"A list of team IDs to remove as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_add":{"description":"A list of role IDs to add as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_role_ids_to_remove":{"description":"A list of role IDs to remove as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_add":{"description":"A list of board IDs to add as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_board_ids_to_remove":{"description":"A list of board IDs to remove as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_add":{"description":"A list of workspace IDs to add as viewers.","type":"array","items":{"format":"int32","type":"integer"}},"specific_workspace_ids_to_remove":{"description":"A list of workspace IDs to remove as viewers.","type":"array","items":{"format":"int32","type":"integer"}}},"example":{"specific_user_ids_to_add":[2,3,4],"specific_team_ids_to_add":[5,6],"specific_role_ids_to_add":[1],"specific_workspace_ids_to_add":[2]}}}},"example":{"owner_ids_to_add":[2,3],"owner_ids_to_remove":[4],"shared_with_editors":{"share_with_everyone":0,"specific_user_ids_to_add":[2,3],"specific_team_ids_to_add":[5],"specific_board_ids_to_remove":[10]},"shared_with_commenters":{"share_with_everyone":1},"shared_with_viewers":{"specific_user_ids_to_add":[2,3,4],"specific_team_ids_to_add":[5,6],"specific_role_ids_to_add":[1],"specific_workspace_ids_to_add":[2]}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"owner_ids":{"description":"A list of user IDs who are owners of the doc.","type":"array","items":{"format":"int32","type":"integer"}},"shared_with_editors":{"description":"Information about who can edit the doc. If `everyone_can_edit` is set to `1`, the doc can be edited by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_edit":{"description":"Set to `1` if everyone can edit the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can edit the doc. This is only present if `everyone_can_edit` is not set.","type":"array","items":{"format":"int32","type":"integer"}}}},"shared_with_commenters":{"description":"Information about who can comment on the doc. If `everyone_can_comment` is set to `1`, the doc can be commented on by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_comment":{"description":"Set to `1` if everyone can comment on the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can comment on the doc. This is only present if `everyone_can_comment` is not set.","type":"array","items":{"format":"int32","type":"integer"}}}},"shared_with_viewers":{"description":"Information about who can view the doc. If `everyone_can_view` is set to `1`, the doc can be viewed by everyone. Otherwise, it contains lists of specific users, teams, roles, boards, or workspaces.","type":"object","properties":{"everyone_can_view":{"description":"Set to `1` if everyone can view the doc.","format":"int32","type":"integer","enum":[1]},"user_ids":{"description":"A list of user IDs who can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"team_ids":{"description":"A list of team IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"role_ids":{"description":"A list of role IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids":{"description":"A list of board IDs whose assignees can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids":{"description":"A list of workspace IDs whose members can view the doc. This is only present if `everyone_can_view` is not set.","type":"array","items":{"format":"int32","type":"integer"}}}}}}}},"example":{"data":{"owner_ids":[2,3],"shared_with_editors":{"user_ids":[2,3],"team_ids":[5],"role_ids":[],"board_ids":[10],"workspace_ids":[]},"shared_with_commenters":{"everyone_can_comment":1},"shared_with_viewers":{"user_ids":[2,3,4],"team_ids":[5,6],"role_ids":[1],"board_ids":[],"workspace_ids":[2]}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/{doc_id}\/successors":{"get":{"tags":["Docs"],"summary":"Get successors for a doc","description":"Get the successor docs (child docs) for a specific doc.","operationId":"getDocSuccessors","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of successor docs.","type":"array","items":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc.","format":"int32","type":"integer"},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true}}}}}},"example":{"data":[{"doc_id":124,"parent_doc_id":123,"position":0},{"doc_id":125,"parent_doc_id":123,"position":1},{"doc_id":126,"parent_doc_id":124,"position":0}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/docs\/history":{"get":{"tags":["Docs"],"summary":"Get docs history","description":"Get a paginated list of history events for docs.","operationId":"getDocsHistory","parameters":[{"name":"doc_ids","in":"query","description":"A list of doc IDs to filter by.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs to filter by.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types to filter by.","required":false,"schema":{"items":{"type":"string"}},"explode":false},{"name":"from","in":"query","description":"The earliest date and time for events to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time for events to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date for events to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date for events to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"The page number to retrieve. Defaults to 1.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"The number of results per page. Defaults to 100, maximum is 200.","required":false,"schema":{"format":"int32","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of history events.","type":"array","items":{"type":"object"}}}},"example":{"pagination":{"all_pages":5,"current_page":1,"results_per_page":100},"data":[{"history_id":1001,"doc_id":123,"user_id":2,"event_type":"doc_created","created_at":"2025-01-10T08:15:00Z"},{"history_id":1002,"doc_id":124,"user_id":3,"event_type":"doc_updated","created_at":"2025-01-11T09:20:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs":{"get":{"tags":["Personal Docs"],"summary":"Get a list of personal docs","description":"Retrieve a list of personal docs belonging to the authenticated user. Personal docs are private to the author. The results can be filtered using optional criteria.","operationId":"getPersonalDocs","parameters":[{"name":"doc_ids","in":"query","description":"Get a list of details for specific personal docs by their IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"title","in":"query","description":"Filters results to include only personal docs that match the specified title.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"result":{"description":"A list of personal docs.","type":"array","items":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"author_id":{"description":"The ID of the user who created the doc (the owner).","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"position":{"description":"The position of the doc in the list.","format":"int32","type":"integer","nullable":true},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}}}}}},"example":{"data":{"result":[{"doc_id":501,"author_id":2,"title":"My Personal Notes","position":0,"updated_at":"2025-01-15T14:20:00Z","created_at":"2025-01-10T08:15:00Z","size":1024},{"doc_id":502,"author_id":2,"title":"Private Draft","position":1,"updated_at":"2025-01-14T09:10:00Z","created_at":"2025-01-12T11:00:00Z","size":512}]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Personal Docs"],"summary":"Create a personal doc","description":"Create a new personal doc. Personal docs are private to the authenticated user.","operationId":"createPersonalDoc","requestBody":{"content":{"application\/json":{"schema":{"type":"object","required":["title"],"properties":{"title":{"description":"The title of the personal doc.","type":"string","minLength":1,"maxLength":250},"content":{"description":"The content of the doc.","type":"string","maxLength":65535,"default":""},"position":{"description":"The position of the doc in the list.","format":"int32","type":"integer","minimum":0}}},"example":{"title":"My Personal Document","content":"This is the content of my personal document.","position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the created personal doc.","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"position":{"description":"The position of the doc in the list.","format":"int32","type":"integer","nullable":true},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"}}}}},"example":{"data":{"doc_id":501,"title":"My Personal Document","content":"This is the content of my personal document.","position":0,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-15T10:30:00Z","size":1024}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/history":{"get":{"tags":["Personal Docs"],"summary":"Get personal docs history","description":"Get a paginated list of history events for personal docs belonging to the authenticated user.","operationId":"getPersonalDocsHistory","parameters":[{"name":"doc_ids","in":"query","description":"A list of personal doc IDs to filter by.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs to filter by.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types to filter by.","required":false,"schema":{"items":{"type":"string","enum":["personal_doc_created","personal_doc_updated","personal_doc_deleted","personal_doc_content_changed"]}},"explode":false,"example":"personal_doc_created,personal_doc_updated"},{"name":"from","in":"query","description":"The earliest date and time for events to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time for events to include in the results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date for events to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date for events to include in the results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"The page number to retrieve. Defaults to 1.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"The number of results per page. Defaults to 100, maximum is 200.","required":false,"schema":{"format":"int32","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of personal doc history events.","type":"array","items":{"type":"object","properties":{"history_id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"event_type":{"description":"The type of event.","type":"string","enum":["personal_doc_created","personal_doc_updated","personal_doc_deleted","personal_doc_content_changed"]},"user_id":{"description":"The ID of the user who performed the action.","format":"int32","type":"integer"},"details":{"description":"Details about the event (e.g. previous_state, changes).","type":"object","nullable":true},"time":{"description":"The date and time when the event occurred.","format":"date-time","type":"string"}}}}}},"example":{"pagination":{"all_pages":2,"current_page":1,"results_per_page":100},"data":[{"history_id":2001,"doc_id":501,"user_id":2,"event_type":"personal_doc_created","details":{"title":"My Personal Notes","content":"","position":0},"time":"2025-01-10T08:15:00Z"},{"history_id":2002,"doc_id":501,"user_id":2,"event_type":"personal_doc_updated","details":{"previous_state":{"title":"My Personal Notes","content":"Old content"},"changes":{"title":"My Personal Notes","content":"Updated content"}},"time":"2025-01-15T14:20:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}":{"get":{"tags":["Personal Docs"],"summary":"Get the details of a single personal doc","description":"Get the details of a single personal doc. Only the author can access their personal docs.","operationId":"getPersonalDoc","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":501,"title":"My Personal Notes","content":"This is the content of my personal document.","created_at":"2025-01-10T08:15:00Z","updated_at":"2025-01-15T14:20:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Personal Docs"],"summary":"Update a personal doc","description":"Update a personal doc. Only the author can update their personal docs.","operationId":"updatePersonalDoc","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"title":{"description":"The title of the personal doc.","type":"string","minLength":1,"maxLength":250},"content":{"description":"The content of the doc.","type":"string","maxLength":65535},"position":{"description":"The position of the doc in the list.","format":"int32","type":"integer","minimum":0}}},"example":{"title":"Updated Personal Document Title","content":"This is the updated content of the document.","position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"position":{"description":"The position of the doc in the list.","format":"int32","type":"integer","nullable":true},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":501,"title":"Updated Personal Document Title","content":"This is the updated content of the document.","position":0,"created_at":"2025-01-10T08:15:00Z","updated_at":"2025-01-15T16:45:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Personal Docs"],"summary":"Delete a personal doc","description":"Delete a personal doc. Only the author can delete their personal docs.","operationId":"deletePersonalDoc","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The personal doc has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/clone":{"post":{"tags":["Personal Docs"],"summary":"Clone a personal doc","description":"Creates a copy of the specified personal doc. Only the author can clone their personal doc.\nThe new doc is created as a personal doc for the authenticated user.\n","operationId":"clonePersonalDoc","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc to clone.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"required":false,"content":{"application\/json":{"schema":{"type":"object","description":"No properties required. Send an empty object or omit the body.","properties":{}},"example":{}}}},"responses":{"200":{"description":"The personal doc was successfully cloned. Returns the created personal doc.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the cloned personal doc.","format":"int32","type":"integer"},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"author_id":{"description":"The ID of the user who owns the doc (the authenticated user).","format":"int32","type":"integer"},"position":{"description":"The position of the doc in the personal docs list.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size of the doc in bytes.","format":"int32","type":"integer"},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":502,"title":"My Personal Notes (copy)","content":"This is the content of my personal document.","author_id":2,"position":1,"size":1024,"created_at":"2025-01-15T10:30:00Z","updated_at":"2025-01-15T10:30:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/convert":{"post":{"tags":["Personal Docs"],"summary":"Convert a personal doc to a shared doc","description":"Convert a personal doc into a shared doc. The authenticated user becomes an owner. You can optionally specify a parent doc or set the doc to show in the main doc list.","operationId":"convertPersonalDoc","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc to convert.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"parent_doc_id":{"description":"The ID of the parent doc to place the converted doc under. Omit or set to null to place at the top level (requires doc manager permissions).","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Set to `1` to show the doc in the main doc list after conversion, or `0` to keep it hidden.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"parent_doc_id":10,"show_in_main_doc_list":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"parent_doc_id":{"description":"The ID of the parent doc, if any.","format":"int32","type":"integer","nullable":true},"title":{"description":"The title of the doc.","type":"string"},"content":{"description":"The content of the doc.","type":"string"},"is_personal":{"description":"Indicates whether the doc is personal (0 after conversion).","format":"int32","type":"integer","enum":[0]},"position":{"description":"The position of the doc in its parent's list.","format":"int32","type":"integer","nullable":true},"show_in_main_doc_list":{"description":"Indicates whether the doc is shown in the main doc list.","format":"int32","type":"integer","enum":[0,1]},"created_at":{"description":"The date and time when the doc was created.","format":"date-time","type":"string"},"updated_at":{"description":"The date and time when the doc was last updated.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":501,"parent_doc_id":10,"title":"My Converted Document","content":"This is the content of the document.","is_personal":0,"position":0,"show_in_main_doc_list":1,"created_at":"2025-01-10T08:15:00Z","updated_at":"2025-01-15T14:20:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/history":{"get":{"tags":["Personal Docs"],"summary":"Get history for a personal doc","description":"Get the history of changes for a specific personal doc.","operationId":"getPersonalDocHistory","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of history events for the personal doc.","type":"array","items":{"type":"object","properties":{"history_id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"event_type":{"description":"The type of event.","type":"string","enum":["personal_doc_created","personal_doc_updated","personal_doc_deleted","personal_doc_content_changed"]},"user_id":{"description":"The ID of the user who performed the action.","format":"int32","type":"integer"},"details":{"description":"Details about the event (e.g. previous_state, changes). Null for personal_doc_content_changed.","type":"object","nullable":true},"time":{"description":"The date and time when the event occurred.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"history_id":2001,"doc_id":501,"user_id":2,"event_type":"personal_doc_created","details":{"title":"My Personal Notes","content":"","position":0},"time":"2025-01-10T08:15:00Z"},{"history_id":2002,"doc_id":501,"user_id":2,"event_type":"personal_doc_updated","details":{"previous_state":{"title":"My Personal Notes","content":"Old content"},"changes":{"title":"My Personal Notes","content":"Updated content"}},"time":"2025-01-15T14:20:00Z"},{"history_id":2003,"doc_id":501,"user_id":2,"event_type":"personal_doc_content_changed","details":null,"time":"2025-01-16T09:00:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/revisions":{"get":{"tags":["Personal Docs"],"summary":"Get revisions for a personal doc","description":"Get a list of content revisions for a specific personal doc.","operationId":"getPersonalDocRevisions","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of revisions.","type":"array","items":{"type":"object","properties":{"revision":{"description":"The revision number.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who created this revision.","format":"int32","type":"integer"},"replaced_at":{"description":"The date and time when this revision was replaced.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"revision":1,"user_id":2,"replaced_at":"2025-01-10T08:15:00Z"},{"revision":2,"user_id":2,"replaced_at":"2025-01-15T14:20:00Z"},{"revision":3,"user_id":2,"replaced_at":"2025-01-20T10:30:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/revisions\/{revision}":{"get":{"tags":["Personal Docs"],"summary":"Get a specific revision for a personal doc","description":"Get the content of a specific revision for a personal doc.","operationId":"getPersonalDocRevision","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}},{"name":"revision","in":"path","required":true,"description":"The revision number.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"doc_id":{"description":"The unique identifier of the personal doc.","format":"int32","type":"integer"},"revision":{"description":"The revision number.","format":"int32","type":"integer"},"content":{"description":"The content of the revision.","type":"string"},"replaced_at":{"description":"The date and time when this revision was replaced.","format":"date-time","type":"string"}}}}},"example":{"data":{"doc_id":501,"revision":2,"content":"This is the content of the document at revision 2.","replaced_at":"2025-01-15T14:20:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/attachments":{"get":{"tags":["Personal Docs"],"summary":"Get attachments for a personal doc","description":"Get all attachments for a specific personal doc. Only the doc author can list attachments.","operationId":"getPersonalDocAttachments","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of attachments for the personal doc.","type":"array","items":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment (relative to the environment domain).","type":"string"},"position":{"description":"The position of the attachment in the doc's attachment list.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"id":201,"file_name":"Notes.pdf","link":"\/files\/abc123def456ghi78901","position":0},{"id":202,"file_name":"Draft.png","link":"\/files\/xyz987wvu654rts32109","position":1}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Personal Docs"],"summary":"Add an attachment to a personal doc","description":"Add an attachment to a personal doc. Only the doc author can add attachments.","operationId":"addPersonalDocAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The display name of the attachment file (1-250 characters).","type":"string","minLength":1,"maxLength":250},"link":{"description":"The path or URL of the attachment (e.g. path returned after file upload).","type":"string"},"position":{"description":"Optional position in the attachment list. If omitted, the attachment is appended.","format":"int32","type":"integer","minimum":0}}},"example":{"file_name":"Personal notes.pdf","link":"\/files\/abc123def456ghi78901","position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"},"size":{"description":"The size of the attachment in bytes (for uploaded files).","format":"int32","type":"integer"}}}}},"example":{"data":{"id":203,"doc_id":501,"file_name":"Personal notes.pdf","link":"\/files\/abc123def456ghi78901","position":0,"size":51200}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/personalDocs\/{id}\/attachments\/{attachment_id}":{"get":{"tags":["Personal Docs"],"summary":"Get an attachment for a personal doc","description":"Get the details of a specific attachment for a personal doc. Only the doc author can view attachments.","operationId":"getPersonalDocAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"}}}}},"example":{"data":{"id":201,"doc_id":501,"file_name":"Notes.pdf","link":"\/files\/abc123def456ghi78901","position":0}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Personal Docs"],"summary":"Update an attachment for a personal doc","description":"Update the properties of an attachment. Only the doc author can update attachments.","operationId":"updatePersonalDocAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"type":"object","properties":{"file_name":{"description":"The display name of the attachment file (1-250 characters).","type":"string","minLength":1,"maxLength":250},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The new position in the attachment list.","format":"int32","type":"integer","minimum":0}}},"example":{"file_name":"Renamed notes.pdf","position":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"id":{"description":"The unique identifier of the attachment.","format":"int32","type":"integer"},"doc_id":{"description":"The unique identifier of the doc.","format":"int32","type":"integer"},"file_name":{"description":"The display name of the attachment file.","type":"string"},"link":{"description":"The path or URL of the attachment.","type":"string"},"position":{"description":"The position of the attachment in the doc's list.","format":"int32","type":"integer"}}}}},"example":{"data":{"id":201,"doc_id":501,"file_name":"Renamed notes.pdf","link":"\/files\/abc123def456ghi78901","position":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Personal Docs"],"summary":"Delete an attachment from a personal doc","description":"Remove an attachment from a personal doc. Only the doc author can delete attachments.","operationId":"deletePersonalDocAttachment","parameters":[{"name":"id","in":"path","required":true,"description":"The unique identifier of the personal doc.","schema":{"format":"int32","type":"integer"}},{"name":"attachment_id","in":"path","required":true,"description":"The unique identifier of the attachment.","schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The attachment has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/dataFields\/{data_field_id}\/batchBoardOperations":{"post":{"tags":["Data Field Boards"],"summary":"Add, update or remove a data field on one or more boards","description":"Add, update or remove a data field on one or more boards.\n\nThe response body **will not** include boards from which the data field is removed, even if you attempt to remove it from a board where it is **already unavailable**\r\n\r\n> ### Info\r\n>\r\n> If the request body contains only `board_ids_to_remove`, the response will contain an **empty array**.","operationId":"updateDataFieldBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Data field boards data.","type":"object","properties":{"boards_to_add_or_update":{"description":"A list of board IDs where the data field should be made available or its availability updated.","type":"array","items":{"title":"Board data field data","required":["board_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board where the custom field should be made available or have its parameters updated."},"value":{"type":"string","description":"The value to be set on the board. If the value is null it will set empty value.","nullable":true},"baseline":{"description":"The baseline value to be set on the board. If the baseline is null it will set empty value.","type":"string","nullable":true},"value_is_locked":{"format":"int32","type":"integer","description":"Indicates whether the value is locked.","enum":[0,1]},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`.","nullable":true}}}},"board_ids_to_remove":{"description":"A list of board IDs where the data field should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/DataFieldBoardBatchOperationsExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data fields with their values added to boards.","type":"array","items":{"title":"Board data field data","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board."},"value":{"type":"string","description":"The value to be set on the board. If the value is null it will set empty value.","nullable":true},"baseline":{"type":"string","description":"The baseline value to be set on the board. If the baseline is null it will set empty value.","nullable":true},"value_is_locked":{"format":"int32","type":"integer","description":"Indicates whether the value is locked.","enum":[0,1]},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`.","nullable":true}}}}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldBoardBatchOperationsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/dataFields\/{data_field_id}\/batchWorkspaceOperations":{"post":{"tags":["Data Field Workspaces"],"summary":"Add, update or remove a data field on one or more workspaces","description":"Add, update or remove a data field on one or more workspaces.\n\nThe response body **will not** include workspaces from which the data field is removed, even if you attempt to remove it from a workspace where it is **already unavailable**\r\n\r\n> ### Info\r\n>\r\n> If the request body contains only `workspace_ids_to_remove`, the response will contain an **empty array**.","operationId":"updateDataFieldWorkspaces","requestBody":{"content":{"application\/json":{"schema":{"description":"Data field workspaces data.","type":"object","properties":{"workspaces_to_add_or_update":{"description":"A list of workspaces where the data field should be added or updated.","type":"array","items":{"title":"Workspace data field data","required":["workspace_id"],"type":"object","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace where the data field should be made available or be updated."},"value":{"type":"string","description":"The value to be set on the workspace. If the value is null it will set empty value.","nullable":true},"baseline":{"type":"string","description":"The baseline value to be set on the workspace. If the baseline is null it will set empty value.","nullable":true},"show_in_dashboard":{"format":"int32","type":"integer","description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","enum":[0,1]},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`.","nullable":true}}}},"workspace_ids_to_remove":{"description":"A list of workspace IDs where the data field should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids_for_apply_to_all_boards_to_add":{"description":"A list of workspace IDs where the `apply to all boards in workspace` setting should be enabled.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids_for_apply_to_all_boards_to_remove":{"description":"A list of workspace IDs where the `apply to all boards in workspace` setting should be disabled.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids_for_value_is_locked_for_all_boards_to_add":{"description":"A list of workspace IDs where the `value is locked for all boards in workspace` setting should be enabled.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_ids_for_value_is_locked_for_all_boards_to_remove":{"description":"A list of workspace IDs where the `value is locked for all boards in workspace` setting should be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/DataFieldWorkspacesBatchOperationsRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"properties":{"value_is_locked_for_all_boards_in_workspace_ids":{"description":"A list of workspaces ids where the data field has `value is locked for all boards in workspace` enabled.","type":"array","items":{"format":"int32","type":"integer"}},"apply_to_all_boards_in_workspace_ids":{"description":"A list of workspaces ids where the data field has `apply to all boards in workspace` enabled.","type":"array","items":{"format":"int32","type":"integer"}},"workspace_data_fields":{"description":"A list of workspaces where the data field is added.","type":"array","items":{"title":"Workspace data field data","type":"object","properties":{"workspace_id":{"description":"The ID of the workspace.","format":"int32","type":"integer"},"value":{"description":"The value to be set on the workspace.","type":"string","nullable":true},"baseline":{"description":"The baseline value to be set on the workspace.","type":"string","nullable":true},"show_in_dashboard":{"description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","format":"int32","type":"integer","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type `contributor`.","nullable":true}}}}}}}},"example":{"$ref":"#\/components\/responseExamples\/DataFieldWorkspacesBatchOperationsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/teams":{"get":{"tags":["Dashboard Page Teams"],"summary":"Get a list of teams having access to a dashboard page","description":"Retrieve a list of all teams that have access to the specified dashboard page, including their permissions and management roles.\n","operationId":"getDashboardPageTeams","responses":{"200":{"description":"Successfully retrieved the list of teams with access to the dashboard page.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of teams with their access and management roles for the dashboard page.","type":"array","items":{"type":"object","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page."},"team_id":{"format":"int32","type":"integer","description":"The ID of the team."},"can_edit":{"format":"int32","type":"integer","description":"Indicates if the team has permission to manage or edit the dashboard page\n - `0`: The team does not have permission to manage the dashboard page.\n - `1`: The team has permission to manage the dashboard page."}}}}}},"example":{"data":[{"dashboard_page_id":1000,"team_id":2000,"can_edit":1},{"dashboard_page_id":1000,"team_id":2001,"can_edit":0}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/teams\/{team_id}":{"get":{"tags":["Dashboard Page Teams"],"summary":"Check if a team has access to a dashboard page","description":"Determine whether a specific team has access to the given dashboard page. Returns a `'204'` status code if the team has access, or a `404` if not.\n\n You can see a list of all teams in the [teams](#operations\/getTeams#Request) endpoint.","operationId":"checkDashboardPageTeam","responses":{"204":{"description":"The team has access to the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Dashboard Page Teams"],"summary":"Grant or update a team's access or manager role for a dashboard page","description":"Grant a team access to a dashboard page or update its management role. Use this endpoint to add a team to a dashboard page, or to set or remove its manager permissions.\n\n You can see a list of all teams in the [teams](#operations\/getTeams#Request) endpoint.","operationId":"addDashboardPageTeamOrMakeTeamMannager","requestBody":{"content":{"application\/json":{"schema":{"type":"object","description":"Optional request body for updating a team's management role for a dashboard page.","properties":{"can_edit":{"type":"integer","format":"int32","description":"Indicates if the team can manage the dashboard page.\n - `0`: The team does not have permission to manage the dashboard page.\n - `1`: The team has permission to manage the dashboard page."}}},"example":{"can_edit":1}}}},"responses":{"204":{"description":"The team's access or manager role for the dashboard page has been successfully updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Dashboard Page Teams"],"summary":"Remove a team's access to a dashboard page","description":"Remove a team's access to the specified dashboard page. Use this endpoint to revoke all permissions for a team on a dashboard page.\n\n You can see a list of all teams in the [teams](#operations\/getTeams#Request) endpoint.","operationId":"removeDashboardPageTeam","responses":{"204":{"description":"The team has been removed and no longer has access to the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"},{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/users":{"get":{"tags":["Dashboard Page Users"],"summary":"Get a list of users who are assigned to the specified dashboard page.","description":"Retrieves a list of users who are assigned to the specified dashboard page.\nThere are two types of assigned users:\n- **Dashboard members** \u2013 they can view the dashboard.\n- **Dashboard managers** \u2013 they can add or remove users, workspaces, and widgets, as well as rename the dashboard.\nIf the `can_edit` property is set to `1`, the user is a **dashboard manager**. If it is set to `0`, the user is a **dashboard member**.\n\nYou can find a list of all users in the [users](#operations\/getUsers#Request) endpoint.\n","operationId":"getDashboardPageUsers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of users assigned to the dashboard page.","type":"array","items":{"type":"object","title":"Dashboard page user","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The unique identifier of the dashboard page."},"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user."},"can_edit":{"format":"int32","type":"integer","description":"Indicates if the user can manage the dashboard page.\n\nA value of `0` represents **Dashboard member**, meaning the user can view the dashboard.\n\nA value of `1` represents **Dashboard manager**, meaning the user can add or remove users, workspaces, and widgets, as well as rename the dashboard.","default":0}}}}}},"example":{"$ref":"#\/components\/responseExamples\/DashboardPageUsersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/users\/{user_id}":{"get":{"tags":["Dashboard Page Users"],"summary":"Check if a user is assigned to the specified dashboard page","description":"Check if a user is assigned to the specified dashboard page.","operationId":"checkDashboardPageUser","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","title":"Dashboard page user","properties":{"data":{"description":"User dashboard page data","type":"array","items":{"type":"object","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The unique identifier of the dashboard page."},"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user."},"can_edit":{"format":"int32","type":"integer","description":"Indicates if the user can manage the dashboard page.\n\nA value of `0` represents **Dashboard member**, meaning the user can view the dashboard.\n\nA value of `1` represents **Dashboard manager**, meaning the user can add or remove users, workspaces, and widgets, as well as rename the dashboard.","default":0}}}}}},"example":{"$ref":"#\/components\/responseExamples\/DashboardPageUserExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Dashboard Page Users"],"summary":"Assign a user to the specified dashboard page or update their permissions","description":"Assign a user to the specified dashboard page or update their permissions.","operationId":"addDashboardPageUserOrMakeUserMannager","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/DashboardPageUser"},{"$ref":"#\/components\/schemas\/DashboardPageUserAsManager"}]},"example":{"$ref":"#\/components\/requestExamples\/DashboardPageUserExample"}}}},"responses":{"204":{"description":"The user has been successfully assigned to the dashboard page or their permissions have been updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Dashboard Page Users"],"summary":"Remove a user's access to the specified dashboard page","description":"Remove a user's existing access to the specified dashboard page..\r\n\r\n\r\n> ### Info\r\n>\r\n>If you attempt to remove access for a user who is not currently assigned to the dashboard, the request will still succeed and return a `'204'` response.","operationId":"removeDashboardPageUser","responses":{"204":{"description":"The user no longer has access to the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/workspaces":{"get":{"tags":["Dashboard Page Workspaces"],"summary":"Get a list of workspaces added to a dashboard page","description":"Retrieve a list of the workspaces added to a specific dashboard page.","operationId":"getDashboardPageWorkspaces","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of the workspaces added to a dashboard page.","type":"array","items":{"type":"object","properties":{"dashboard_page_id":{"description":"The ID of the dashboard page.","format":"int32","type":"integer"},"workspace_id":{"description":"The ID of the workspace.","format":"int32","type":"integer"},"position":{"description":"The position of the workspace on the dashboard page.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"dashboard_page_id":1000,"workspace_id":2000,"position":1},{"dashboard_page_id":1000,"workspace_id":2001,"position":2}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/workspaces\/{workspace_id}":{"get":{"tags":["Dashboard Page Workspaces"],"summary":"Check if a workspace is added to a dashboard page","description":"Check whether a workspaces is added to a dashboard page.","operationId":"checkDashboardPageWorkspace","responses":{"204":{"description":"The workspace is added to the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Dashboard Page Workspaces"],"summary":"Make a workspace available on a dashboard page","description":"Make a workspace available on a dashboard page.","operationId":"addDashboardPageWorkspace","responses":{"204":{"description":"The workspace is now available on the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Dashboard Page Workspaces"],"summary":"Remove a workspace from a dashboard page","description":"Make a workspace no longer available on a dashboard page.","operationId":"removeDashboardPageWorkspace","responses":{"204":{"description":"The workspace is no longer available on the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"},{"$ref":"#\/components\/parameters\/workspaceIdInPath"}]},"\/dashboardPages":{"get":{"tags":["Dashboard Pages"],"summary":"Get a list of dashboard pages","description":"Returns a list of dashboard pages available in the account.\nYou can optionally filter the results by specifying one or more dashboard page IDs.\nYou may also limit the fields returned for each dashboard page to only those you need (e.g., `dashboard_page_id`, `name`).\n","operationId":"getDashboardPages","parameters":[{"name":"dashboard_page_ids","in":"query","description":"Optional. A list of dashboard page IDs to filter the results.\nOnly dashboard pages with matching IDs will be returned.\nIf omitted, all dashboard pages will be included in the response.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1000, 1001"},{"name":"fields","in":"query","description":"Optional. A list of fields to include in the response for each dashboard page.\nThe allowed fields are: `dashboard_page_id` and `name`.\nUse this parameter to reduce the amount of data returned if you only need specific properties.\n","schema":{"items":{"type":"string","enum":["dashboard_page_id","name"]}},"explode":false,"example":"dashboard_page_id, name"}],"responses":{"200":{"description":"Successfully retrieved the list of dashboard pages.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of dashboard pages.","type":"array","items":{"$ref":"#\/components\/schemas\/DashboardPage"}}}},"example":{"data":[{"dashboard_page_id":1000,"name":"Marketing Dashboard"},{"dashboard_page_id":1001,"name":"Sales Dashboard"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Dashboard Pages"],"summary":"Create a dashboard page","description":"Create a new dashboard page.","operationId":"createDashBoardPage","requestBody":{"content":{"application\/json":{"schema":{"description":"The data required to create a new dashboard page.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the new board.","type":"string","minLength":1,"maxLength":250}}},"example":{"name":"New Dashboard Page"}}}},"responses":{"200":{"description":"The dashboard page was created successfully.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DashboardPage"}}},"example":{"data":{"name":"New Dashboard Page","dashboard_page_id":1000}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/dashboardPages\/{dashboard_page_id}":{"get":{"tags":["Dashboard Pages"],"summary":"Get the details of a specific dashboard page","description":"Get the details of a specific dashboard page","operationId":"getDashboardPage","responses":{"200":{"description":"Successfully retrieved the dashboard page details.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DashboardPage"}}},"example":{"data":{"dashboard_page_id":1000,"name":"Marketing Dashboard"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Dashboard Pages"],"summary":"Update the details of a dashboard page","description":"Modify the properties of an existing dashboard page.","operationId":"updateDashboardPage","requestBody":{"content":{"application\/json":{"schema":{"description":"The data used to update the dashboard page.","type":"object","properties":{"name":{"description":"The new name for the dashboard page.","type":"string","minLength":1,"maxLength":250}}},"example":{"name":"Updated Dashboard Page Name"}}}},"responses":{"200":{"description":"The dashboard page was updated successfully.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DashboardPage"}}},"example":{"data":{"dashboard_page_id":1000,"name":"Updated Dashboard Page Name"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Dashboard Pages"],"summary":"Delete a dashboard page","description":"Deletes the specified dashboard page, including all its settings, widgets, and access permissions.\n\n **Related Endpoints:**\n - All dashboard pages: [dashboard pages](#operations\/getDashboardPages#Request).\n - All users associated with the dashboard page: [dashboard page users](#operations\/getDashboardPageUsers#Request).\n - All teams associated with the dashboard page: [dashboard page teams](#operations\/getDashboardPageTeams#Request).\n - All workspaces associated with the dashboard page: [dashboard page workspaces](#operations\/getDashboardPageWorkspaces#Request).\n You can also clone the dashboard page before deleting it using the [clone dashboard page](#operations\/cloneDashboardPage#Request) endpoint.","operationId":"deleteDashboardPage","responses":{"204":{"description":"The dashboard page has been successfully deleted and is no longer accessible."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/dashboardPages\/{dashboard_page_id}\/clone":{"post":{"tags":["Dashboard Pages"],"summary":"Clone a dashboard page","description":"Creates a copy of the specified dashboard page, including its settings, widgets, access permissions, and optionally its users, teams, and workspaces.\n\n **Related Endpoints:**\n - All dashboard pages: [dashboard pages](#operations\/getDashboardPages#Request).\n - All users associated with the dashboard page: [dashboard page users](#operations\/getDashboardPageUsers#Request).\n - All teams associated with the dashboard page: [dashboard page teams](#operations\/getDashboardPageTeams#Request).\n - All workspaces associated with the dashboard page: [dashboard page workspaces](#operations\/getDashboardPageWorkspaces#Request).","operationId":"cloneDashboardPage","requestBody":{"content":{"application\/json":{"schema":{"description":"Specifies which elements of the dashboard page should be included in the clone. All options default to `1` (enabled).","type":"object","properties":{"include_users":{"description":"If set to `1`, all users with access to the original dashboard page will also be granted access to the cloned page.\nIf set to `0`, only the user performing the clone operation will have access to the new page.\n","format":"int32","type":"integer","enum":[0,1],"default":1},"include_teams":{"description":"If set to `1`, all teams with access to the original dashboard page will also be granted access to the cloned page.\nIf set to `0`, team access will not be copied.\n","format":"int32","type":"integer","enum":[0,1],"default":1},"include_workspaces":{"description":"If set to `1`, all workspaces linked to the original dashboard page will also be linked to the cloned page.\nIf set to `0`, workspace associations will not be copied.\n","format":"int32","type":"integer","enum":[0,1],"default":1},"include_widgets":{"description":"If set to `1`, all widgets from the original dashboard page will be included in the cloned page.\nIf set to `0`, the cloned page will not contain any widgets.\n","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"include_users":1,"include_teams":1,"include_workspaces":1,"include_widgets":1}}}},"responses":{"200":{"description":"The dashboard page was successfully cloned.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DashboardPageCloneData"}}},"example":{"$ref":"#\/components\/responseExamples\/CloneDashboardPageResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/departureRules\/history":{"get":{"tags":["Departure Rule History"],"summary":"Get a list of departure rule creation, deletion, and update, rule enabled, rule disabled events.","description":"Returns a log of all actions related to the departure rules. This includes records of departure rules that have been **created**, **updated**, **deleted**, **rule enabled** or **rule disabled**.","operationId":"getDepartureRulesHistory","parameters":[{"name":"rule_ids","in":"query","description":"A list of departure rule IDs by which to filter the departure rule history.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the departure rule history to include only requests made by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types by which to filter the departure rule history.","required":false,"schema":{"items":{"type":"string","enum":["rule_created","rule_updated","rule_deleted","rule_disabled","rule_enabled"]}},"example":"rule_created,rule_updated","explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer","default":1}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"$ref":"#\/components\/responseExamples\/ResponsePaginationExample"},"data":{"type":"array","items":{"$ref":"#\/components\/schemas\/DepartureRuleHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/DepartureRuleHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/discardReasons\/{reason_id}\/boards":{"get":{"tags":["Discard Reason Boards"],"summary":"Get a list of boards that include the discard reason","description":"Get a list of boards that include the specified discard reason. You can get a list of all discard reasons using the [discardReasons endpoint](#\/operations\/getDiscardReasons#Request).","operationId":"getDiscardReasonBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"title":"Discard Reason Board","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."}}}}}},"example":{"data":[{"board_id":315},{"board_id":316}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/discardReasonIdInPath"}]},"\/discardReasons\/{reason_id}\/cards":{"get":{"tags":["Discard Reason Cards"],"summary":"Get a list of cards associated with a specific discard reason","description":"Get a list of cards where the specified discard reason is applied. You can see a list of all discard reasons in the [discardReason](#operations\/getDiscardReasons#Request) endpoint.","operationId":"getDiscardReasonCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards.","type":"array","items":{"title":"Discard Reason Card","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The unique identifier of the card."}}}}}},"example":{"data":[{"card_id":12345},{"card_id":12346}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/discardReasonIdInPath"}]},"\/discardReasons\/history":{"get":{"tags":["Discard Reason History"],"summary":"Get a list of discard reasons creation, deletion and update events","description":"Retrieves a list of events related to discard reasons.\nThis endpoint allows you to review the history of discard reasons and can be tailored using various filtering options.\n","operationId":"getDiscardReasonsHistory","parameters":[{"name":"reason_ids","in":"query","description":"A list of internal discard reason IDs used to filter the discard reasons history to include only discard reasons with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the discard reasons history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the discard reasons history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["reason_created","reason_updated","reason_disabled","reason_enabled","reason_deleted","reason_added_to_board","reason_removed_from_board"]}},"explode":false,"example":"reason_created,reason_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of discard reasons creation, deletion and update events","type":"array","items":{"$ref":"#\/components\/schemas\/DiscardReasonHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/DiscardReasonsHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/discardReasons":{"get":{"tags":["Discard Reasons"],"summary":"Get a list of discard reasons","description":"Retrieves a list of discard reasons with their relevant details, optionally filtered using various parameters.","operationId":"getDiscardReasons","parameters":[{"name":"reason_ids","in":"query","description":"Filters results to include only discard reasons with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"label","in":"query","description":"Filters discard reasons by their exact label (i.e. the name of the discard reason).","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the discard reasons.\n\nA value of `0` represents **On-demand**, meaning the discard reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the discard reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the discard reason is automatically added to all boards across all workspaces. Once a discard reason's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"explode":false,"example":"0,1"},{"name":"is_enabled","in":"query","description":"Filters discard reasons based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["reason_id","label","availability","is_enabled"]}},"explode":false,"example":"reason_id,label"},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["board_ids","board_count","card_count"]}},"explode":false,"example":"board_ids,board_count"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of discard reasons.","type":"array","items":{"$ref":"#\/components\/schemas\/DiscardReason"}}}},"example":{"$ref":"#\/components\/responseExamples\/DiscardReasonsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Discard Reasons"],"summary":"Create a discard reason","description":"Create a new discard reason.","operationId":"createDiscardReason","requestBody":{"content":{"application\/json":{"schema":{"description":"Discard reason data.","required":["label"],"type":"object","properties":{"label":{"description":"The **unique** label (i.e. the name) assigned to the discard reason.","type":"string","minLength":1,"maxLength":250},"availability":{"description":"The availability level of the discard reason.\n\nA value of `0` represents **On-demand**, meaning the discard reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the discard reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the discard reason is automatically added to all boards across all workspaces. Once a discard reason's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the discard reason is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/DiscardReasonRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DiscardReason"}}},"example":{"$ref":"#\/components\/responseExamples\/DiscardReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/discardReasons\/{reason_id}":{"get":{"tags":["Discard Reasons"],"summary":"Get the details of the specified discard reason","description":"Get the details of the specified discard reason.","operationId":"getDiscardReason","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DiscardReason"}}},"example":{"$ref":"#\/components\/responseExamples\/DiscardReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Discard Reasons"],"summary":"Update a discard reason","description":"Update a discard reason.","operationId":"updateDiscardReason","requestBody":{"content":{"application\/json":{"schema":{"description":"Discard reason data.","type":"object","properties":{"label":{"description":"The **unique** label (i.e. the name) assigned to the discard reason.","type":"string","minLength":1,"maxLength":250},"availability":{"description":"The availability level of the discard reason.\n\nA value of `0` represents **On-demand**, meaning the discard reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the discard reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the discard reason is automatically added to all boards across all workspaces. Once a discard reason's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the discard reason is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/DiscardReasonRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/DiscardReason"}}},"example":{"$ref":"#\/components\/responseExamples\/DiscardReasonExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Discard Reasons"],"summary":"Delete a discard reason","description":"Delete a discard reason.","operationId":"deleteDiscardReason","parameters":[{"name":"replace_with_reason_id","in":"query","description":"The ID of the discard reason that will replace the deleted discard reason for **all** affected cards.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The discard reason has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/discardReasonIdInPath"}]},"\/dkimDomains":{"get":{"tags":["Dkim Domains"],"summary":"Get a list of DKIM domains","description":"Get a list of DKIM domains configured for the company.","operationId":"getDkimDomains","parameters":[{"name":"domain_ids","in":"query","description":"Filter by domain IDs.","required":false,"schema":{"type":"array","items":{"format":"int32","type":"integer"}}},{"name":"domain","in":"query","description":"Filter by domain name.","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"domain_id":{"description":"The unique identifier of the DKIM domain.","format":"int32","type":"integer"},"domain":{"description":"The domain name.","type":"string"},"dns_name":{"description":"The DNS name for the DKIM TXT record (selector._domainkey.domain).","type":"string"},"record":{"description":"The DKIM TXT record value.","type":"string"}}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Dkim Domains"],"summary":"Add a DKIM domain","description":"Add a new DKIM domain and generate the corresponding DNS record.","operationId":"createDkimDomain","requestBody":{"content":{"application\/json":{"schema":{"description":"DKIM domain data.","required":["domain"],"type":"object","properties":{"domain":{"description":"The domain name to add for DKIM.","type":"string","example":"businessmap.io"}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"domain_id":{"description":"The unique identifier of the created DKIM domain.","format":"int32","type":"integer"},"domain":{"description":"The domain name.","type":"string"},"dns_name":{"description":"The DNS name for the DKIM TXT record.","type":"string"},"record":{"description":"The DKIM TXT record value.","type":"string"}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/dkimDomains\/{domain_id}":{"get":{"tags":["Dkim Domains"],"summary":"Get the details of a DKIM domain","description":"Get the details of a DKIM domain by ID.","operationId":"getDkimDomain","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"domain":{"description":"The domain name.","type":"string"},"dns_name":{"description":"The DNS name for the DKIM TXT record.","type":"string"},"record":{"description":"The DKIM TXT record value.","type":"string"}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Dkim Domains"],"summary":"Delete a DKIM domain","description":"Delete a DKIM domain by ID.","operationId":"deleteDkimDomain","responses":{"204":{"description":"The DKIM domain has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"name":"domain_id","in":"path","required":true,"description":"The unique identifier of the DKIM domain.","schema":{"format":"int32","type":"integer","example":1}}]},"\/emailIntegration\/errors":{"get":{"tags":["Email Integration Errors"],"summary":"Get a list of errors from the email integration.","description":"Retrieve a list of errors which occurred while emails were being processed","operationId":"getEmailIntegrationErrors","parameters":[{"name":"integration_email","in":"query","description":"The email address of the email integration.","schema":{"format":"email","type":"string"},"example":"integration@email.example"},{"name":"sender","in":"query","description":"The email address of the sender.","schema":{"format":"email","type":"string"},"example":"sender@email.example"},{"name":"receiver","in":"query","description":"The email address of a recipent.","schema":{"format":"email","type":"string"},"example":"receiver@email.example"},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","required":false,"schema":{"items":{"type":"string","enum":["sender","receivers","received_at","subject","error_message","card_id","event_type","integration_email"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of errors from the email integration.","type":"array","items":{"$ref":"#\/components\/schemas\/EmailIntegrationError"}}}},"example":{"$ref":"#\/components\/responseExamples\/EmailIntegrationErrorsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/emailIntegration\/history":{"get":{"tags":["Email Integration History"],"summary":"Get a list of the emails received by the email integration and their status.","description":"Retrieve a list of the emails received and processed by the email integration and their status.","operationId":"getEmailIntegrationHistory","parameters":[{"name":"sender","in":"query","description":"Sender of the email.","required":false,"schema":{"format":"email","type":"string"}},{"name":"receiver","in":"query","description":"Receiver of the email.","required":false,"schema":{"format":"email","type":"string"}},{"name":"status","in":"query","description":"Status of the email.","required":false,"schema":{"type":"string","enum":["success","failure"]}},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","required":false,"schema":{"items":{"type":"string","enum":["sender","receivers","received_at","subject","error_message","card_id","event_type"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of emails received by the email integration and their status.","type":"array","items":{"$ref":"#\/components\/schemas\/EmailIntegrationHistoryEvent"}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/workspaces\/history":{"get":{"tags":["Exports"],"summary":"Export workspace management history events","description":"Export a list of workspaces management history events.","operationId":"getWorkspacesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportWorkspaceIds"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"A list of event types to filter the results. Each value specifies a type of action performed on a workspace or board. Supported values include:\n - `workspace_created`\n - `workspace_updated`\n - `workspace_archived`\n - `workspace_unarchived`\n - `board_created`\n - `board_renamed`\n - `board_deleted`\n - `board_archived`\n - `board_unarchived`\n - `board_moved_out`\n - `board_moved_in`\n - `wm_added` (workspace manager added)\n - `wm_removed` (workspace manager removed)\n - `added_to_dashboard_page`\n - `removed_from_dashboard_page`\n","required":false,"schema":{"items":{"type":"string","enum":["workspace_created","workspace_updated","workspace_archived","workspace_unarchived","board_created","board_renamed","board_deleted","board_archived","board_unarchived","board_moved_out","board_moved_in","wm_added","wm_removed","added_to_dashboard_page","removed_from_dashboard_page"]}},"explode":false,"example":"workspace_created,added_to_dashboard_page"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported workspace management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportWorkspaces"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportWorkspacesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/boards\/history":{"get":{"tags":["Exports"],"summary":"Export a list of board management history events.","description":"Export a list of boards management history events.","operationId":"getBoardsHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportBoardIds"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"A list of event types to filter the results. Each value specifies a type of board management action.\n","required":false,"schema":{"items":{"type":"string","enum":["board_created","board_updated","board_archived","board_unarchived","board_moved","workflow_created","workflow_updated","workflow_deleted","workflow_disabled","workflow_enabled","lane_created","lane_renamed","lane_deleted","lane_moved","column_created","column_renamed","column_deleted","column_moved","cell_limits_updated","lane_section_limits_updated","merged_areas_updated","related_boards_updated","user_assigned","user_unassigned","user_role_changed","discard_reason_added","discard_reason_removed","block_reason_added","block_reason_removed","sticker_added","sticker_removed","card_type_added","card_type_removed","tag_added","tag_removed","card_template_added","card_template_removed","custom_field_added","custom_field_removed","milestone_added","milestone_removed","team_added","team_role_changed","team_removed","cell_card_orderings_updated","logged_time_category_added","logged_time_category_removed","cycle_time_columns_added","cycle_time_columns_removed"]}},"explode":false,"example":"board_created,board_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported board management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportBoards"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportBoardsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/users\/history":{"get":{"tags":["Exports"],"summary":"Export a list of user management history events.","description":"Export a list of user management history events.","operationId":"getUsersHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"$ref":"#\/components\/parameters\/exportAffectedUserIds"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"},{"name":"event_types","in":"query","description":"Type of action executed on the user.","required":false,"schema":{"items":{"type":"string","enum":["user_confirmed","user_deleted","email_changed","username_changed","realname_changed","email_signature_changed","avatar_changed","tfa_changed","tfa_enabled","tfa_disabled","tfa_key_changed","tfa_key_reset","api_key_changed","timezone_changed","language_changed","password_changed","added_to_team","removed_from_team","added_to_team_managers","removed_from_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_from_dashboard_page","user_disabled","user_enabled","wip_limits_changed","global_privilege_added","global_privilege_removed","made_wm","made_non_wm","assigned_to_board","unassigned_from_board","board_role_changed","user_attribute_added","user_attribute_changed","user_attribute_removed","invitation_sent","invitation_code_changed"]}},"explode":false,"example":"user_confirmed,invitation_sent"}],"responses":{"200":{"description":"The exported users management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportUsers"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportUsersExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/businessRules\/executionHistory":{"get":{"tags":["Exports"],"summary":"Export a list of business rule executions","description":"Export a list of business rule executions matching some optional criteria.","operationId":"getBusinessRulesExecutionHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"business_rule_ids","in":"query","description":"A list of business rule IDs to filter the export by.\nOnly executions for these business rules will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"name":"executed_on_card_ids","in":"query","description":"A list of card IDs to filter the export by.\nOnly executions performed on these cards will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2001,2002"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported business rule execution history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportBusinessRules"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportBusinessRulesExecutionExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/emailIntegration\/history":{"get":{"tags":["Exports"],"summary":"Export a list of the emails received by the email integration and their processing status.","description":"Export a list of the emails received by the email integration and their processing status.","operationId":"getEmailIntegrationHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"sender","in":"query","description":"The email address of the sender. Only emails sent from this address will be included in the export.\n","required":false,"schema":{"format":"email","type":"string"},"example":"user@example.com"},{"name":"receiver","in":"query","description":"The email address of the receiver. Only emails sent to this address will be included in the export.\n","required":false,"schema":{"format":"email","type":"string"},"example":"integration@company.com"},{"name":"status","in":"query","description":"The processing status of the email. Only emails with this status will be included in the export.\nAllowed values: `success`, `failure`.\n","required":false,"schema":{"type":"string","enum":["success","failure"]},"example":"success"},{"name":"eventTypes","in":"query","description":"Filter by specific event types related to the email integration.\nAllowed values: `card_created`, `card_updated`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["card_created","card_updated"]}},"example":"card_created","explode":false},{"name":"fields","in":"query","description":"Select which fields to include in the export.\nAllowed values: `sender`, `receivers`, `received_at`, `subject`, `status`, `card_id`, `event_type`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["sender","receivers","received_at","subject","status","card_id","event_type"]}},"example":"sender,status,card_id","explode":false},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported email integration history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportEmailIntegration"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportEmailIntegrationExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/calculatedOutcomeValueRules\/executionHistory":{"get":{"tags":["Exports"],"summary":"Export a list of calculated outcome value rule executions","description":"Export a list of calculated outcome value rule executions matching some optional criteria.","operationId":"getCalculatedOutcomeValueRulesExecutionHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"rule_ids","in":"query","description":"An array of positive integer rule IDs to filter the export by.\nOnly executions for these calculated outcome value rules will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"301,302"},{"name":"card_ids","in":"query","description":"An array of positive integer card IDs to filter the export by.\nOnly executions performed on these cards will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1001,1002"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported calculated outcome value rule execution history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportCalculatedOutcomeValueRules"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportCalculatedOutcomeValueRulesExecutionExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/emailIntegration\/errors":{"get":{"tags":["Exports"],"summary":"Export a list of error logs from the email integration.","description":"Export a list of error logs from the email integration.","operationId":"getEmailIntegrationErrorsExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"sender","in":"query","description":"The email address of the sender. Only errors for emails sent from this address will be included in the export.\n","schema":{"type":"string"},"example":"sender@email.com"},{"name":"receiver","in":"query","description":"The email address of the receiver. Only errors for emails sent to this address will be included in the export.\n","schema":{"type":"string"},"example":"receiver@email.com"},{"name":"integrationEmail","in":"query","description":"The integration email address. Only errors for emails sent to this integration address will be included in the export.\n","schema":{"type":"string","format":"email"},"example":"integration@email.com"},{"name":"eventTypes","in":"query","description":"Filter by specific event types related to the email integration.\nAllowed values: `card_created`, `card_updated`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["card_created","card_updated"]}},"example":"card_created","explode":false},{"name":"fields","in":"query","description":"Select which fields to include in the export.\nAllowed values: `sender`, `receivers`, `received_at`, `subject`, `error_message`, `card_id`, `event_type`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["sender","receivers","received_at","subject","error_message","card_id","event_type"]}},"example":"sender,error_message,cardId","explode":false},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported email integration error log file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportEmailIntegrationErrors"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportEmailIntegrationErrorsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/webhooks\/history":{"get":{"tags":["Exports"],"summary":"Export a list of webhooks creation, deletion and update events","description":"Export a list of webhooks creation, deletion and update events matching some optional criteria.","operationId":"getWebhooksHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"webhook_ids","in":"query","description":"An array of webhook IDs to filter the export by.\nOnly history events for these webhooks will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"eventTypes","in":"query","description":"An array of event type strings to filter by specific webhook actions.\nAllowed values: `created`, `updated`, `deleted`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["created","updated","deleted"]}},"example":"created,updated","explode":false},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported webhook history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportWebhooks"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportWebhooksExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/oldApiRequestHistory":{"get":{"tags":["Exports"],"summary":"Export a list of API v1 requests","description":"Export a list of API requests matching some optional criteria.","operationId":"getOldApiRequestHistoryExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported API v1 history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportOldApi"},"example":{"$ref":"#\/components\/responseExamples\/JsonOldApiExportExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/apiRequestHistory":{"get":{"tags":["Exports"],"summary":"Export a list of API v2 requests","description":"Export a list of API v2 requests, including details about the resource, method, status code, user, and time of each request.","operationId":"getApiRequestHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"methods","in":"query","description":"An array of HTTP methods to filter the export by.\nAllowed values: `get`, `put`, `post`, `patch`, `delete`.\n","required":false,"schema":{"type":"array","items":{"type":"string","enum":["get","put","post","patch","delete"]}},"example":"get,post","explode":false},{"name":"status_codes","in":"query","description":"An array of status codes to filter the export by.\nAllowed values: 200, '204', 400, 401, 403, 404, 405, 409, 429, 500, 503.\n","required":false,"schema":{"type":"array","items":{"type":"integer","format":"int32","enum":[200,"204",400,401,403,404,405,409,429,500,503]}},"example":"200,403","explode":false},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported API v2 request history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportApiRequestHistory"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportApiRequestHistoryExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/users\/lastActivity":{"get":{"tags":["Exports"],"summary":"Export a list of users last activity.","description":"Export a list of users last activity.","operationId":"getUsersLastActivityExport","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"is_enabled","in":"query","description":"When set to 1, only enabled users are included. When set to 0, only disabled users are included.\n","schema":{"format":"int32","type":"integer","enum":[0,1]},"example":1},{"name":"is_confirmed","in":"query","description":"When set to 1, only users who have confirmed their invitation are included. When set to 0, only users who have not confirmed their invitation are included.\n","schema":{"format":"int32","type":"integer","enum":[0,1]},"example":1},{"name":"if_assigned_where_i_am","in":"query","description":"When set to 1, only users assigned to boards you are assigned to are included.\n","schema":{"format":"int32","type":"integer","enum":[0,1]},"example":1}],"responses":{"200":{"description":"The exported users last activity file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportUsersLastActivity"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportUsersLastActivityExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/customFields\/history":{"get":{"tags":["Exports"],"summary":"Export a list of custom field management history events.","description":"Export a list of custom field management history events.","operationId":"getCustomFieldHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"field_ids","in":"query","description":"An array of custom field IDs to filter the export by.\nOnly history events for these custom fields will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific custom field actions.\nAllowed values:\n - field_created\n - field_updated\n - field_disabled\n - field_enabled\n - field_deleted\n - field_added_to_board\n - field_updated_for_board\n - field_removed_from_board\n - allowed_value_created\n - allowed_value_updated\n - allowed_value_deleted\n - allowed_value_disabled\n - allowed_value_enabled\n - allowed_value_added_to_board\n - allowed_value_updated_for_board\n - allowed_value_removed_from_board\n - default_contributor_added_to_board\n - default_contributor_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["field_created","field_updated","field_disabled","field_enabled","field_deleted","field_added_to_board","field_updated_for_board","field_removed_from_board","allowed_value_created","allowed_value_updated","allowed_value_deleted","allowed_value_disabled","allowed_value_enabled","allowed_value_added_to_board","allowed_value_updated_for_board","allowed_value_removed_from_board","default_contributor_added_to_board","default_contributor_removed_from_board"]}},"explode":false,"example":"field_created,field_updated"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported custom field management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportCustomFields"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportCustomFieldsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/stickers\/history":{"get":{"tags":["Exports"],"summary":"Export a list of stickers management history events.","description":"Export a list of stickers management history events.","operationId":"getStickersHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"sticker_ids","in":"query","description":"An array of sticker IDs to filter the export by.\nOnly history events for these stickers will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific sticker actions.\nAllowed values:\n - sticker_created\n - sticker_updated\n - sticker_disabled\n - sticker_enabled\n - sticker_deleted\n - sticker_added_to_board\n - sticker_removed_from_board\n - sticker_updated_for_board\n","required":false,"schema":{"items":{"type":"string","enum":["sticker_created","sticker_updated","sticker_disabled","sticker_enabled","sticker_deleted","sticker_added_to_board","sticker_removed_from_board","sticker_updated_for_board"]}},"explode":false,"example":"sticker_created,sticker_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported stickers management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportStickers"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportStickersExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/tags\/history":{"get":{"tags":["Exports"],"summary":"Export a list of tags management history events.","description":"Export a list of tags management history events.","operationId":"getTagsHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"tag_ids","in":"query","description":"An array of tag IDs to filter the export by.\nOnly history events for these tags will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific tag actions.\nAllowed values:\n - tag_created\n - tag_updated\n - tag_disabled\n - tag_enabled\n - tag_deleted\n - tag_added_to_board\n - tag_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["tag_created","tag_updated","tag_disabled","tag_enabled","tag_deleted","tag_added_to_board","tag_removed_from_board"]}},"explode":false,"example":"tag_created,tag_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported tags management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportTags"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportTagsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/milestones\/history":{"get":{"tags":["Exports"],"summary":"Export a list of milestones management history events.","description":"Export a list of milestones management history events.","operationId":"getMilestonesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"milestone_ids","in":"query","description":"An array of milestone IDs to filter the export by.\nOnly history events for these milestones will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific milestone actions.\nAllowed values:\n - milestone_created\n - milestone_updated\n - milestone_disabled\n - milestone_enabled\n - milestone_deleted\n - milestone_added_to_board\n - milestone_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["milestone_created","milestone_updated","milestone_disabled","milestone_enabled","milestone_deleted","milestone_added_to_board","milestone_removed_from_board"]}},"explode":false,"example":"milestone_created,milestone_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported milestones management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportMilestones"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportMilestonesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/teams\/history":{"get":{"tags":["Exports"],"summary":"Export a list of teams management history events.","description":"Export a list of teams management history events.","operationId":"getTeamsHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"team_ids","in":"query","description":"An array of team IDs to filter the export by.\nOnly history events for these teams will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific team actions.\nAllowed values:\n - team_created\n - team_updated\n - team_deleted\n - team_added_to_board\n - team_change_role_for_board\n - team_removed_from_board\n - user_added_to_team\n - user_removed_from_team\n - user_added_to_team_managers\n - user_removed_from_team_managers\n - added_to_dashboard_page\n - change_permissions_for_dashboard_page\n - removed_from_dashboard_page\n","required":false,"schema":{"items":{"type":"string","enum":["team_created","team_updated","team_deleted","team_added_to_board","team_change_role_for_board","team_removed_from_board","user_added_to_team","user_removed_from_team","user_added_to_team_managers","user_removed_from_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_from_dashboard_page"]}},"explode":false,"example":"team_created,team_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported teams management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportTeams"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportTeamsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/loggedTime\/history":{"get":{"tags":["Exports"],"summary":"Export a list of logged times management history events.","description":"Export a list of logged times management history events.","operationId":"getLoggedTimesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"logged_time_ids","in":"query","description":"An array of logged time IDs to filter the export by.\nOnly history events for these logged times will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,102"},{"name":"card_ids","in":"query","description":"An array of card IDs to filter the export by.\nOnly history events for these cards will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1001,1002"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific logged time actions.\nAllowed values:\n - logged_time_created\n - logged_time_updated\n - logged_time_deleted\n - logged_time_transferred_to_card_after_subtask_deleted\n - logged_time_updated_after_subtask_converted_to_card\n","required":false,"schema":{"items":{"type":"string","enum":["logged_time_created","logged_time_updated","logged_time_deleted","logged_time_transferred_to_card_after_subtask_deleted","logged_time_updated_after_subtask_converted_to_card"]}},"explode":false,"example":"logged_time_created,logged_time_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported logged times management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportLoggedTimes"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportLoggedTimesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/loggedTimeCategories\/history":{"get":{"tags":["Exports"],"summary":"Export a list of logged time categories management history events.","description":"Export a list of logged time categories management history events.","operationId":"getLoggedTimeCategoriesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"category_ids","in":"query","description":"An array of logged time category IDs to filter the export by.\nOnly history events for these categories will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific logged time category actions.\nAllowed values:\n - category_created\n - category_updated\n - category_disabled\n - category_enabled\n - category_deleted\n - category_added_to_board\n - category_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["category_created","category_updated","category_disabled","category_enabled","category_deleted","category_added_to_board","category_removed_from_board"]}},"explode":false,"example":"category_created,category_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported logged time categories management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportLoggedTimeCategories"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportLoggedTimeCategoriesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/blockReasons\/history":{"get":{"tags":["Exports"],"summary":"Export a list of block reasons management history events.","description":"Export a list of block reasons management history events.","operationId":"getBlockReasonsHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"reason_ids","in":"query","description":"An array of block reason IDs to filter the export by.\nOnly history events for these block reasons will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific block reason actions.\nAllowed values:\n - reason_created\n - reason_updated\n - reason_disabled\n - reason_enabled\n - reason_deleted\n - reason_added_to_board\n - reason_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["reason_created","reason_updated","reason_disabled","reason_enabled","reason_deleted","reason_added_to_board","reason_removed_from_board"]}},"explode":false,"example":"reason_created,reason_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported block reasons management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportBlockReasons"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportBlockReasonsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/discardReasons\/history":{"get":{"tags":["Exports"],"summary":"Export a list of discard reasons management history events.","description":"Export a list of discard reasons management history events.","operationId":"getDiscardReasonsHistoryExports","parameters":[{"name":"format","in":"query","description":"The allowed values are xml, excel, csv and json","required":false,"schema":{"type":"string","default":"json"},"explode":false},{"name":"reason_ids","in":"query","description":"A list of the block reason ids that you want to get the history for.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"user_ids","in":"query","description":"A list of user ids that performed an action.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"event_types","in":"query","description":"Type of action executed on the block reason.","required":false,"schema":{"items":{"type":"string","enum":["reason_created","reason_updated","reason_disabled","reason_enabled","reason_deleted","reason_added_to_board","reason_removed_from_board"]}},"explode":false},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"An .xlsx file.","content":{"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}},"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExport"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/cardTemplates\/history":{"get":{"tags":["Exports"],"summary":"Export a list of card templates management history events.","description":"Export a list of card templates management history events.","operationId":"getCardTemplatesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"template_ids","in":"query","description":"An array of card template IDs to filter the export by.\nOnly history events for these card templates will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific card template actions.\nAllowed values:\n - template_created\n - template_updated\n - template_disabled\n - template_enabled\n - template_deleted\n - template_added_to_board\n - template_updated_for_board\n - template_removed_from_board\n - template_structure_updated\n","required":false,"schema":{"items":{"type":"string","enum":["template_created","template_updated","template_disabled","template_enabled","template_deleted","template_added_to_board","template_updated_for_board","template_removed_from_board","template_structure_updated"]}},"explode":false,"example":"template_created,template_added_to_board"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported card templates management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportCardTemplates"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportCardTemplatesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/cardTypes\/history":{"get":{"tags":["Exports"],"summary":"Export a list of card types management history events.","description":"Export a list of card types management history events.","operationId":"getCardTypesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"type_ids","in":"query","description":"An array of card type IDs to filter the export by.\nOnly history events for these card types will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific card type actions.\nAllowed values:\n - type_created\n - type_updated\n - type_disabled\n - type_enabled\n - type_deleted\n - type_added_to_board\n - type_updated_for_board\n - type_removed_from_board\n","required":false,"schema":{"items":{"type":"string","enum":["type_created","type_updated","type_disabled","type_enabled","type_deleted","type_added_to_board","type_updated_for_board","type_removed_from_board"]}},"explode":false,"example":"type_created,type_added_to_board"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported card types management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportCardTypes"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportCardTypesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/internalAnnouncements\/history":{"get":{"tags":["Exports"],"summary":"Export a list of internal announcements management history events.","description":"Export a list of internal announcements management history events.","operationId":"getInternalAnnouncementsHistoryExports","parameters":[{"name":"announcement_ids","in":"query","description":"An array of internal Announcement IDs to filter the export by.\nOnly history events for these announcements will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific internal announcement actions.\nAllowed values:\n - announcement_created\n - announcement_updated\n - announcement_deleted\n - for_role_added\n - for_role_removed\n - for_team_added\n - for_team_removed\n","required":false,"schema":{"items":{"type":"string","enum":["announcement_created","announcement_updated","announcement_deleted","for_role_added","for_role_removed","for_team_added","for_team_removed"]}},"explode":false,"example":"announcement_created,announcement_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported internal announcements management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportInternalAnnouncements"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportInternalAnnouncementsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/baiPrompts\/history":{"get":{"tags":["Exports"],"summary":"Export a list of BAI prompts management history events.","description":"Export a list of BAI prompts management history events.","operationId":"getBaiPromptsHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"prompt_ids","in":"query","description":"An array of BAI prompt IDs to filter the export by.\nOnly history events for these prompts will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific BAI prompt actions.\nAllowed values:\n - prompt_created\n - prompt_updated\n - prompt_deleted\n","required":false,"schema":{"items":{"type":"string","enum":["prompt_created","prompt_updated","prompt_deleted"]}},"explode":false,"example":"prompt_created,prompt_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported BAI prompts management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportBAIPrompts"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportBAIPromptsExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/exports\/roles\/history":{"get":{"tags":["Exports"],"summary":"Export a list of roles management history events.","description":"Export a list of roles management history events.","operationId":"getRolesHistoryExports","parameters":[{"$ref":"#\/components\/parameters\/exportFormat"},{"name":"role_ids","in":"query","description":"An array of role IDs to filter the export by.\nOnly history events for these roles will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"101,202"},{"$ref":"#\/components\/parameters\/exportUserIds"},{"name":"event_types","in":"query","description":"An array of event type strings to filter by specific role actions.\nAllowed values:\n - role_created\n - role_renamed\n - role_deleted\n - permissions_changed\n","required":false,"schema":{"items":{"type":"string","enum":["role_created","role_renamed","role_deleted","permissions_changed"]}},"explode":false,"example":"role_created,role_renamed"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"The exported roles management history file.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/JsonExportRoles"},"example":{"$ref":"#\/components\/responseExamples\/JsonExportRolesExample"}},"application\/xlsx'":{"schema":{"description":"A wrapper for a successful response.","type":"string","format":"binary"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/{user_id}\/globalPrivileges":{"get":{"tags":["Global User Privileges"],"summary":"Get all global privileges and their status for the specified user","description":"Get all global privileges and their status for the specified user. Global privileges represent **admin privileges** that grant elevated access across the entire account.\nAvailable admin privileges include:\n- `owner` - grants access to **all** other privileges.\n- `create_team_workspaces` - allows creating and managing team workspaces within the account.\n- `make_payments` - grants the user access to the **Payment plan** section.\n- `manage_business_rules` - enables management and configuration of the **Business rules** section.\n- `manage_integrations` - permits setup and management of the **Interagrations** section.\n- `invite_users` - allows inviting new users to the account.\n- `manage_teams` - grants the ability to create, update, and delete teams.\n- `manage_user_wip_limits` - allows configuring Work-In-Progress limits for users.\n- `manage_roles` - authorizes managing user roles and permissions.\n- `manage_card_elements` - enables configuration and management of card elements, e.g. **Blockers**, **Stickers**, etc.\n- `manage_security_settings` - grants the user access to the settings **Security & Audit** section. A user **additionally** needs the `access_audit_logs` privilege to view audit logs.\n- `manage_dashboards` - allows creating and managing dashboards.\n- `manage_logged_time` - grants rights to manage time logged on cards.\n- `manage_worklog_configurations` - enables configuration of the **Worklog configurations** section.\n- `access_audit_logs` - allows access to the **Audit logs** section in **Security & Audit**. If a user only has this privilege, they can **only** view audit logs and **cannot** manage security settings.\n- `enable_and_disable_users` - permits enabling or disabling user accounts.\n- `delete_users` - allows deletion of user accounts from the system.\n- `manage_outcome_rules` - grants the user access to the **Outcome rules** section.\n- `manage_data_fields`\n","operationId":"getGlobalUserPrivileges","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of global privileges.","type":"array","items":{"$ref":"#\/components\/schemas\/Privilege"}}}},"example":{"$ref":"#\/components\/responseExamples\/GlobalUserPrivileges"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/{user_id}\/globalPrivileges\/{privilege_name}":{"get":{"tags":["Global User Privileges"],"summary":"Check if the specified user is granted a particular global privilege","description":"Check if the specified user is granted a particular global privilege. If a user isn't granted a particular global privilege, you'll receive a `404` response.","operationId":"getGlobalUserPrivilege","responses":{"204":{"description":"The user has the specified global privilege."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Global User Privileges"],"summary":"Grant the specified user a particular global privilege","description":"Grant the specified user a particular global privilege.\r\n\r\n\r\n> ### Info\r\n>\r\n> If a user is granted the `owner` privilege, they automatically have all other privileges, even if the `available` parameter for those privileges shows a value of `0`.\r\n","operationId":"setGlobalUserPrivilege","responses":{"204":{"description":"The user is now granted the specified global privilege."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Global User Privileges"],"summary":"Remove a particular global privilege from the specified user","description":"Remove a particular global privilege from the specified user.","operationId":"removeGlobalUserPrivilege","responses":{"204":{"description":"The user no longer has the specified global privilege."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"},{"$ref":"#\/components\/parameters\/privilegeName"}]},"\/internalAnnouncements":{"get":{"tags":["Internal Announcements"],"summary":"Get a list of all internal announcements","description":"Announcements are account-wide notifications that allow Owners to communicate important events and news to users within the account.\n\nRetrieve a list of all internal announcements. You can filter the results by various parameters, such as announcement ids, active status, popover display, start and end times, and more.\n","operationId":"getInternalAnnouncements","parameters":[{"name":"announcement_ids","in":"query","description":"A list of internal announcement IDs to retrieve.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"is_active","in":"query","description":"When set to 1 you will only get internal announcements which are started and not expired. When set to 0 you will get expired or announcements which are not yet started.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_popover","in":"query","description":"When set to 1 you will only get internal announcements which are displayed as a popover.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"start_time_from","in":"query","description":"The earliest start date and time from which to retrieve results.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"start_time_to","in":"query","description":"The latest start date and time from which to retrieve results.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"end_time_from","in":"query","description":"The earliest end date and time from which to retrieve results.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"end_time_to","in":"query","description":"The latest end date and time from which to retrieve results.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["announcement_id","title","description","cover_image_link","for_everyone","for_owners","for_workspace_managers","for_role_ids","for_team_ids","is_popover","start_time","end_time","is_active","recurring_definition"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of internal announcements.","type":"array","items":{"$ref":"#\/components\/schemas\/InternalAnnouncement"}}}},"example":{"$ref":"#\/components\/responseExamples\/InternalAnnouncementsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Internal Announcements"],"summary":"Create a new internal announcement","description":"Create a new internal announcement.","operationId":"createInternalAnnouncement","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InternalAnnouncementCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/InternalAnnouncementCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/InternalAnnouncementCreateAndUpdateData"}}},"example":{"$ref":"#\/components\/responseExamples\/InternalAnnouncementCreateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/internalAnnouncements\/{announcement_id}":{"get":{"tags":["Internal Announcements"],"summary":"Get the details of an internal announcement","description":"Get the details of a specific internal announcement.","operationId":"getInternalAnnouncement","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/InternalAnnouncement"}}},"example":{"$ref":"#\/components\/responseExamples\/InternalAnnouncementExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Internal Announcements"],"summary":"Update an internal announcement","description":"Update an internal announcement.","operationId":"updateInternalAnnouncement","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/InternalAnnouncementUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/InternalAnnouncementUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/InternalAnnouncementCreateAndUpdateData"}}},"example":{"$ref":"#\/components\/responseExamples\/InternalAnnouncementExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Internal Announcements"],"summary":"Delete an internal announcement","description":"Delete an internal announcement. This action is irreversible and will permanently remove the announcement from the system.","operationId":"deleteInternalAnnouncement","responses":{"204":{"description":"The internal announcement has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/internalAnnouncements\/history":{"get":{"tags":["Internal Announcement History"],"summary":"Get a list of internal announcements creation, deletion and update events","description":"Retrieves a list of events related to internal announcements.\nThis endpoint allows you to review the history of internal announcements and can be tailored using various filtering options.\n","operationId":"getInternalAnnouncementsHistory","parameters":[{"name":"announcement_ids","in":"query","description":"A list of internal announcement IDs used to filter the internal announcements history to include only internal announcements with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"1,2","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the internal announcements history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"2,3","explode":false},{"name":"event_types","in":"query","description":"A list of event types used to filter the internal announcements history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["announcement_created","announcement_updated","announcement_deleted","for_role_added","for_role_removed","for_team_added","for_team_removed"]}},"explode":false,"example":"announcement_created,announcement_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `200` and the maximum is `1000`.","required":false,"schema":{"format":"int","type":"integer","default":200,"maximum":1000}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of internal announcements history events.","type":"array","items":{"$ref":"#\/components\/schemas\/InternalAnnouncementHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/InternalAnnouncementsHistory"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/internalAnnouncements\/{announcement_id}\/forRoles":{"get":{"tags":["Internal Announcement For Roles"],"summary":"Get a list of roles for which the internal announcement is intended","description":"Get a list of roles for which the internal announcement is intended. Only users with the selected roles will be able to view the announcement.\n\nYou can find a list of all roles in the account by using the [Roles](#\/operations\/getRoles#Request) endpoint.","operationId":"getInternalAnnouncementForRoles","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of role IDs.","type":"array","items":{"type":"object","title":"Role","properties":{"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role for which the internal announcement is intended."}}}}}},"example":{"data":[{"role_id":1},{"role_id":2}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/internalAnnouncements\/{announcement_id}\/forRoles\/{role_id}":{"get":{"tags":["Internal Announcement For Roles"],"summary":"Check if the internal announcement is intended for the specified role","description":"Check if the internal announcement is intended for the specified role.","operationId":"getInternalAnnouncementForRole","responses":{"204":{"description":"The internal announcement is intended for the specified role."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Internal Announcement For Roles"],"summary":"Add a role to the specified internal announcement","description":"Add a role to the specified internal announcement.","operationId":"addInternalAnnouncementForRole","responses":{"204":{"description":"The role has been added to the internal announcement."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Internal Announcement For Roles"],"summary":"Remove a role from the internal announcement","description":"Remove a role from the internal announcement.","operationId":"removeInternalAnnouncementForRole","responses":{"204":{"description":"The role has been removed from the internal announcement."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"},{"$ref":"#\/components\/parameters\/roleIdInPath"}]},"\/internalAnnouncements\/{announcement_id}\/forTeams":{"get":{"tags":["Internal Announcement For Teams"],"summary":"Get a list of teams that the internal announcement is for","description":"Retrieve a list of teams targeted to receive the internal announcement.","operationId":"getInternalAnnouncementForTeams","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of team IDs.","type":"array","items":{"title":"Team","type":"object","properties":{"team_id":{"description":"The ID of the team that the internal announcement is intended for.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"team_id":1},{"team_id":2}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/internalAnnouncements\/{announcement_id}\/forTeams\/{team_id}":{"get":{"tags":["Internal Announcement For Teams"],"summary":"Check if the internal announcement is for a team","description":"Check whether the internal announcement is intended for a specific team.","operationId":"getInternalAnnouncementForTeam","responses":{"204":{"description":"The internal announcement is for the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Internal Announcement For Teams"],"summary":"Add a team to the internal announcement","description":"Add a team to the intended recepients of the internal announcement.","operationId":"addInternalAnnouncementForTeam","responses":{"204":{"description":"The team has been added to the internal announcement."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Internal Announcement For Teams"],"summary":"Remove a team from the internal announcement","description":"Remove a team from the intended recepients of the internal announcement.","operationId":"removeInternalAnnouncementForTeam","responses":{"204":{"description":"The team has been removed from the internal announcement."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"},{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/internalAnnouncements\/{announcement_id}\/views":{"get":{"tags":["Internal Announcement Views"],"summary":"Get a list of views for the specified internal announcement","description":"Retrieve a list of views for the specified internal announcement.","operationId":"getInternalAnnouncementViews","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of views.","type":"array","items":{"title":"Internal Announcement View","type":"object","properties":{"user_id":{"description":"The ID of the user who viewed the internal announcement.","format":"int32","type":"integer"},"time":{"description":"The date and time when the internal announcement was viewed.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"user_id":1,"time":"2025-01-01T12:00:00+00:00"},{"user_id":2,"time":"2025-01-02T15:30:00+00:00"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/integrationSettings":{"get":{"tags":["Integration Settings"],"summary":"Get a list of all integration settings and their values","description":"Get a list of all integration settings for the account and their values.","operationId":"getIntegrationSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of settings.","type":"array","items":{"$ref":"#\/components\/schemas\/Setting"}}}},"example":{"$ref":"#\/components\/responseExamples\/IntegrationSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/integrationSettings\/{setting_name}":{"get":{"tags":["Integration Settings"],"summary":"Get the details of an integration setting and its value","description":"Get the details of an integration setting and its current value.","operationId":"getIntegrationSetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Setting"}}},"example":{"$ref":"#\/components\/responseExamples\/IntegrationSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Integration Settings"],"summary":"Set the value of an integration setting","description":"Set the value of an integration setting.","operationId":"setIntegrationSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"The value of the setting.","required":["value"],"type":"object","properties":{"value":{"description":"Represents the setting's value, which can be either an `integer` or a `string`.","oneOf":[{"type":"integer"},{"type":"string"}]}}}}}},"responses":{"204":{"description":"The value has been set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Integration Settings"],"summary":"Remove the value of an integration setting","description":"Removes the value of an integration setting and sets it to `null`. When an integration setting is `null`, it behaves according to its default value.\n\nAfter removing a setting, the [integrationSettings endpoint](#\/operations\/getIntegrationSettings#Request) will return the default value of the setting, while the [integrationSettings\/{setting_name} endpoint](#\/operations\/getIntegrationSetting#Request) will return `null`.","operationId":"removeIntegrationSetting","responses":{"204":{"description":"The value has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/settingName"}]},"\/boards\/{board_id}\/lanes\/{lane_id}\/defaultSettings":{"get":{"tags":["Lane Default Settings"],"summary":"Get the default values of the specified lane's settings","description":"Get the default values of the specified lane's settings.","operationId":"getLaneDefaultSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of default settings for the specified lane.","type":"array","items":{"$ref":"#\/components\/schemas\/BoardWorkflowAndLaneDefaultSettings"}}}},"example":{"$ref":"#\/components\/responseExamples\/LaneDefaultSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/laneIdInPath"}]},"\/boards\/{board_id}\/lanes\/{lane_id}\/defaultSettings\/{setting_name}":{"get":{"tags":["Lane Default Settings"],"summary":"Get the default value of a specific lane setting","description":"Get the default value of a specific lane setting.","operationId":"getLaneDefaultSetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/BoardWorkflowAndLaneDefaultSettings"}}},"example":{"$ref":"#\/components\/responseExamples\/LaneDefaultSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Lane Default Settings"],"summary":"Update the default value of a specific lane setting","description":"Update the default value of a specific lane setting.","operationId":"updateLaneDefaultSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"The new value of the setting.","type":"object","properties":{"value":{"type":"integer","format":"int32","description":"The unique identifier of the setting."}}},"example":{"value":1}}}},"responses":{"204":{"description":"The setting has been updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Lane Default Settings"],"summary":"Reset the default value of a specific lane setting","description":"Reset the default value of a specific lane setting. This changes the setting's default value to `null`.","operationId":"deleteLaneDefaultSetting","responses":{"204":{"description":"The setting has been reset."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/laneIdInPath"},{"$ref":"#\/components\/parameters\/settingName"}]},"\/boards\/{board_id}\/laneSectionLimits":{"get":{"tags":["Lane Section Limits"],"summary":"Get a list of lane section limits for the 'In Progress' section of the specified board","description":"Get a list of lane section limits for the 'In Progress' section specified board. Each limit repressents the total number of cards allowed in the **In Progress** section of the lane.\n\nTo set limits on a cell or column level you can use the [Cell Limits Endpoint](#\/operations\/getCellLimits#Request) and [Columns endpoint](#\/operations\/getColumns#Request) respectively.","operationId":"getLaneSectionLimits","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of lane section limits for the **In Progress** section of a board.","type":"array","items":{"$ref":"#\/components\/schemas\/LaneSectionLimit"}}}},"example":{"$ref":"#\/components\/responseExamples\/LaneSectionLimitsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Lane Section Limits"],"summary":"Set a lane section limit for the 'In Progress' section of the specified board","description":"Set a lane section limit for the 'In Progress' section of the specified board.","operationId":"setLaneSectionLimit","requestBody":{"content":{"application\/json":{"schema":{"description":"Lane section limit data.","required":["lane_id","section","limit"],"type":"object","properties":{"lane_id":{"format":"int32","type":"integer","description":"The unique identifier of the lane."},"section":{"format":"int32","type":"integer","description":"The section of the lane for which the limit is being set. This is **always** set to `3` as we're setting the limit for the **In Progress** section.","enum":[3]},"limit":{"format":"int32","type":"integer","description":"The work in progress (WIP) limit of the lane section. You can set it to `0` to remove the limit.","maximum":10000}}},"example":{"$ref":"#\/components\/requestExamples\/LaneSectionLimitExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LaneSectionLimit"}}},"example":{"$ref":"#\/components\/responseExamples\/LaneSectionLimitExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/lanes":{"get":{"tags":["Lanes"],"summary":"Get a list of lanes on a board","description":"Retrieve a list of the lanes on a specified board.","operationId":"getLanes","parameters":[{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["lane_id","workflow_id","position","name","description","color"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of lanes.","type":"array","items":{"allOf":[{"type":"object","properties":{"lane_id":{"description":"The unique identifier of the lane.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Lane"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/LanesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Lanes"],"summary":"Create a lane","description":"Create a new lane on a specific board.","operationId":"createLane","requestBody":{"content":{"application\/json":{"schema":{"description":"Lane data.","required":["workflow_id","position","name"],"type":"object","properties":{"workflow_id":{"description":"The ID of the workflow on which the lane will be created. Cannot be used with `parent_lane_id`.","format":"int32","type":"integer"},"parent_lane_id":{"description":"The ID of the parent lane under which the new lane will be created. Cannot be used with `workflow_id`.","format":"int32","type":"integer"},"position":{"description":"The position of the lane within the workflow or its parent lane.","format":"int32","type":"integer"},"name":{"description":"The name of the new lane.","type":"string","minLength":1,"maxLength":100},"description":{"description":"A description of the new lane.","type":"string","default":null},"color":{"description":"The lane color in hexadecimal format.","type":"string","default":"ffffff"}}},"example":{"workflow_id":1,"position":1,"name":"New Lane","description":"This is a new lane.","color":"ffffff"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"lane_id":{"description":"Lane id.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Lane"}]}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/lanes\/{lane_id}":{"get":{"tags":["Lanes"],"summary":"Get the details of a single lane","description":"Get the details of a specific lane on a board.","operationId":"getLane","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Lane"}}},"example":{"$ref":"#\/components\/responseExamples\/LaneExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Lanes"],"summary":"Update a lane","description":"Update a lane.","operationId":"updateLane","requestBody":{"content":{"application\/json":{"schema":{"description":"Lane data.","type":"object","properties":{"parent_lane_id":{"description":"The ID of the parent lane under which the lane will be.","format":"int32","type":"integer"},"position":{"description":"The position of the lane within the workflow or its parent lane.","format":"int32","type":"integer"},"name":{"description":"The name of the lane.","type":"string","minLength":1,"maxLength":100},"description":{"description":"A description of the lane.","type":"string"},"color":{"description":"The color of the lane in hexadecimal format.","type":"string","default":"ffffff"}}},"example":{"parent_lane_id":2,"position":1,"name":"Updated Lane Name","description":"This is an updated lane description.","color":"ffffff"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Lane"}}},"example":{"$ref":"#\/components\/responseExamples\/LaneExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Lanes"],"summary":"Delete a lane","description":"Delete a lane. This action cannot be undone.\n\nIf there are cards present in the lane, it will not be deleted until they're moved to another lane or discarded. You can specify a lane to which the cards will be moved using the `move_cards_to_lane_id` parameter.\n","operationId":"deleteLane","parameters":[{"name":"move_cards_to_lane_id","in":"query","description":"The ID of a lane to which to move the cards from the deleted lane, if there are any.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"move_metrics_to_lane_id","in":"query","description":"The ID of a lane to which to move the cycle time data associated with the deleted lane, if there is any. If this parameter is not provided or is null the cycle time data will be discarded.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The lane has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/laneIdInPath"}]},"\/loggedTime":{"get":{"tags":["Logged Time"],"summary":"Get a list of logged times","description":"Get a list of the logged times added to cards. The logged times are listed in the order in which they were added.","operationId":"getLoggedTimes","parameters":[{"name":"parent_card_ids","in":"query","description":"Filter logged time by parent card IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"card_ids","in":"query","description":"Filter logged time by card IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"user_ids","in":"query","description":"Filter logged time by user IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"category_ids","in":"query","description":"Filter logged time by category IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"include_logged_time_for_subtasks","in":"query","description":"When set to 1 you will get the logged time for all tasks and subtasks.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, based on the date the entry is created for, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, based on the date the entry is created for, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"logged_from","in":"query","description":"The earlist date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"logged_to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"}},{"name":"logged_from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"}},{"name":"logged_to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"}},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `200` and the maximum is `1000`.","required":false,"schema":{"format":"int","type":"integer","default":200,"maximum":1000}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["logged_time_id","parent_card_id","card_id","subtask_id","lane_id","column_id","user_id","category_id","date","time","comment","logged_at"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of card logged times.","type":"array","items":{"$ref":"#\/components\/schemas\/LoggedTime"}}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Logged Time"],"summary":"Add a logged time to a card","description":"Add a logged time to a card","operationId":"addCardLoggedTime","requestBody":{"content":{"application\/json":{"schema":{"description":"Card logged time data.","required":["card_id","time"],"type":"object","properties":{"parent_card_id":{"description":"The ID of the parent card for which the time is logged.","format":"int32","type":"integer"},"card_id":{"description":"The ID of the card for which the time is logged.","format":"int32","type":"integer"},"subtask_id":{"description":"If logging time for a subtask, provide the subtask's ID. If logging time for a card, omit this field or set it to null.","type":"integer"},"lane_id":{"description":"The ID of the lane in which we want the logged time to appear.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column in which we want the logged time to appear.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user for whom the time is logged.","format":"int32","type":"integer"},"category_id":{"description":"The ID of the category for which the time is logged.","format":"int32","type":"integer"},"date":{"description":"The date for which the time is logged.","format":"date","type":"string"},"time":{"description":"The amount of time to log in seconds.","format":"int32","type":"integer","maximum":6000000},"comment":{"description":"An optional comment.","type":"string"}}},"example":{"$ref":"#\/components\/requestExamples\/LoggedTimeRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTime"}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/loggedTime\/{logged_time_id}":{"get":{"tags":["Logged Time"],"summary":"Get the details of a single logged time","description":"Get the details of a specific logged time entry.","operationId":"getLoggedTime","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTime"}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Logged Time"],"summary":"Update card logged time.","description":"Update a card logged time entry.","operationId":"updateLoggedTime","requestBody":{"content":{"application\/json":{"schema":{"description":"Card logged time data.","type":"object","properties":{"lane_id":{"description":"The ID of the lane in which we want the logged time to appear.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column in which we want the logged time to appear.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user for whom the time is logged.","format":"int32","type":"integer"},"category_id":{"description":"The ID of the category for which the time is logged.","format":"int32","type":"integer"},"date":{"description":"The date for which the time is logged.","format":"date","type":"string"},"time":{"description":"The amount of time to log in seconds.","format":"int32","type":"integer"},"comment":{"description":"An optional comment.","type":"string"}}},"example":{"lane_id":150,"column_id":300,"user_id":2,"category_id":5,"date":"2025-01-01","time":3600,"comment":"This is an updated comment. "}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTime"}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Logged Time"],"summary":"Remove a logged time from a card","description":"Remove a logged time entry from a card.","operationId":"removeLoggedTime","responses":{"204":{"description":"The logged time is now removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/loggedTimeIdInPath"}]},"\/loggedTimeCategories\/{category_id}\/boards":{"get":{"tags":["Logged Time Board Categories"],"summary":"Get a list of boards that include the specified logged time category","description":"Get a list of boards that include the specified logged time category. You can get a list of all logged time categories using the [loggedTimeCategories endpoint](#\/operations\/getLoggedTimeCategories#Request).","operationId":"getLoggedTimeCategoryBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"title":"Logged Time Category Board","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoryBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/categoryIdInPath"}]},"\/loggedTimeCategories\/{category_id}\/batchBoardOperations":{"post":{"tags":["Logged Time Board Categories"],"summary":"Change the availability of a logged time category on one or more boards","description":"Change the availability of a logged time category on one or more boards.","operationId":"batchBoardOperations","requestBody":{"content":{"application\/json":{"schema":{"description":"Logged time category data.","type":"object","properties":{"board_ids_to_add":{"description":"A list of board IDs where the logged time category should be made available.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids_to_remove":{"description":"A list of board IDs where the logged time category should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/LoggedTimeCategoriesBatchBoardOperationsExample"}}}},"responses":{"204":{"description":"The logged time category's availability has been updated on the specified board(s)."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/categoryIdInPath"}]},"\/loggedTimeCategories":{"get":{"tags":["Logged Time Categories"],"summary":"Get a list of logged time categories","description":"Retrieve a list of all logged time categories.","operationId":"getLoggedTimeCategories","parameters":[{"name":"category_ids","in":"query","description":"A list of category IDs to retrieve details for.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"label","in":"query","description":"The label of the logged time category to filter by.","schema":{"type":"string"},"explode":false},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the logged time categories.\n\nA value of `0` represents **On-demand**, meaning the category can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the category is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the category is automatically added to all boards across all workspaces. Once a category's availability is set to **Global**, only an Owner can change its availability again.","required":false,"schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2],"default":0}}},{"name":"is_enabled","in":"query","description":"When set to 1, only enabled logged time categories are returned. When set to 0, only disabled categories are returned.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["icon_type","icon_id","category_id","label","description","color","availability","is_enabled"]}},"explode":false},{"name":"expand","in":"query","description":"A list of properties for which you want to get additional details.","schema":{"items":{"type":"string","enum":["board_ids","board_count","total_logged_time"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of logged time categories.","type":"array","items":{"$ref":"#\/components\/schemas\/LoggedTimeCategory"}}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoriesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Logged Time Categories"],"summary":"Create a logged time category","description":"Create a new logged time category.","operationId":"createLoggedTimeCategory","requestBody":{"content":{"application\/json":{"schema":{"description":"Logged time category data.","required":["label"],"type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","enum":[0,1],"default":0},"icon_id":{"description":"An icon for the logged time category. If set to 0, the logged time category will not have an icon.","format":"int32","type":"integer","default":0},"label":{"description":"A label for the new logged time category.","type":"string","minLength":1,"maxLength":250},"description":{"description":"An optional description of the new logged time category.","type":"string"},"color":{"description":"The color of the new logged time category in hexadecimal format.","type":"string","default":"","example":"eceff1"},"availability":{"description":"The availability of the new category. \n\nA value of `0` represents **On-demand**, meaning the category can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the category is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the category is automatically added to all boards across all workspaces. Once a category's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Controls whether the category is enabled or not.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/LoggedTimeCategoryRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTimeCategory"}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/loggedTimeCategories\/{category_id}":{"get":{"tags":["Logged Time Categories"],"summary":"Get the details of a single logged time category","description":"Get the details of a specific logged time category.","operationId":"getLoggedTimeCategory","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTimeCategory"}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Logged Time Categories"],"summary":"Update a logged time category","description":"Update a logged time category.","operationId":"updateLoggedTimeCategory","requestBody":{"content":{"application\/json":{"schema":{"description":"Logged time category data.","type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the logged time category. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","enum":[0,1]},"icon_id":{"description":"An icon for the logged time category. If set to 0, the logged time category will not have an icon.","format":"int32","type":"integer","default":0},"label":{"description":"The **unique** label (i.e. the name) assigned to the logged time category.","type":"string","minLength":1,"maxLength":250},"description":{"description":"An optional description of the logged time category.","type":"string"},"color":{"description":"The color of the logged time category in hexadecimal format.","type":"string","default":"","example":"eceff1"},"availability":{"description":"The availability of the category. \n\nA value of `0` represents **On-demand**, meaning the category can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the category is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the category is automatically added to all boards across all workspaces. Once a category's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2]},"is_enabled":{"description":"Controls whether the category is enabled or not.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"$ref":"#\/components\/requestExamples\/LoggedTimeCategoryRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/LoggedTimeCategory"}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"}}},"delete":{"tags":["Logged Time Categories"],"summary":"Delete a logged time category","description":"Delete a logged time category.","operationId":"deleteLoggedTimeCategory","responses":{"204":{"description":"The logged time category has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/categoryIdInPath"}]},"\/loggedTimeCategories\/history":{"get":{"tags":["Logged Time Category History"],"summary":"Get a list of logged time category creation, deletion and update events","description":"Retrieves a list of events related to logged time categories.\nThis endpoint allows you to review the history of logged time categories and can be tailored using various filtering options.\n","operationId":"getLoggedTimeCategoryHistory","parameters":[{"name":"category_ids","in":"query","description":"A list of logged time category IDs used to filter the logged time category history to include only logged time categories with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the logged time category history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the logged time category history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["category_created","category_updated","category_disabled","category_enabled","category_deleted","category_added_to_board","category_removed_from_board"]}},"explode":false,"example":"category_created,category_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of logged time category creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/LoggedTimeCategoryHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeCategoryHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/loggedTime\/history":{"get":{"tags":["Logged Time History"],"summary":"Get a list of logged time creation, deletion and update events","description":"Retrieves a list of events related to logged time.\nThis endpoint allows you to review the history of logged time and can be tailored using various filtering options.\n","operationId":"getLoggedTimeHistory","parameters":[{"name":"logged_time_ids","in":"query","description":"A list of logged time IDs used to filter the logged time history to include only logged time with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"card_ids","in":"query","description":"A list of card IDs used to filter the logged time history to include only logged time with the specified card IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"example":"5,6","explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the logged time history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the logged time history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["logged_time_created","logged_time_updated","logged_time_deleted","logged_time_transferred_to_card_after_subtask_deleted","logged_time_updated_after_subtask_converted_to_card"]}},"explode":false,"example":"logged_time_created,logged_time_update"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of logged times creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/LoggedTimeHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/LoggedTimeHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/{user_id}\/managedWorkspaces":{"get":{"tags":["Managed Workspaces"],"summary":"Get a list of user's managed workspaces","description":"Get a list of the workspaces where the user is a workspace manager.","operationId":"getManagedWorkspace","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of managed workspaces.","type":"array","items":{"title":"Managed Workspace","type":"object","properties":{"workspace_id":{"description":"The unique identifier of the workspace.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"workspace_id":1},{"workspace_id":2}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/boards\/{board_id}\/mergedAreas":{"get":{"tags":["Merged Areas"],"summary":"Get a list of merged areas","description":"Get a list of the merged areas on a specified board.","operationId":"getMergedAreas","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of merged areas.","type":"array","items":{"allOf":[{"type":"object","properties":{"area_id":{"description":"The unique identifier of the merged area.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/MergedArea"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/MergedAreasExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Merged Areas"],"summary":"Create a merged area","description":"Create a new merged area.","operationId":"createMergedArea","requestBody":{"content":{"application\/json":{"schema":{"description":"Merged area data.","required":["lane_ids","column_ids","primary_column_id"],"type":"object","properties":{"lane_ids":{"description":"The IDs of the lanes which are a part of the merged area.","type":"array","items":{"format":"int32","type":"integer"}},"column_ids":{"description":"The IDs of the columns which are a part of the merged area.","type":"array","items":{"format":"int32","type":"integer"}},"primary_column_id":{"description":"The ID of the column which will reflect the state of the cards in the merged cells in terms of board positioning.","format":"int32","type":"integer"},"limit":{"description":"The limit of cards within the merged area, which restricts the number of cards that can be in the merged area at any given time.","format":"int32","type":"integer","default":0},"card_ordering":{"type":"string","nullable":true,"description":"Specifies how cards are ordered within the merged area. Cards can be ordered by fields such as `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`. The direction can be either ascending (`asc`) or descending (`desc`). The `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"}}},"example":{"$ref":"#\/components\/requestExamples\/MergedAreaRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"area_id":{"description":"The unique identifier of the merged area.","format":"int32","type":"integer"},"board_id":{"description":"The ID of the board to which the merged area belongs.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/MergedArea"}]}}},"example":{"$ref":"#\/components\/responseExamples\/MergedAreaExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/mergedAreas\/{area_id}":{"get":{"tags":["Merged Areas"],"summary":"Get the details of a single merged area","description":"Get the details of a specific merged area.","operationId":"getMergedArea","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/MergedArea"}}},"example":{"$ref":"#\/components\/responseExamples\/MergedAreaExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Merged Areas"],"summary":"Update a merged area","description":"Update a merged area.","operationId":"updateMergedArea","requestBody":{"content":{"application\/json":{"schema":{"description":"Merged area data.","type":"object","properties":{"lane_ids":{"description":"The IDs of the lanes which are a part of the merged area.","type":"array","items":{"format":"int32","type":"integer"}},"column_ids":{"description":"The IDs of the columns which are a part of the merged area.","type":"array","items":{"format":"int32","type":"integer"}},"primary_column_id":{"description":"For merged areas spanning multiple columns, this is the ID of the column which will reflect the state of the cards in the merged cells in terms of board positioning.","format":"int32","type":"integer"},"limit":{"description":"The limit of cards within the merged area, which restricts the number of cards that can be in the merged area at any given time.","format":"int32","type":"integer","maximum":1000},"card_ordering":{"type":"string","nullable":true,"description":"Specifies how cards are ordered within the merged area. Cards can be ordered by fields such as `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`. The direction can be either ascending (`asc`) or descending (`desc`). The `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"}}},"example":{"$ref":"#\/components\/requestExamples\/MergedAreaRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/MergedArea"}}},"example":{"$ref":"#\/components\/responseExamples\/MergedAreaUpdateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Merged Areas"],"summary":"Delete a merged area","description":"Split the merged area into its individual cells.","operationId":"deleteMergedArea","responses":{"204":{"description":"The merged area has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/areaIdInPath"}]},"\/mcpTools":{"get":{"tags":["MCP Tools"],"summary":"Get the account-wide MCP tools catalog and opt-out set","description":"Returns the catalog of MCP tools available on the account, grouped by category (`cards`, `docs`), along with the flat set of tool names that the account administrator has disabled.\n\nOpt-out semantics: tools whose name appears in `disabled_tools` are turned off at the account scope. Tools absent from `disabled_tools` are enabled by default. The intersection of the catalog and the opt-out set defines what the AI agent runtime exposes at the account level.\n","operationId":"getCompanyMcpTools","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"disabled_tools":{"description":"A flat list of tool names that the account administrator has disabled.","type":"array","items":{"type":"string"}},"tools":{"description":"The catalog of available tools, grouped by category.","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"name":{"description":"The wire-protocol name of the tool (matches the `NAME` constant on the tool class).","type":"string"}}}}}}}}},"example":{"data":{"disabled_tools":["search_cards"],"tools":{"cards":[{"name":"get_card_details_batch"},{"name":"search_cards"}],"docs":[{"name":"search_docs"},{"name":"list_docs"}]}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/mcpTools\/{tool_name}":{"put":{"tags":["MCP Tools"],"summary":"Toggle a single MCP tool at the account level","description":"Enables or disables a single MCP tool for the entire account. Requires the **Manage Security Settings** global privilege.\n\nThe `features.bai_mcp.is_enabled` feature flag must be on; otherwise the endpoint returns `403`. Setting `value` to `0` disables the tool (writes an opt-out record), `1` re-enables it (removes the opt-out record).\n","operationId":"setCompanyMcpToolEnabled","requestBody":{"content":{"application\/json":{"schema":{"description":"The new enabled state of the tool at the account scope.","required":["value"],"type":"object","properties":{"value":{"description":"Set to `0` to disable the tool, `1` to re-enable it.","type":"integer","enum":[0,1]}}},"example":{"value":0}}}},"responses":{"204":{"description":"The tool toggle has been applied."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"name":"tool_name","in":"path","description":"The wire-protocol name of the tool. Matches the `NAME` constant on the tool class.","required":true,"schema":{"type":"string"}}]},"\/me":{"get":{"tags":["Me"],"summary":"Get information about the current user","description":"Retrieves details for the currently authenticated user, e.g. their username, email and other profile settings.\n\nA user's information can be updated using the [users endpoint](#\/operations\/updateUser#Request).","operationId":"getCurrentUserData","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The data about the current user.","type":"object","properties":{"user_id":{"description":"The unique identifier of the current user.","format":"int32","type":"integer"},"email":{"description":"The email of the current user.","format":"email","type":"string"},"username":{"description":"The username of the current user.","type":"string"},"realname":{"description":"The full name of the current user.","type":"string"},"avatar":{"description":"The path to the avatar of the current user.","type":"string","example":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80"},"is_tfa_enabled":{"description":"Indicates whether two-factor authentication (2FA) is enabled for the user.","format":"int32","type":"integer","enum":[0,1],"default":0},"is_enabled":{"description":"Indicates whether the user is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1},"is_confirmed":{"description":"Controls whether the user is confirmed or not.","format":"int32","type":"integer","enum":[0,1],"default":1},"registration_date":{"description":"The registration date of the current user in `YYYY-MM-DD` format.","format":"date","type":"string","example":"2025-01-01"},"timezone":{"description":"The timezone of the current user.","type":"string","example":"Europe\/Sofia"},"language":{"description":"The selected language of the current user.","type":"string","example":"en","enum":["en","de","es","pt","fr","it","pl"]}}}}},"example":{"$ref":"#\/components\/responseExamples\/MeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/milestones\/{milestone_id}\/boards":{"get":{"tags":["Milestone Boards"],"summary":"Get a list of boards that include the milestone","description":"Get a list of boards that include the specified milestone. You can get a list of all milestones using the [milestones endpoint](#\/operations\/getMilestones#Request).","operationId":"getMilestoneBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"title":"Milestone Board","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/milestones\/{milestone_id}\/batchBoardOperations":{"post":{"tags":["Milestone Boards"],"summary":"Change the availability of a milestone on one or more boards","description":"Change the availability of a milestone on one or more boards.","operationId":"updateMilestoneBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone boards data.","type":"object","properties":{"board_ids_to_add":{"description":"A list of board IDs where the milestone should be made available.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids_to_remove":{"description":"A list of board IDs where the milestone should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/MilestonesBatchBoardOperationsExample"}}}},"responses":{"204":{"description":"The milestone's availability has been updated on the specified board(s)."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/milestones\/{milestone_id}\/cards":{"get":{"tags":["Milestone Cards"],"summary":"Get a list of cards that include the milestone","description":"Get a list of cards that include the specified milestone. You can get a list of all milestones using the [milestones endpoint](#\/operations\/getMilestones#Request).\n\nIf you'd like to add a milestone to a card, you first need to ensure that the milestone is available on the board where the card is located. To do this, you can use the [milestones\/{milestone_id}\/boards endpoint](#\/opeartions\/getMilestoneBoards#Request). Afterwards, you can use the [cards endpoint](#\/operations\/updateCard#Request) to update the card itself.","operationId":"getMilestoneCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards.","type":"array","items":{"title":"Milestone Card","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The unique identifier of the card."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/milestones\/history":{"get":{"tags":["Milestone History"],"summary":"Get a list of milestone creation, deletion and update events","description":"Retrieves a list of events related to milestones.\nThis endpoint allows you to review the history of milestones and can be tailored using various filtering options.\n","operationId":"getMilestonesHistory","parameters":[{"name":"milestone_ids","in":"query","description":"A list of milestone IDs used to filter the milestone history to include only milestones with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the milestone history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the milestone history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["milestone_created","milestone_updated","milestone_disabled","milestone_enabled","milestone_deleted","milestone_added_to_board","milestone_removed_from_board"]}},"explode":false,"example":"milestone_created,milestone_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of tags creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/MilestoneHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/milestones":{"get":{"tags":["Milestones"],"summary":"Get a list of milestones","description":"Retrieves a list of milestones with their relevant details, optionally filtered using various parameters.","operationId":"getMilestones","parameters":[{"name":"milestone_ids","in":"query","description":"Filters results to include only milestones with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"label","in":"query","description":"Filters milestones by their exact label (i.e. the name of the milestone).","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the milestones.\n\nA value of `0` represents **On-demand**, meaning the milestone can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the milestone is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the milestone is automatically added to all boards across all workspaces. Once a milestone's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"explode":false,"example":"0,1"},{"name":"is_enabled","in":"query","description":"Filters milestones based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["icon_type","icon_id","availability","milestone_id","label","description","color","is_enabled","date"]}},"explode":false,"example":"icon_type,icon_id"},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["board_ids","board_count","card_count","business_rules"]}},"explode":false,"example":"board_ids,board_count"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of tags.","type":"array","items":{"$ref":"#\/components\/schemas\/Milestone"}}}},"example":{"$ref":"#\/components\/responseExamples\/MilestonesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Milestones"],"summary":"Create a milestone","description":"Create a new milestone.","operationId":"createMilestone","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone data.","required":["label","date"],"type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the milestone. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","enum":[0,1],"default":0},"icon_id":{"description":"The unique identifier for the icon associated with the milestone.","format":"int32","type":"integer","default":0},"label":{"description":"The **unique** name assigned to the milestone.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the milestone.","type":"string","maxLength":250},"color":{"type":"string","description":"The color of the milestone in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the milestone.\n\nA value of `0` represents **On-demand**, meaning the milestone can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the milestone is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the milestone is automatically added to all boards across all workspaces. Once a milestone's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the milestone is enabled.","enum":[0,1],"default":1},"date":{"type":"string","format":"date","description":"The date for which the milestone is scheduled in `YYYY-MM-DD` format.","example":"2025-01-01"}}},"example":{"$ref":"#\/components\/requestExamples\/MilestoneRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Milestone"}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/milestones\/{milestone_id}":{"get":{"tags":["Milestones"],"summary":"Get the details of a single milestone","description":"Get the details of a single milestone.\n\n\n> #### Info\n>\n> You can use the [GET \/milestones](#\/operations\/getMilestones) endpoint with the `milestone_ids` query parameter to retrieve multiple milestones in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getMilestone","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Milestone"}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Milestones"],"summary":"Update a milestone","description":"Update a milestone.","operationId":"updateMilestone","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone data.","type":"object","properties":{"icon_type":{"description":"The type of the icon associated with the milestone. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","enum":[0,1],"default":0},"icon_id":{"description":"The unique identifier for the icon associated with the milestone.","format":"int32","type":"integer","default":0},"label":{"description":"The **unique** name assigned to the milestone.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the milestone.","type":"string","maxLength":250},"color":{"type":"string","description":"The color of the milestone in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the milestone.\n\nA value of `0` represents **On-demand**, meaning the milestone can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the milestone is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the milestone is automatically added to all boards across all workspaces. Once a milestone's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the milestone is enabled.","enum":[0,1],"default":1},"date":{"type":"string","format":"date","description":"The date for which the milestone is scheduled in `YYYY-MM-DD` format.","example":"2025-01-01"}}}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Milestone"}}},"example":{"$ref":"#\/components\/responseExamples\/MilestoneExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Milestones"],"summary":"Delete a milestone","description":"Delete a milestone.","operationId":"deleteMilestone","responses":{"204":{"description":"The milestone has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/milestoneIdInPath"}]},"\/milestones\/deleteMany":{"post":{"tags":["Milestone Delete Many"],"summary":"Delete many milestones","description":"Schedule multiple milestones for deletion in a single request. Milestones are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyMilestones","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone IDs data.","type":"object","required":["milestone_ids"],"properties":{"milestone_ids":{"description":"A list of milestone IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"milestone_ids":[1,2]}}}},"responses":{"204":{"description":"The milestones have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/milestones\/disableMany":{"post":{"tags":["Milestone Disable Many"],"summary":"Disable many milestones","description":"Schedule multiple milestones for disabling in a single request. Milestones are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyMilestones","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone IDs data.","type":"object","required":["milestone_ids"],"properties":{"milestone_ids":{"description":"A list of milestone IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"milestone_ids":[1,2]}}}},"responses":{"204":{"description":"The milestones have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/milestones\/enableMany":{"post":{"tags":["Milestone Enable Many"],"summary":"Enable many milestones","description":"Schedule multiple milestones for enabling in a single request. Milestones are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyMilestones","requestBody":{"content":{"application\/json":{"schema":{"description":"Milestone IDs data.","type":"object","required":["milestone_ids"],"properties":{"milestone_ids":{"description":"A list of milestone IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"milestone_ids":[1,2]}}}},"responses":{"204":{"description":"The milestones have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/my\/apiKey\/generate":{"post":{"tags":["My API Key Generate"],"summary":"Generate an API key","description":"Generate an API key for the active user. If an API key was previously generated, it will be rendered inactive and replaced by the new key.","operationId":"generateApiKey","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Generated API key.","type":"object","properties":{"api_key":{"description":"The newly generated API key.","type":"string"}}}}},"example":{"data":{"api_key":"abc123xyz"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/mySettings":{"get":{"tags":["My App Settings"],"summary":"Get a list of all app settings for the active user","description":"Retrieve a list of all app settings and selected values for the active user.","operationId":"getMyAppSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of settings.","type":"array","items":{"$ref":"#\/components\/schemas\/Setting"}}}},"example":{"$ref":"#\/components\/responseExamples\/MyAppSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/mySettings\/{setting_name}":{"get":{"tags":["My App Settings"],"summary":"Get the details of an app setting and its set value","description":"Get the details of an app setting and its currently set value.","operationId":"getMyAppSetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Setting"}}},"example":{"$ref":"#\/components\/responseExamples\/MyAppSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["My App Settings"],"summary":"Set the value of an app setting","description":"Set the value of an app setting.","operationId":"setMyAppSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"The value of the setting.","required":["value"],"type":"object","properties":{"value":{"description":"The value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}]}}},"example":{"value":1}}}},"responses":{"204":{"description":"The value has been set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["My App Settings"],"summary":"Remove the value of an app setting","description":"Removes the value of an application setting and sets it to `null`. When an application setting is `null`, it behaves according to its default value.\n\nAfter removing a setting, the [mySettings endpoint](#\/operations\/getMyAppSettings#Request) will return the default value of the setting, while the [mySettings\/{setting_name} endpoint](#\/operations\/getMyAppSetting#Request) will return `null`.\n","operationId":"removeMyAppSetting","responses":{"204":{"description":"The value has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/settingName"}]},"\/mySettings\/mcpTools":{"get":{"tags":["MCP Tools"],"summary":"Get the user-visible MCP tools catalog and personal opt-out set","description":"Returns the catalog of MCP tools available to the active user, along with the flat set of tool names that the user has personally disabled.\n\nThe `tools` catalog is pre-filtered to exclude any tool that the account administrator has disabled at the company scope. Tools whose name appears in `disabled_tools` are turned off for this user. Tools absent from `disabled_tools` are enabled.\n","operationId":"getMyMcpTools","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"disabled_tools":{"description":"A flat list of tool names that the active user has personally disabled.","type":"array","items":{"type":"string"}},"tools":{"description":"The catalog of tools available to the active user (admin-disabled tools are excluded), grouped by category.","type":"object","additionalProperties":{"type":"array","items":{"type":"object","properties":{"name":{"description":"The wire-protocol name of the tool (matches the `NAME` constant on the tool class).","type":"string"}}}}}}}}},"example":{"data":{"disabled_tools":["add_card_comment_batch"],"tools":{"cards":[{"name":"get_card_details_batch"},{"name":"search_cards"}],"docs":[{"name":"search_docs"}]}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/mySettings\/mcpTools\/{tool_name}":{"put":{"tags":["MCP Tools"],"summary":"Toggle a single MCP tool at the user level","description":"Enables or disables a single MCP tool for the active user. The `features.bai_mcp.is_enabled` feature flag must be on; otherwise the endpoint returns `403`.\n\nSetting `value` to `0` disables the tool (writes an opt-out record), `1` re-enables it (removes the opt-out record).\n","operationId":"setMyMcpToolEnabled","requestBody":{"content":{"application\/json":{"schema":{"description":"The new enabled state of the tool at the user scope.","required":["value"],"type":"object","properties":{"value":{"description":"Set to `0` to disable the tool, `1` to re-enable it.","type":"integer","enum":[0,1]}}},"example":{"value":0}}}},"responses":{"204":{"description":"The tool toggle has been applied."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"name":"tool_name","in":"path","description":"The wire-protocol name of the tool. Matches the `NAME` constant on the tool class.","required":true,"schema":{"type":"string"}}]},"\/myAnnouncements":{"get":{"tags":["My Announcements"],"summary":"Get a list of my internal and system announcements","description":"Get a list of my internal and system announcements.","operationId":"getMyAnnouncements","parameters":[{"name":"announcement_ids","in":"query","description":"A list of announcement IDs that you want to get results for.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"is_seen","in":"query","description":"When set to 1 you will only get seen announcements. When set to 0 you will only get unseen announcements.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]},"explode":false},{"name":"is_active","in":"query","description":"When set to 1 you will only get announcements which are started and not expired. When set to 0 you will get expired or announcements which are not started.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1],"default":1},"explode":false},{"name":"fields","in":"query","description":"A list of fields to be included in the response.","required":false,"schema":{"items":{"type":"string","enum":["announcement_id","title","description","cover_image_link","is_popover","start_time","end_time","is_active","is_seen"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"internal":{"description":"A list of internal announcements.","type":"array","items":{"$ref":"#\/components\/schemas\/MyAnnouncement"}},"system":{"description":"A list of system announcements.","type":"array","items":{"$ref":"#\/components\/schemas\/MyAnnouncement"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/MyAnnouncementsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/myAnnouncements\/internal\/{announcement_id}\/seen":{"put":{"tags":["My Announcements"],"summary":"Mark an internal announcement as seen","description":"Mark an internal announcement as seen.","operationId":"markInternalAnnouncementAsSeen","responses":{"204":{"description":"The announcement has been marked as seen."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/myAnnouncements\/system\/{announcement_id}\/seen":{"put":{"tags":["My Announcements"],"summary":"Mark a system announcement as seen","description":"Mark a system announcement as seen.","operationId":"markSystemAnnouncementAsSeen","responses":{"204":{"description":"The announcement has been marked as seen."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/announcementIdInPath"}]},"\/my\/boardAccessRequests":{"get":{"tags":["My Board Access Requests"],"summary":"Get a list of user's board access requests","description":"Get a list of user's board access requests.","operationId":"getMyBoardAccessRequests","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of board access requests.","type":"array","items":{"title":"Board access request","type":"object","properties":{"board_id":{"description":"The ID of the board for which the access request was made.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who made the access request.","format":"int32","type":"integer"},"comment":{"description":"The comment provided by the user when making the access request.","type":"string"},"time":{"description":"The date and time when the access request was made, in ISO 8601 format.","type":"string","format":"date-time","example":"2025-01-01T12:00:00Z"}}}}}},"example":{"data":[{"board_id":12345,"user_id":67890,"comment":"I would like access to this board for collaboration.","time":"2025-01-01T12:00:00Z"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/my\/pointOfContactForBoards":{"get":{"tags":["My Point Of Contact For Boards"],"summary":"Get a list of boards where the currently authenticated user is a Point of Contact","description":"Get a list of boards where the currently authenticated user is a Point of Contact (POC). Only **owners** and **workspace managers** can be designated as a POC for a board.","operationId":"getMyPointOfContactForBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Get a list of boards where the currently authenticated user is a Point of Contact.","type":"array","items":{"title":"Board IDs","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."}}}}}},"example":{"data":{"board_ids":[315,316]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/mySettings":{"get":{"tags":["My Board Settings"],"summary":"Get a list of all board settings and their set values","description":"Get a list of all board settings and their current values.","operationId":"getMyBoardSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of settings.","type":"array","items":{"$ref":"#\/components\/schemas\/Setting"}}}},"example":{"$ref":"#\/components\/responseExamples\/MyBoardSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/mySettings\/{setting_name}":{"get":{"tags":["My Board Settings"],"summary":"Get the details of a board setting and its set value","description":"Get the details of a board setting and its current value.","operationId":"getMyBoardSetting","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Setting"}}},"example":{"$ref":"#\/components\/responseExamples\/MyBoardSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["My Board Settings"],"summary":"Set the value of a board setting","description":"Set the value of a board setting.","operationId":"setMyBoardSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"The value of the setting.","required":["value"],"type":"object","properties":{"value":{"description":"The value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}]}}},"example":{"value":1}}}},"responses":{"204":{"description":"The value has been set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["My Board Settings"],"summary":"Remove the value of a board setting","description":"Removes the value of a board setting and sets it to `null`. When a board setting is `null`, it behaves according to its default value.\n\nAfter removing a setting, the [mySettings endpoint](#\/operations\/getMyBoardSettings#Request) will return the default value of the setting, while the [mySettings\/{setting_name} endpoint](#\/operations\/getMyBoardSetting#Request) will return `null`.\n","operationId":"removeMyBoardSetting","responses":{"204":{"description":"The value has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/settingName"}]},"\/myBoardSettingsBatchUpdate":{"post":{"tags":["My Boards Settings"],"summary":"Set the values of board settings for a list of boards","description":"Update the values of board settings for multiple boards in a single request.","operationId":"setMySettingsBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Settings boards data.","required":["board_ids","settings"],"type":"object","properties":{"board_ids":{"description":"A list of board IDs where you want to set a list of settings.","type":"array","items":{"format":"int32","type":"integer"}},"settings":{"title":"Board setting","description":"A list of settings whitch you want to set for a list of boards.","type":"array","items":{"required":["setting"],"type":"object","properties":{"setting":{"description":"The name of the setting.","type":"string"},"value":{"description":"The value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}]}}}}}},"example":{"board_ids":[123,456],"settings":[{"setting":"board_settings.board_color","value":"ffffff"},{"setting":"board_settings.default_sender_user_id","value":5}]}}}},"responses":{"204":{"description":"The values have been set."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/myDashboardPages\/{dashboard_page_id}\/settings":{"get":{"tags":["My Dashboard Page Settings"],"summary":"Get a list of settings applied to the user's dashboard page.","description":"Retrieve a list of settings applied to the user's dashboard page.","operationId":"getMyDashboardPageSettings","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of the settings applied to a dashboard page.","type":"array","items":{"$ref":"#\/components\/schemas\/Setting"}}}},"example":{"$ref":"#\/components\/responseExamples\/MyDashboardPageSettingsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/myDashboardPages\/{dashboard_page_id}\/settings\/{setting_name}":{"get":{"tags":["My Dashboard Page Settings"],"summary":"Get the details of specific setting applied to the user's dashboard page","description":"Get the details of specific setting applied to the user's dashboard page.","operationId":"getMyDashboardPageSingleSettingDetails","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Setting"}}},"example":{"$ref":"#\/components\/responseExamples\/MyDashboardPageSingleSettingExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["My Dashboard Page Settings"],"summary":"Update a single user setting for a dashboard page","description":"Update a single user setting for a dashboard page.","operationId":"updateMyDashboardPageSingleSetting","requestBody":{"content":{"application\/json":{"schema":{"description":"The value of the setting.","required":["value"],"type":"object","properties":{"value":{"description":"The value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}]}}},"example":{"value":1}}}},"responses":{"204":{"description":"The setting is now updated."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["My Dashboard Page Settings"],"summary":"Remove the value of a user setting applied to a dashboard page","description":"Removes the value of an setting and sets it to `null`. When an setting is `null`, it behaves according to its default value.\n\nAfter removing a setting, the [settings endpoint](#\/operations\/getMyDashboardPageSettings#Request) will return the default value of the setting, while the [settings\/{setting_name} endpoint](#\/operations\/getMyDashboardPageSingleSettingDetails#Request) will return `null`.\n","operationId":"unsetMyDashboardPageSingleSetting","responses":{"204":{"description":"The setting is not longer applied to the dashboard page."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"},{"$ref":"#\/components\/parameters\/settingName"}]},"\/myDashboardPages":{"get":{"tags":["My Dashboard Pages"],"summary":"Get a list of dashboard pages created by the current user","description":"Get a list of dashboard pages **created** by the current user. You can find a list of all dashboard pages by using the [dashboardPages endpoint](#\/operations\/getDashboardPages#Request).\r\n\r\n\r\n> ### Info\r\n>\r\n> Even if a user is added as a dashboard member or dashboard manager to another dashboard, this endpoint will **always** show **only** the dashboards **created by the current user**.\r\n","operationId":"getMyDashboardPages","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of my dashboard pages.","type":"array","items":{"$ref":"#\/components\/schemas\/MyDashboardPage"}}}},"example":{"$ref":"#\/components\/responseExamples\/MyDashboardPagesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/myDashboardPages\/{dashboard_page_id}":{"get":{"tags":["My Dashboard Pages"],"summary":"Get the details of a specific dashboard page created by the current user","description":"Get the details of a specific dashboard page created by the current user.\r\n\r\n\r\n> ### Info\r\n>\r\n> Trying to get either a nonexistent dashboard page or one that isn't created by the current user will **always** return an **empty array**.\r\n","operationId":"getMyDashboardPage","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/MyDashboardPage"}}},"example":{"$ref":"#\/components\/responseExamples\/MyDashboardPageExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["My Dashboard Pages"],"summary":"Update the position of a specifid dashboard page created by the current user","description":"Update the position of a specifid dashboard page created by the current user.","operationId":"updateMyDashboardPagePosition","requestBody":{"content":{"application\/json":{"schema":{"description":"My dashboard page data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the dashboard page in the list of dashboard pages. `0` is the topmost page.","default":0}}},"example":{"position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/MyDashboardPage"}}},"example":{"$ref":"#\/components\/responseExamples\/MyDashboardPageExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/dashboardPageIdInPath"}]},"\/myFavoriteBoards":{"get":{"tags":["My Favorite Boards"],"summary":"Get a list of favorite boards for the current user","description":"Get a list of favorite boards for the current user. You can find a list of all boards by using the [boards endpoint](#\/operations\/getBoards#Request).","operationId":"getFavoriteBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."},"position":{"format":"int32","type":"integer","description":"The position of the board within the list of favorite boards. `0` is the topmost board.","default":0}}}}}},"example":{"$ref":"#\/components\/responseExamples\/MyFavoriteBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/myFavoriteBoards\/{board_id}":{"get":{"tags":["My Favorite Boards"],"summary":"Get a specific favorite board for the current user","description":"Get a specific favorite board for the current user.","operationId":"checkFavoriteBoard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","description":"My favorite board data.","properties":{"position":{"format":"int32","type":"integer","description":"The position of the board within the list of favorite boards. `0` is the topmost board.","default":0}}}}},"example":{"$ref":"#\/components\/responseExamples\/MyFavoriteBoardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["My Favorite Boards"],"summary":"Add a board to the list of favorite boards of the current user or change its position","description":"Add a board to the list of favorite boards of the current user or change its position.","operationId":"addFavoriteBoard","requestBody":{"content":{"application\/json":{"schema":{"description":"My favorite board data.","type":"object","properties":{"position":{"description":"The position of the board within the list of your favorite boards. `0` is the topmost board.\n\nIf no position is specified in the request, the board will be added to the end of the list of favorite boards.","format":"int32","type":"integer"}}},"example":{"position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"My favorite board data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the board within the list of your favorite boards. `0` is the topmost board."}}}}},"example":{"$ref":"#\/components\/responseExamples\/MyFavoriteBoardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["My Favorite Boards"],"summary":"Remove a board from the list of favorite boards for the current user","description":"Remove a board from the list of favorite boards for the current user.\r\n\r\n\r\n> ### Info\r\n>\r\n> This does **not** delete the board itself, it only removes the board from the list of favorite boards.\r\n","operationId":"removeFavoriteBoard","responses":{"204":{"description":"The board is no longer in the list of favorite boards for the current user."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/myFavoriteDocs":{"get":{"tags":["My Favorite Docs"],"summary":"Get a list of favorite docs for the current user","description":"Get a list of favorite docs for the current user.","operationId":"getFavoriteDocs","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of favorite docs.","type":"array","items":{"type":"object","properties":{"doc_id":{"format":"int32","type":"integer","description":"The unique identifier of the doc."},"position":{"format":"int32","type":"integer","description":"The position of the doc within the list of favorite docs. `0` is the topmost doc.","default":0}}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/myFavoriteDocs\/{doc_id}":{"get":{"tags":["My Favorite Docs"],"summary":"Get a specific favorite doc for the current user","description":"Get a specific favorite doc for the current user.","operationId":"checkFavoriteDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","description":"My favorite doc data.","properties":{"position":{"format":"int32","type":"integer","description":"The position of the doc within the list of favorite docs. `0` is the topmost doc.","default":0}}}}},"example":{"data":{"position":0}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["My Favorite Docs"],"summary":"Add a doc to the list of favorite docs of the current user or change its position","description":"Add a doc to the list of favorite docs of the current user or change its position.","operationId":"addFavoriteDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"requestBody":{"content":{"application\/json":{"schema":{"description":"My favorite doc data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the doc within the list of favorite docs. `0` is the topmost doc.","minimum":0}}},"example":{"position":0}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the doc within the list of favorite docs."}}}}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["My Favorite Docs"],"summary":"Remove a doc from the list of favorite docs of the current user","description":"Remove a doc from the list of favorite docs of the current user.","operationId":"removeFavoriteDoc","parameters":[{"name":"doc_id","in":"path","required":true,"description":"The unique identifier of the doc.","schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The doc has been removed from the list of favorite docs."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/oldApiLimits":{"get":{"tags":["Old API Limits"],"summary":"Get the list of limits for the old API requests","description":"Get a list of the time-based limits for requests made via the old API.","operationId":"getOldApiLimits","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An time-based old API limit.","type":"array","items":{"$ref":"#\/components\/schemas\/OldApiLimit"}}}},"example":{"$ref":"#\/components\/responseExamples\/OldApiLimitsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/oldApiRequestHistory":{"get":{"tags":["Old API Request History"],"summary":"Get a list of old API requests","description":"Get a list of old API requests matching some optional criteria.","operationId":"getOldApiRequestHistory","parameters":[{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the API requests. Only requests executed by these users will be included in the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of API requests.","type":"array","items":{"$ref":"#\/components\/schemas\/OldApiRequestHistoryEvent"}}}},"example":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"user_id":2,"resource":"login_post","time":"2025-08-12T12:22:35+00:00"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/oldApiRequestHistory\/aggregated":{"get":{"tags":["Old API Request History"],"summary":"Get a list of old API requests aggregated by user","description":"Get a list of old API requests aggregated by user matching some optional criteria.","operationId":"getOldApiRequestHistoryAggregated","parameters":[{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the API requests. Only requests executed by these users will be included in the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"aggregation_period","in":"query","description":"The period of time over which the API requests should be aggregated.","required":false,"schema":{"type":"string","enum":["day","hour"],"default":"day"}},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format. If you send from_date but not to_date, to_date will automatically be set to 7 days after from_date. If no filters are provided, the from_date will be set to 7 days before the current date.","required":false,"schema":{"format":"date","type":"string"}},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format. If you send to_date but not from_date, from_date will automatically be set to 7 days before to_date.","required":false,"schema":{"format":"date","type":"string"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An aggregated response of the API's history, grouped by User ID.","type":"array","items":{"$ref":"#\/components\/schemas\/OldApiRequestHistoryAggregated"}}}},"example":{"data":[{"user_id":2,"requests_count":50,"time":"2025-08-12T12:22:35+00:00"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes":{"get":{"tags":["Outcomes"],"summary":"Get a list of outcomes","description":"Retrieves a list of outcomes, optionally filtered by outcome IDs or search, with optional expand for checkpoints, values, tag_ids, links, or usage.","operationId":"getOutcomes","parameters":[{"name":"outcome_ids","in":"query","description":"Filters results to include only outcomes with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2,3"},{"name":"ownership","in":"query","description":"Filter by ownership. `mine` returns only outcomes created by the current user; `all` requires owner privilege and returns all; `filter_allowed` (default) returns outcomes the user is allowed to view.","required":false,"schema":{"type":"string","enum":["mine","filter_allowed","all"],"default":"filter_allowed"}},{"name":"search","in":"query","description":"Search string (minimum 3 characters). Filters outcomes by name or other searchable fields.","required":false,"schema":{"type":"string","minLength":3}},{"name":"expand","in":"query","description":"A list of properties to expand (checkpoints, values, tag_ids, links_to_cards, links_to_outcomes, links_from_outcomes, usage).","required":false,"schema":{"items":{"type":"string","enum":["checkpoints","values","tag_ids","links_to_cards","links_to_outcomes","links_from_outcomes","usage"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of outcomes.","type":"array","items":{"$ref":"#\/components\/schemas\/Outcome"}}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Outcomes"],"summary":"Create an outcome","description":"Create a new outcome.\n","operationId":"createOutcome","requestBody":{"content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/OutcomeCreateWithFieldId"},{"$ref":"#\/components\/schemas\/OutcomeCreateWithRuleId"},{"$ref":"#\/components\/schemas\/OutcomeCreateOwnValue"}]},"example":{"$ref":"#\/components\/requestExamples\/OutcomeCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomeId"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeCreateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}":{"get":{"tags":["Outcomes"],"summary":"Get the details of the specified outcome","description":"Get the details of the specified outcome.\n\n> You can use the [GET \/outcomes](#\/operations\/getOutcomes) endpoint to retrieve multiple outcomes in a single request.\n","operationId":"getOutcome","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomeId"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Outcomes"],"summary":"Update the specified outcome","description":"Update the specified outcome. Send only the properties you want to change (all optional).","operationId":"updateOutcome","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"description":"Outcome update payload. All properties optional. When changing outcome type use at most one of field_id or rule_id (see oneOf). Value fields have mutual exclusions per slot (numeric vs formula vs predefined formula type).","oneOf":[{"$ref":"#\/components\/schemas\/OutcomeUpdateWithFieldId"},{"$ref":"#\/components\/schemas\/OutcomeUpdateWithRuleId"},{"$ref":"#\/components\/schemas\/OutcomeUpdateOwnValue"}]},"example":{"$ref":"#\/components\/requestExamples\/OutcomeUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomePatch"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomePatchExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Outcomes"],"summary":"Delete an outcome","description":"Delete the specified outcome.","operationId":"deleteOutcome","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"204":{"description":"The outcome has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/cards":{"get":{"tags":["Outcomes"],"summary":"Get cards linked to an outcome","description":"Returns a list of card IDs that are linked to the specified outcome. Each item in the response contains a `card_id` identifying a card that has this outcome associated with it.\n","operationId":"getOutcomeCards","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"List of card references linked to the outcome.","type":"array","items":{"type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of a card linked to this outcome."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/TokenCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/history":{"get":{"tags":["Outcomes"],"summary":"Get history for an outcome","description":"Returns the history of changes for the specified outcome. You can filter by user IDs and date range. If no date range is provided, events from the last 7 days are returned.\n","operationId":"getOutcomeHistory","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"name":"user_ids","in":"query","description":"Filter events by user IDs. Only events performed by these users are returned.","required":false,"schema":{"type":"array","items":{"format":"int32","type":"integer"}},"explode":false},{"name":"from_date","in":"query","description":"The earliest date for events to include, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date for events to include, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"List of history events for the outcome.","type":"array","items":{"type":"object","properties":{"history_id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"outcome_id":{"description":"The outcome this event belongs to.","format":"int32","type":"integer"},"event_type":{"description":"The type of event (numeric identifier).","format":"int32","type":"integer"},"event_guid":{"description":"Unique identifier for the event.","type":"string"},"user_id":{"description":"The ID of the user who performed the action.","format":"int32","type":"integer"},"old_value":{"description":"The previous value before the change, if applicable.","type":"string"},"changes":{"description":"Description of what changed.","type":"string"},"time":{"description":"The date and time when the event occurred.","format":"date-time","type":"string"}}}}}},"example":{"data":[{"history_id":101,"outcome_id":5001,"event_type":1,"event_guid":"abc123","user_id":101,"old_value":null,"changes":"string","time":"2025-01-01T00:00:00+00:00"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/tags":{"get":{"tags":["Outcome Tags by Outcome"],"summary":"Get tags linked to an outcome","description":"Returns the list of outcome tag IDs that are linked to the specified outcome. You can get full tag details (e.g. label, color) using the [outcome tags endpoint](#\/operations\/getOutcomeTags) with the returned IDs.\n","operationId":"getOutcomeTagsList","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"List of outcome tags linked to the outcome. Each item contains the outcome tag ID.","type":"array","items":{"type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The ID of an outcome tag linked to this outcome."}}}}},"example":{"data":[{"tag_id":101},{"tag_id":102}]}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/tags\/{tag_id}":{"get":{"tags":["Outcome Tags by Outcome"],"summary":"Check if a tag is linked to an outcome","description":"Verifies if the specified outcome tag is linked to the outcome. Returns 204 No Content when the tag is linked; returns 404 when it is not.","operationId":"checkOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}],"responses":{"204":{"description":"The tag is linked to the outcome."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Outcome Tags by Outcome"],"summary":"Add a tag to an outcome","description":"Links the specified outcome tag to the outcome. The tag must exist (e.g. from [outcome tags](#\/operations\/getOutcomeTags)). Returns 204 No Content on success.","operationId":"addOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}],"responses":{"204":{"description":"The tag has been linked to the outcome."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Outcome Tags by Outcome"],"summary":"Remove a tag from an outcome","description":"Unlinks the specified outcome tag from the outcome. Returns 204 No Content on success.","operationId":"removeOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/tagIdInPath"}],"responses":{"204":{"description":"The tag has been unlinked from the outcome."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/checkpoints":{"get":{"tags":["Outcome Checkpoints"],"summary":"Get checkpoints for an outcome","description":"Returns a list of checkpoints (intermediate targets) for the specified outcome. Each checkpoint has an id, name, time, and value.\n","operationId":"getOutcomeCheckpoints","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"List of checkpoints for the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithId"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomeCheckpointsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Outcome Checkpoints"],"summary":"Add a checkpoint to an outcome","description":"Creates a new checkpoint for the specified outcome. Time, name, and value are required.","operationId":"createOutcomeCheckpoint","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardOutcomeCheckpointCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomeCheckpointExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/checkpoints\/{checkpoint_id}":{"get":{"tags":["Outcome Checkpoints"],"summary":"Get a checkpoint for an outcome","description":"Returns the details of a specific checkpoint (name, time, value) for the specified outcome.","operationId":"getOutcomeCheckpoint","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/checkpointIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpoint"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeCheckpointDetailExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Outcome Checkpoints"],"summary":"Update a checkpoint for an outcome","description":"Updates the specified checkpoint. Send only the properties you want to change (time, name, and value are all optional).","operationId":"updateOutcomeCheckpoint","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/checkpointIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardOutcomeCheckpointUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpoint"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeCheckpointDetailExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Outcome Checkpoints"],"summary":"Delete a checkpoint from an outcome","description":"Removes the specified checkpoint from the outcome.","operationId":"deleteOutcomeCheckpoint","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/checkpointIdInPath"}],"responses":{"204":{"description":"The checkpoint has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/values":{"get":{"tags":["Outcome Values"],"summary":"Get values for an outcome","description":"Returns a list of values (time and value pairs) for the specified outcome. Each value has an id, time, and value.\n","operationId":"getOutcomeValues","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"List of values for the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeValueWithId"}}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomeValuesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Outcome Values"],"summary":"Add a value to an outcome","description":"Creates a new value for the specified outcome. Both time and value are required. Time cannot be in the future.\n","operationId":"createOutcomeValue","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OutcomeValueCreateRequest"},"example":{"$ref":"#\/components\/requestExamples\/OutcomeValueCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeValueWithId"}}},"example":{"$ref":"#\/components\/responseExamples\/CardOutcomeValueExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomes\/{id}\/values\/{value_id}":{"get":{"tags":["Outcome Values"],"summary":"Get a value for an outcome","description":"Returns the details (time and value) of a specific value for the specified outcome.","operationId":"getOutcomeValue","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/outcomeValueIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeValue"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeValueDetailExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Outcome Values"],"summary":"Update a value for an outcome","description":"Updates the specified outcome value. Send only the properties you want to change (time and value are both optional). Time cannot be set to a future date.","operationId":"updateOutcomeValue","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/outcomeValueIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CardOutcomeValueUpdateRequest"},"example":{"$ref":"#\/components\/requestExamples\/CardOutcomeValueUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/CardOutcomeValue"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeValueDetailExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Outcome Values"],"summary":"Delete a value from an outcome","description":"Removes the specified value from the outcome.","operationId":"deleteOutcomeValue","parameters":[{"$ref":"#\/components\/parameters\/outcomesIdInPath"},{"$ref":"#\/components\/parameters\/outcomeValueIdInPath"}],"responses":{"204":{"description":"The value has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomeTags":{"get":{"tags":["Outcome Tags"],"summary":"Get a list of outcome tags","description":"Retrieves a list of outcome tags with their relevant details, optionally filtered by tag IDs or label, and with optional expand for outcome_ids or outcome_count.","operationId":"getOutcomeTags","parameters":[{"name":"tag_ids","in":"query","description":"Filters results to include only outcome tags with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"label","in":"query","description":"Filters outcome tags by their exact label (i.e. the name of the tag).","required":false,"schema":{"type":"string"}},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response. Use outcome_ids to include an array of outcome IDs associated with each tag, or outcome_count to include the number of outcomes per tag.","required":false,"schema":{"items":{"type":"string","enum":["outcome_ids","outcome_count"]}},"explode":false,"example":"outcome_ids,outcome_count"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of outcome tags.","type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeTag"}}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeTagsExpandedExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Outcome Tags"],"summary":"Create an outcome tag","description":"Create a new outcome tag.","operationId":"createOutcomeTag","requestBody":{"content":{"application\/json":{"schema":{"description":"Outcome tag data.","required":["label"],"type":"object","properties":{"label":{"description":"The label (i.e. the name) assigned to the outcome tag. Must be unique.","type":"string","minLength":1,"maxLength":250}}},"example":{"$ref":"#\/components\/requestExamples\/OutcomeTagRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomeTagAndLabel"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeTagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomeTags\/{id}":{"get":{"tags":["Outcome Tags"],"summary":"Get the details of the specified outcome tag","description":"Get the details of the specified outcome tag.\n\n> #### Info\n>\n> You can use the [GET \/outcomeTags](#\/operations\/getOutcomeTags) endpoint to retrieve multiple outcome tags in a single request.\n","operationId":"getOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomeTagIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomeTagAndLabel"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeTagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Outcome Tags"],"summary":"Update the specified outcome tag","description":"Update the specified outcome tag.","operationId":"updateOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomeTagIdInPath"}],"requestBody":{"content":{"application\/json":{"schema":{"description":"Outcome tag data.","type":"object","properties":{"label":{"description":"The label (i.e. the name) assigned to the outcome tag. Must be unique.","type":"string","minLength":1,"maxLength":250}}},"example":{"$ref":"#\/components\/requestExamples\/OutcomeTagUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/OutcomeTagAndLabel"}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeTagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Outcome Tags"],"summary":"Delete an outcome tag","description":"Delete an outcome tag. Optionally specify replace_with_tag_id to reassign all outcomes that use this tag to another outcome tag.","operationId":"deleteOutcomeTag","parameters":[{"$ref":"#\/components\/parameters\/outcomeTagIdInPath"},{"name":"replace_with_tag_id","in":"query","description":"The ID of the outcome tag that will replace the deleted tag for all affected outcomes.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The outcome tag has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/outcomeTags\/{id}\/outcomes":{"get":{"tags":["Outcome Tags"],"summary":"Get outcomes for an outcome tag","description":"Retrieves the list of outcomes associated with the specified outcome tag.","operationId":"getOutcomeTagOutcomes","parameters":[{"$ref":"#\/components\/parameters\/outcomeTagIdInPath"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of outcomes (each with outcome_id) linked to this outcome tag.","type":"array","items":{"type":"object","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/OutcomeTagOutcomesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/boards\/{board_id}\/relatedWorkflows":{"get":{"tags":["Related Workflows"],"summary":"Get a list of related workflows","description":"Retrieve a list of boards and workflows related to a specified board.","operationId":"getRelatedBoardsWorlflows","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards and workflows.","type":"array","items":{"title":"Related workflow","type":"object","properties":{"board_id":{"description":"The ID of the related board.","format":"int32","type":"integer"},"workflow_id":{"description":"The ID of the related workflow.","format":"int32","type":"integer"},"position":{"description":"The position of the related workflow within the board. `0` is the first position.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"board_id":123,"workflow_id":456,"position":0}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/relatedWorkflows\/{workflow_id}":{"get":{"tags":["Related Workflows"],"summary":"Check whether a workflow is related to the current board","description":"Check whether a workflow is related to the current board","operationId":"checkBoardRelatedWorkflow","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A position of workflow.","type":"object","properties":{"position":{"description":"The position of the workflow within the board sidebar. `0` is the first position.","format":"int32","type":"integer"}}}}},"example":{"data":{"position":0}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Related Workflows"],"summary":"Add a related workflow to a board","description":"Add a related workflow to a board.","operationId":"addBoardRelatedWorkflow","requestBody":{"content":{"application\/json":{"schema":{"description":"Position of the workflow","type":"object","properties":{"position":{"description":"The position of the workflow.","format":"int32","type":"integer"}}},"example":{"position":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A position in workflow.","type":"object","properties":{"position":{"description":"The position of the workflow within the board sidebar. `0` is the first position.","format":"int32","type":"integer"}}}}},"example":{"data":{"position":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Related Workflows"],"summary":"Update a related workflow on a board","description":"Update a related workflow on a board.","operationId":"updateBoardRelatedWorkflow","requestBody":{"content":{"application\/json":{"schema":{"description":"Position of the workflow","type":"object","properties":{"position":{"description":"The position of the workflow.","format":"int32","type":"integer"}}},"example":{"position":1}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A position in workflow.","type":"object","properties":{"board_id":{"description":"The ID of the board.","format":"int32","type":"integer"},"related_board_id":{"description":"The ID of the related board.","format":"int32","type":"integer"},"related_workflow_id":{"description":"The ID of the related workflow.","format":"int32","type":"integer"},"position":{"description":"The position of the workflow within the board sidebar. `0` is the first position.","format":"int32","type":"integer"}}}}},"example":{"data":{"board_id":123,"related_board_id":456,"related_workflow_id":789,"position":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Related Workflows"],"summary":"Remove a related workflow from a board","description":"Remove a related workflow from a board.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action doesn't delete the workflow from the original board, it just removes the relationship between the current board and the workflow.","operationId":"removeBoardRelatedWorkflow","responses":{"204":{"description":"The workflow is no longer related to the current board."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/workflowIdInPath"}]},"\/roles\/history":{"get":{"tags":["Role History"],"summary":"Get a list of roles creation, deletion and update events","description":"Retrieves a list of events related to roles.\nThis endpoint allows you to review the history of roles and can be tailored using various filtering options.\n","operationId":"getRolesHistory","parameters":[{"name":"role_ids","in":"query","description":"A list of role IDs used to filter the roles history to include only roles with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the roles history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the roles history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["role_created","role_renamed","role_deleted","permissions_changed"]}},"explode":false,"example":"role_created,role_renamed"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of roles history.","type":"array","items":{"$ref":"#\/components\/schemas\/RoleHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/RoleHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/roles\/{role_id}\/permissions":{"get":{"tags":["Role Permissions"],"summary":"Get the specified role and all permissions granted to it","description":"Get the specified role, list all available permissions and which ones are granted to the role. You can get a list of all roles by using the [roles endpoint](#\/operations\/getRoles#Request).","operationId":"getRolePermissions","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of permissions.","type":"array","items":{"$ref":"#\/components\/schemas\/Permission"}}}},"example":{"$ref":"#\/components\/responseExamples\/RolePermissionsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/roleIdInPath"}]},"\/roles\/{role_id}\/permissions\/{permission_name}":{"get":{"tags":["Role Permissions"],"summary":"Check if a role has the specified permission","description":"Check if a role has the specified permission.","operationId":"getRolePermission","responses":{"204":{"description":"The role has the specified permission."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Role Permissions"],"summary":"Add or update a permission for the specified role","description":"Add or update a permission for the specified role.","operationId":"setRolePermission","responses":{"204":{"description":"The permission has been given."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Role Permissions"],"summary":"Remove a permission for the specified role","description":"Remove a permission for the specified role.","operationId":"removeRolePermission","responses":{"204":{"description":"The permission has been removed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/roleIdInPath"},{"$ref":"#\/components\/parameters\/permissionName"}]},"\/roles":{"get":{"tags":["Roles"],"summary":"Get a list of roles","description":"Retrieves a list of roles and their names.","operationId":"getRoles","parameters":[{"name":"role_ids","in":"query","description":"Filters results to include only roles with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of roles.","type":"array","items":{"allOf":[{"type":"object","properties":{"role_id":{"description":"The unique identifier of the role.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Role"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/RolesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Roles"],"summary":"Create a role","description":"Create a new role. In order to add permissions to a role you need to use the [roles\/{role_id}\/permissions\/{permissions_name} endpoint](#\/operations\/setRolePermission) for each permission that you'd like to grant to the role.\n\n For example if you'd like to add the `cards.create` and `cards.view` permissions to a role, you need to make a **separate** PUT request for each permission. You can find a list of all available permissions for a role by using the [roles\/{role_id}\/permissions endpoint](#\/operations\/getRolePermissions).","operationId":"createRole","requestBody":{"content":{"application\/json":{"schema":{"description":"Role data.","required":["name"],"type":"object","properties":{"name":{"description":"The **unique** name of the role.","type":"string","minLength":1,"maxLength":100}}},"example":{"name":"Customer"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"role_id":{"description":"The unique identifier of the role.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Role"}]}}},"example":{"$ref":"#\/components\/responseExamples\/RoleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/roles\/{role_id}":{"get":{"tags":["Roles"],"summary":"Get the details of a single role","description":"Get the details of a single role.","operationId":"getRole","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Role"}}},"example":{"$ref":"#\/components\/responseExamples\/RoleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Roles"],"summary":"Update a role's name","description":"Update a role's name.","operationId":"updateRole","requestBody":{"content":{"application\/json":{"schema":{"description":"Role data.","type":"object","properties":{"name":{"description":"The **unique** name of the role.","type":"string","minLength":1,"maxLength":100}}},"example":{"name":"Customer"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Role"}}},"example":{"$ref":"#\/components\/responseExamples\/RoleExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Roles"],"summary":"Delete a role","description":"Delete a role.","operationId":"deleteRole","parameters":[{"name":"replace_with_role_id","in":"query","description":"The ID of the role that will replace the deleted role for **all** affected users who are currently assigned the role being deleted.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The role has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/roleIdInPath"}]},"\/stickers\/{sticker_id}\/boards":{"get":{"tags":["Sticker Boards"],"summary":"Get a list of boards where the sticker is available","description":"Retrieves a list of all boards on which the specified sticker is currently available.\n","operationId":"getStickerBoards","responses":{"200":{"description":"Successfully retrieved the list of boards where the sticker is available.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of board IDs where the sticker is available.","type":"array","items":{"type":"object","title":"Sticker Board","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board."}}}}}},"example":{"data":[{"board_id":10},{"board_id":11}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/stickerIdInPath"}]},"\/stickers\/{sticker_id}\/batchBoardOperations":{"post":{"tags":["Sticker Boards"],"summary":"Make a sticker available or unavailable on multiple boards","description":"Add, update, or remove the availability of a sticker on several boards in a single request.\n- Use `boardsToAddOrUpdate` to specify boards where the sticker should be available or update its limits.\n- Use `boardIdsToRemove` to specify boards where the sticker should be made unavailable.\n\nYou can see a list of all boards where the sticker is available in the [sticker boards](#operations\/getStickerBoards#Request) endpoint.\n\nYou can see a list of all boards in the [boards](#operations\/getBoards#Request) endpoint.\n","operationId":"updateStickerBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Object containing board assignment and limit data for the sticker.","type":"object","properties":{"boards_to_add_or_update":{"description":"An array of objects, each representing a board where you want the sticker to be available or update its limits.\nEach object must include the `board_id` and may include `limit_per_board` and `limit_per_card` to restrict sticker usage.\n","type":"array","items":{"required":["board_id"],"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board."},"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board (optional)."},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card (optional)."}}}},"board_ids_to_remove":{"description":"An array of board IDs where you want the sticker to be made unavailable.\n","type":"array","items":{"format":"int32","type":"integer","description":"The ID of the board to remove the sticker from."}}}},"example":{"boards_to_add_or_update":[{"board_id":10,"limit_per_board":5,"limit_per_card":2},{"board_id":11}],"board_ids_to_remove":[12,13]}}}},"responses":{"200":{"description":"Successfully updated the sticker's availability and limits on the specified boards.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board."},"limit_per_board":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on the board."},"limit_per_card":{"format":"int32","type":"integer","description":"The maximum number of times the sticker can be used on a single card."}}}},{"type":"array","items":{"type":"string","description":"An empty array if the sticker is unavailable on the specifed boards."}}]}}},"example":{"data":[{"board_id":10,"limit_per_board":5,"limit_per_card":2},{"board_id":11,"limit_per_board":0,"limit_per_card":0}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/stickerIdInPath"}]},"\/stickers\/{sticker_id}\/cards":{"get":{"tags":["Sticker Cards"],"summary":"Get a list of cards where the sticker is available","description":"Retrieves a list of all cards on which the specified sticker is currently available.\n\nTo get more details about a specific card, use the [cards\/{card_id}](#\/operations\/getCard#Request) endpoint.\n","operationId":"getStickerCards","responses":{"200":{"description":"Successfully retrieved the list of cards where the sticker is available.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of card objects, each representing a card where the sticker is available.","type":"array","items":{"type":"object","title":"Sticker Card","properties":{"id":{"description":"The ID of the sticker assignment on the card.","format":"int32","type":"integer"},"card_id":{"format":"int32","type":"integer","description":"The ID of the card."}}}}}},"example":{"data":[{"id":100,"card_id":1001},{"id":101,"card_id":1002}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/stickerIdInPath"}]},"\/stickers\/history":{"get":{"tags":["Sticker History"],"summary":"Get a list of sticker creation, update, deletion, and board assignment events","description":"Returns a paginated list of sticker history events, including creation, update, enable\/disable, deletion, and board assignment changes.\nYou can filter results by sticker IDs, user IDs, event types, and date ranges.\n\nYou can see a list of all stickers in the [stickers](#operations\/getStickers#Request) endpoint.\n\nYou can see a list of all users in the [users](#operations\/getUsers#Request) endpoint.\n","operationId":"getStickersHistory","parameters":[{"name":"sticker_ids","in":"query","description":"An array of sticker IDs to filter the history results. Only events for these stickers will be included.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"100,101"},{"name":"user_ids","in":"query","description":"An array of user IDs to filter by the users who performed the actions.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"An array of event types to filter the history. Supported values:\n- sticker_created: Sticker was created.\n- sticker_updated: Sticker was updated.\n- sticker_disabled: Sticker was disabled.\n- sticker_enabled: Sticker was enabled.\n- sticker_deleted: Sticker was deleted.\n- sticker_added_to_board: Sticker was added to a board.\n- sticker_removed_from_board: Sticker was removed from a board.\n- sticker_updated_for_board: Sticker properties were updated for a board.\n","required":false,"schema":{"items":{"type":"string","enum":["sticker_created","sticker_updated","sticker_disabled","sticker_enabled","sticker_deleted","sticker_added_to_board","sticker_removed_from_board","sticker_updated_for_board"]}},"explode":false,"example":"sticker_created,sticker_updated"},{"$ref":"#\/components\/parameters\/exportFrom"},{"$ref":"#\/components\/parameters\/exportTo"},{"$ref":"#\/components\/parameters\/exportFromDate"},{"$ref":"#\/components\/parameters\/exportToDate"},{"$ref":"#\/components\/parameters\/exportPage"},{"$ref":"#\/components\/parameters\/exportPerPage"}],"responses":{"200":{"description":"Successfully retrieved the list of sticker history events.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"An array of sticker history events, each representing a creation, update, deletion, or board assignment change.","type":"array","items":{"$ref":"#\/components\/schemas\/StickerHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/StickersHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/stickers":{"get":{"tags":["Stickers"],"summary":"Get a list of stickers","description":"Retrieves a list of stickers, optionally filtered by various criteria.\n","operationId":"getStickers","parameters":[{"name":"sticker_ids","in":"query","description":"An array of sticker IDs to filter the results. Only stickers with these IDs will be returned.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"100,101"},{"name":"label","in":"query","description":"The full label of the sticker to search for. Returns stickers that match this label exactly.","schema":{"type":"string"},"example":"string"},{"name":"availability","in":"query","description":"An array of availability values to filter stickers. Possible values:\n- `0`: On-demand\n- `1`: Auto\n- `2`: Global\n","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"explode":false,"example":"0,1"},{"name":"is_enabled","in":"query","description":"Filter stickers by enabled status. Set to 1 for enabled stickers, 0 for disabled stickers.","schema":{"format":"int32","type":"integer","enum":[0,1]},"example":1},{"name":"fields","in":"query","description":"An array of fields to include in the response for each sticker.\nAllowed fields: sticker_id, icon_type, icon_id, label, color, availability, is_enabled.\n","schema":{"items":{"type":"string","enum":["sticker_id","icon_type","icon_id","label","color","availability","is_enabled"]}},"explode":false,"example":"sticker_id,label"},{"name":"expand","in":"query","description":"An array of properties for which you want to get additional details.\n","schema":{"items":{"type":"string","enum":["board_ids","board_count","card_count","business_rules","arrival_rule_ids","arrival_rule_count","departure_rule_ids","departure_rule_count","template_ids","template_count"]}},"explode":false,"example":"board_ids,board_count"}],"responses":{"200":{"description":"Successfully retrieved the list of stickers.","content":{"application\/json":{"schema":{"description":"Sticker data.","required":["label"],"type":"object","properties":{"data":{"description":"An array of sticker objects matching the filter criteria.","type":"array","items":{"$ref":"#\/components\/schemas\/Sticker"}}}},"example":{"$ref":"#\/components\/responseExamples\/StickersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Stickers"],"summary":"Create a sticker","description":"Create a new sticker.","operationId":"createSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"The data required to create a new sticker.","required":["label"],"type":"object","properties":{"icon_type":{"description":"The type of icon for the sticker. `0` for system icon, `1` for user-defined icon. Defaults to `0`.","format":"int32","type":"integer","default":0},"icon_id":{"description":"The icon ID for the sticker. If set to `0`, the sticker will not have an icon. Must be a non-negative integer. Defaults to `0`.","format":"int32","type":"integer","default":0},"label":{"description":"The label or name for the new sticker. Must be between 1 and 250 characters.","type":"string","minLength":1,"maxLength":250},"color":{"description":"The color of the sticker, represented as a 6-character hexadecimal string (e.g., \"eceff1\"). Can be empty.","type":"string","default":""},"availability":{"description":"Controls how the sticker is made available on boards:\n- `0`: On-demand (must be added to boards manually by workspace managers)\n- `1`: Auto (added automatically to all new boards, but can be removed by workspace managers)\n- `2`: Global (added automatically to all boards and cannot be removed)\nMust be one of: 0, 1, 2. Defaults to `0`.\n","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`). Defaults to `1`.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"icon_type":0,"icon_id":1047,"label":"New Sticker","color":"eceff1","availability":0,"is_enabled":1}}}},"responses":{"200":{"description":"Successfully created the sticker.","content":{"application\/json":{"schema":{"description":"Sticker data.","type":"object","properties":{"data":{"description":"The details of the newly created sticker.","type":"object","properties":{"sticker_id":{"description":"The ID of the new sticker.","format":"int32","type":"integer"},"label":{"description":"The label or name for the sticker.","type":"string"},"icon_type":{"description":"The type of icon for the sticker. `0` for system icon, `1` for user-defined icon.","format":"int32","type":"integer"},"icon_id":{"description":"The icon ID for the sticker. If set to `0`, the sticker will not have an icon.","format":"int32","type":"integer"},"color":{"description":"The color of the sticker, represented as a 6-character hexadecimal string (e.g., \"eceff1\"). Can be empty.","type":"string"},"availability":{"description":"Controls how the sticker is made available on boards:\n- `0`: On-demand (must be added to boards manually)\n- `1`: Auto (added automatically to all new boards, but can be removed)\n- `2`: Global (added automatically to all boards and cannot be removed)\n","format":"int32","type":"integer"},"is_enabled":{"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`).","format":"int32","type":"integer"}}}}},"example":{"data":{"label":"New Sticker","icon_type":0,"icon_id":1047,"color":"eceff1","availability":0,"is_enabled":1,"sticker_id":100}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/stickers\/{sticker_id}":{"get":{"tags":["Stickers"],"summary":"Get the details of a single sticker","description":"Get the details of a single sticker.\n\n\n> #### Info\n>\n> You can use the [GET \/stickers](#\/operations\/getStickers) endpoint with the `sticker_ids` query parameter to retrieve multiple stickers in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getSticker","responses":{"200":{"description":"Successfully retrieved the sticker details.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The details of the sticker.","type":"object","properties":{"sticker_id":{"description":"The ID of the sticker.","format":"int32","type":"integer"},"label":{"description":"The label or name for the sticker.","type":"string"},"icon_type":{"description":"The type of icon for the sticker. `0` for system icon, `1` for user-defined icon.","format":"int32","type":"integer"},"icon_id":{"description":"The icon ID for the sticker. If set to `0`, the sticker will not have an icon.","format":"int32","type":"integer"},"color":{"description":"The color of the sticker, represented as a 6-character hexadecimal string (e.g., \"eceff1\"). Can be empty.","type":"string"},"availability":{"description":"Controls how the sticker is made available on boards:\n- `0`: On-demand (must be added to boards manually)\n- `1`: Auto (added automatically to all new boards, but can be removed)\n- `2`: Global (added automatically to all boards and cannot be removed)\n","format":"int32","type":"integer"},"is_enabled":{"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`).","format":"int32","type":"integer"}}}}},"example":{"data":{"sticker_id":100,"icon_type":0,"icon_id":1047,"label":"string","color":"eceff1","availability":0,"is_enabled":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Stickers"],"summary":"Update a sticker","description":"Updates the properties of an existing sticker.","operationId":"updateSticker","requestBody":{"content":{"application\/json":{"schema":{"description":"The data to update a sticker.","type":"object","properties":{"icon_type":{"description":"The type of icon for the sticker. `0` for system icon, `1` for user-defined icon.","format":"int32","type":"integer"},"icon_id":{"description":"The icon ID for the sticker. If set to `0`, the sticker will not have an icon. Must be a non-negative integer.","format":"int32","type":"integer"},"label":{"description":"The label or name for the sticker. Must be between 1 and 250 characters.","type":"string","minLength":1,"maxLength":250},"color":{"description":"The color of the sticker, represented as a 6-character hexadecimal string (e.g., \"eceff1\"). Can be empty.","type":"string"},"availability":{"description":"Controls how the sticker is made available on boards:\n- `0`: On-demand (must be added to boards manually by workspace managers)\n- `1`: Auto (added automatically to all new boards, but can be removed by workspace managers)\n- `2`: Global (added automatically to all boards and cannot be removed)\nMust be one of: 0, 1, 2.\n","format":"int32","type":"integer","enum":[0,1,2]},"is_enabled":{"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`). Defaults to `1`.","format":"int32","type":"integer","enum":[0,1]}}},"example":{"icon_type":0,"icon_id":1047,"label":"Updated Sticker","color":"eceff1","availability":1,"is_enabled":1}}}},"responses":{"200":{"description":"Successfully updated the sticker.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The details of the updated sticker.","type":"object","properties":{"sticker_id":{"description":"The ID of the sticker.","format":"int32","type":"integer"},"label":{"description":"The label or name for the sticker.","type":"string"},"icon_type":{"description":"The type of icon for the sticker. `0` for system icon, `1` for user-defined icon.","format":"int32","type":"integer"},"icon_id":{"description":"The icon ID for the sticker. If set to `0`, the sticker will not have an icon.","format":"int32","type":"integer"},"color":{"description":"The color of the sticker, represented as a 6-character hexadecimal string (e.g., \"eceff1\"). Can be empty.","type":"string"},"availability":{"description":"Controls how the sticker is made available on boards:\n- `0`: On-demand (must be added to boards manually)\n- `1`: Auto (added automatically to all new boards, but can be removed)\n- `2`: Global (added automatically to all boards and cannot be removed)\n","format":"int32","type":"integer"},"is_enabled":{"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`).","format":"int32","type":"integer"}}}}},"example":{"data":{"sticker_id":100,"icon_type":0,"icon_id":1047,"label":"Updated Sticker","color":"eceff1","availability":1,"is_enabled":1}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Stickers"],"summary":"Delete a sticker","description":"Delete a sticker.","operationId":"deleteSticker","parameters":[{"name":"replace_with_sticker_id","in":"query","description":"The ID of another sticker to replace the deleted sticker on all cards where it is used. If not provided, the sticker will simply be removed from those cards.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The sticker has been deleted successfully."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/stickerIdInPath"}]},"\/stickers\/deleteMany":{"post":{"tags":["Sticker Delete Many"],"summary":"Delete many stickers","description":"Schedule multiple stickers for deletion in a single request. Stickers are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyStickers","requestBody":{"content":{"application\/json":{"schema":{"description":"Sticker IDs data.","type":"object","required":["sticker_ids"],"properties":{"sticker_ids":{"description":"A list of sticker IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"sticker_ids":[1,2]}}}},"responses":{"204":{"description":"The stickers have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/stickers\/disableMany":{"post":{"tags":["Sticker Disable Many"],"summary":"Disable many stickers","description":"Schedule multiple stickers for disabling in a single request. Stickers are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyStickers","requestBody":{"content":{"application\/json":{"schema":{"description":"Sticker IDs data.","type":"object","required":["sticker_ids"],"properties":{"sticker_ids":{"description":"A list of sticker IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"sticker_ids":[1,2]}}}},"responses":{"204":{"description":"The stickers have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/stickers\/enableMany":{"post":{"tags":["Sticker Enable Many"],"summary":"Enable many stickers","description":"Schedule multiple stickers for enabling in a single request. Stickers are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyStickers","requestBody":{"content":{"application\/json":{"schema":{"description":"Sticker IDs data.","type":"object","required":["sticker_ids"],"properties":{"sticker_ids":{"description":"A list of sticker IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"sticker_ids":[1,2]}}}},"responses":{"204":{"description":"The stickers have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/tags":{"get":{"tags":["Tags"],"summary":"Get a list of tags","description":"Retrieves a list of tags with their relevant details, optionally filtered using various parameters.","operationId":"getTags","parameters":[{"name":"tag_ids","in":"query","description":"Filters results to include only tags with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"label","in":"query","description":"Filters tags by their exact label (i.e. the name of the tag).","schema":{"type":"string"}},{"name":"availability","in":"query","description":"A list of the availability levels by which to filter the tags.\n\nA value of `0` represents **On-demand**, meaning the tag can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the tag is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the tag is automatically added to all boards across all workspaces. Once a tag's availability is set to **Global**, only an Owner can change its availability again.","schema":{"items":{"format":"int32","type":"integer","enum":[0,1,2]}},"explode":false,"example":"0,1"},{"name":"is_enabled","in":"query","description":"Filters tags based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["tag_id","label","color","availability","is_enabled"]}},"explode":false,"example":"tag_id,label"},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["board_ids","board_count","card_count","business_rules"]}},"explode":false,"example":"board_ids,board_count"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of tags.","type":"array","items":{"$ref":"#\/components\/schemas\/Tag"}}}},"example":{"$ref":"#\/components\/responseExamples\/TagsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Tags"],"summary":"Create a tag","description":"Create a new tag.","operationId":"createTag","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag data.","required":["label"],"type":"object","properties":{"label":{"description":"The **unique** label (i.e. the name) assigned to the tag.","type":"string","minLength":1,"maxLength":250},"color":{"description":"The color of the tag in hexadecimal format.","type":"string","default":"","example":"eceff1"},"availability":{"description":"The availability level of the tag.\n\nA value of `0` represents **On-demand**, meaning the tag can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the tag is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the tag is automatically added to all boards across all workspaces. Once a tag's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the tag is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/TagRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Tag"}}},"example":{"$ref":"#\/components\/responseExamples\/TagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/tags\/{tag_id}":{"get":{"tags":["Tags"],"summary":"Get the details of the specified tag","description":"Get the details of the specified tag.\n\n\n> #### Info\n>\n> You can use the [GET \/tags](#\/operations\/getTags) endpoint with the `tag_ids` query parameter to retrieve multiple tags in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getTag","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Tag"}}},"example":{"$ref":"#\/components\/responseExamples\/TagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Tags"],"summary":"Update the specified tag","description":"Update the specified tag.","operationId":"updateTag","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag data.","type":"object","properties":{"label":{"description":"The **unique** label (i.e. the name) assigned to the tag.","type":"string","minLength":1,"maxLength":250},"color":{"description":"The color of the tag in hexadecimal format.","type":"string","default":"","example":"eceff1"},"availability":{"description":"The availability level of the tag.\n\nA value of `0` represents **On-demand**, meaning the tag can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the tag is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the tag is automatically added to all boards across all workspaces. Once a tag's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the tag is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/TagRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Tag"}}},"example":{"$ref":"#\/components\/responseExamples\/TagExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Tags"],"summary":"Delete a tag","description":"Delete a tag.","operationId":"deleteTag","parameters":[{"name":"replace_with_tag_id","in":"query","description":"The ID of the tag that will replace the deleted tag for **all** affected cards.","required":false,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The tag has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/tags\/{tag_id}\/boards":{"get":{"tags":["Tag Boards"],"summary":"Get a list of boards that include the specified tag","description":"Get a list of boards that include the specified tag. You can get a list of all tags using the [tags endpoint](#\/operations\/getTags).","operationId":"getTagBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"title":"Tag Board","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/TagBoardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/tags\/{tag_id}\/batchBoardOperations":{"post":{"tags":["Tag Boards"],"summary":"Change the availability of a tag on one or more boards","description":"Change the availability of a tag on one or more boards.","operationId":"updateTagBoards","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag boards data.","type":"object","properties":{"board_ids_to_add":{"description":"A list of board IDs where the tag should be made available.","type":"array","items":{"format":"int32","type":"integer"}},"board_ids_to_remove":{"description":"A list of board IDs where the tag should be made unavailable.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/TagsBatchBoardOperationsExample"}}}},"responses":{"204":{"description":"The tag's availability has been updated on the specified board(s)."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/tags\/{tag_id}\/cards":{"get":{"tags":["Tag Cards"],"summary":"Get a list of cards associated with a specific tag","description":"Get a list of cards where the specified tag is applied. \n\n You can see a list of all tags in the [tags](#operations\/getCardTypes#Request) endpoint.","operationId":"getTagCards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of cards.","type":"array","items":{"type":"object","title":"Tag Card","properties":{"card_id":{"format":"int32","type":"integer","description":"The unique identifier of the card."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/TagCardsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/tagIdInPath"}]},"\/tags\/history":{"get":{"tags":["Tag History"],"summary":"Get a list of tags creation, deletion and update events","description":"Retrieves a list of events related to tags.\nThis endpoint allows you to review the history of tags and can be tailored using various filtering options.\n","operationId":"getTagsHistory","parameters":[{"name":"tag_ids","in":"query","description":"A list of tag IDs used to filter the tags history to include only tags with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the tags history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the tags history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["tag_created","tag_updated","tag_disabled","tag_enabled","tag_deleted","tag_added_to_board","tag_removed_from_board"]}},"explode":false,"example":"tag_created,tag_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of tags creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/TagHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/TagHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/tags\/deleteMany":{"post":{"tags":["Tag Delete Many"],"summary":"Delete many tags","description":"Schedule multiple tags for deletion in a single request. Tags are not deleted immediately \u2014 they are queued for batch processing and the deletion runs in the background. There is no way to estimate how long the process will take.\n","operationId":"deleteManyTags","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag IDs data.","type":"object","required":["tag_ids"],"properties":{"tag_ids":{"description":"A list of tag IDs to be deleted.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"tag_ids":[1,2]}}}},"responses":{"204":{"description":"The tags have been scheduled for deletion. The deletion runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/tags\/disableMany":{"post":{"tags":["Tag Disable Many"],"summary":"Disable many tags","description":"Schedule multiple tags for disabling in a single request. Tags are not disabled immediately \u2014 they are queued for batch processing and the disabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"disableManyTags","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag IDs data.","type":"object","required":["tag_ids"],"properties":{"tag_ids":{"description":"A list of tag IDs to be disabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"tag_ids":[1,2]}}}},"responses":{"204":{"description":"The tags have been scheduled for disabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/tags\/enableMany":{"post":{"tags":["Tag Enable Many"],"summary":"Enable many tags","description":"Schedule multiple tags for enabling in a single request. Tags are not enabled immediately \u2014 they are queued for batch processing and the enabling runs in the background. There is no way to estimate how long the process will take.\n","operationId":"enableManyTags","requestBody":{"content":{"application\/json":{"schema":{"description":"Tag IDs data.","type":"object","required":["tag_ids"],"properties":{"tag_ids":{"description":"A list of tag IDs to be enabled.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"tag_ids":[1,2]}}}},"responses":{"204":{"description":"The tags have been scheduled for enabling. The operation runs in the background as a batch job and may take some time to complete.\n"},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/teams\/{team_id}\/boards":{"get":{"tags":["Team Boards"],"summary":"Get a list of boards where the team is available","description":"Get a list of the boards on which the specified team is available.","operationId":"getTeamBoards","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards.","type":"array","items":{"title":"Board team","type":"object","properties":{"board_id":{"description":"The ID of the board.","format":"int32","type":"integer"},"role_id":{"description":"The ID of the role that the team has on the board.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"board_id":123,"role_id":1},{"board_id":124,"role_id":2}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/teams\/history":{"get":{"tags":["Team History"],"summary":"Get a list of teams creation, deletion and update events","description":"Get a list of teams creation, deletion and update events matching some optional criteria.","operationId":"getTeamsHistory","parameters":[{"name":"team_ids","in":"query","description":"A list of the team IDs that you want to get the history for.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs that performed an action.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"event_types","in":"query","description":"Type of action executed on the team.","required":false,"schema":{"items":{"type":"string","enum":["team_created","team_updated","team_deleted","team_added_to_board","team_change_role_for_board","team_removed_from_board","user_added_to_team","user_removed_from_team","user_added_to_team_managers","user_removed_from_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_from_dashboard_page"]}},"explode":false},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of teams creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/TeamHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/TeamsHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/teams\/{team_id}\/managers":{"get":{"tags":["Team Managers"],"summary":"Get a list of users who can manage the team","description":"Get a list of users who can manage the team. Team managers can add\/remove users as well as edit the team.","operationId":"getTeamManagers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of managers.","type":"array","items":{"title":"Team manager","type":"object","properties":{"user_id":{"description":"The ID of the user who is a team manager.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"user_id":123},{"user_id":456}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/teams\/{team_id}\/managers\/{user_id}":{"get":{"tags":["Team Managers"],"summary":"Check if a user is added as a team manager to a team","description":"Check if a user is added as a team manager to a team.","operationId":"checkTeamManager","responses":{"204":{"description":"The user is added to the team as team manager."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Team Managers"],"summary":"Set a user as a manager of the team","description":"Set a user as a manager of the team.","operationId":"addTeamManager","responses":{"204":{"description":"The user is now a manager of the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Team Managers"],"summary":"Remove a user as a manager of the team","description":"Remove a user as a manager of the team. This action only removes the user's manager status, not the user from the team.","operationId":"removeTeamManager","responses":{"204":{"description":"The user is no longer a manager of the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/teams\/{team_id}\/users":{"get":{"tags":["Team Users"],"summary":"Get a list of users added to a team","description":"Get a list of users added to the specified team.","operationId":"getTeamUsers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of users.","type":"array","items":{"title":"Team user","type":"object","properties":{"user_id":{"description":"The ID of the user who is added to the team.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"user_id":123},{"user_id":456}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/teams\/{team_id}\/users\/{user_id}":{"get":{"tags":["Team Users"],"summary":"Check if a user is added to a team","description":"Check if a user is added to the specified team.","operationId":"checkTeamUser","responses":{"204":{"description":"The user is added to the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Team Users"],"summary":"Add a user to the team","description":"Add a user to the team.","operationId":"addTeamUser","responses":{"204":{"description":"The user is now a member of the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Team Users"],"summary":"Remove a user from the team","description":"Remove a user from the team.","operationId":"removeTeamUser","responses":{"204":{"description":"The user is no longer a member of the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/teams":{"get":{"tags":["Teams"],"summary":"Get a list of teams","description":"Retrieves a list of all teams with their relevant details, optionally filtered using various parameters.","operationId":"getTeams","parameters":[{"name":"team_ids","in":"query","description":"A list of team IDs to filter the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"name","in":"query","description":"Find a team by its full name.","schema":{"type":"string"}},{"name":"fields","in":"query","description":"A list of fields that you want included in the response.","schema":{"items":{"type":"string","enum":["team_id","name"]}},"explode":false},{"name":"expand","in":"query","description":"A list of properties for which you want to get additional details.","schema":{"items":{"type":"string","enum":["boards","user_ids","team_managers"]}},"explode":false}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of teams.","type":"array","items":{"$ref":"#\/components\/schemas\/Team"}}}},"example":{"$ref":"#\/components\/responseExamples\/TeamsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Teams"],"summary":"Create a team","description":"Create a new team.","operationId":"createTeam","requestBody":{"content":{"application\/json":{"schema":{"description":"Team data.","required":["name"],"type":"object","properties":{"name":{"description":"A name for the new team.","type":"string","minLength":1,"maxLength":250},"description":{"description":"The description of the team.","type":"string","default":""}}},"example":{"name":"Development Team","description":"This team is responsible for software development."}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Team"}}},"example":{"$ref":"#\/components\/responseExamples\/TeamExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/teams\/{team_id}":{"get":{"tags":["Teams"],"summary":"Get the details of a single team","description":"Get the details of a single team.","operationId":"getTeam","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Team"}}},"example":{"$ref":"#\/components\/responseExamples\/TeamExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Teams"],"summary":"Update a team","description":"Update a team.","operationId":"updateTeam","requestBody":{"content":{"application\/json":{"schema":{"description":"Team data.","type":"object","properties":{"name":{"description":"The name for the team.","type":"string","minLength":1,"maxLength":250},"description":{"description":"The description of the team.","type":"string"}}},"example":{"name":"Updated Team","description":"Updated team description."}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Team"}}},"example":{"$ref":"#\/components\/responseExamples\/TeamExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Teams"],"summary":"Delete a team","description":"Delete a team.","operationId":"deleteTeam","responses":{"204":{"description":"The team has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/users\/{user_id}\/lastActivity":{"get":{"tags":["User Activity"],"summary":"Get the last activity of a user","description":"Get the last time a user has logged in to the application.","operationId":"getUserLastActivity","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The last activity of a user.","type":"object","properties":{"last_activity":{"description":"The date and time of the last activity of the user, in `ISO 8601` format.","type":"string","format":"date-time","example":"2025-01-01T12:00:00Z"}}}}},"example":{"data":{"last_activity":"2025-01-01T12:00:00Z"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/userAttributes":{"get":{"tags":["User Attributes"],"summary":"Get a list of user attributes","description":"Retrieves a list of user attributes with their relevant details, optionally filtered using various parameters.","operationId":"getUserAttributes","parameters":[{"name":"attribute_ids","in":"query","description":"A list of attribute IDs to filter the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"names","in":"query","description":"Filter attributes by their names.","schema":{"type":"string"}},{"name":"remote_names","in":"query","description":"Filter attributes by their remote names.","schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of user attributes.","type":"array","items":{"title":"User attribute","type":"object","properties":{"attribute_id":{"format":"int32","type":"integer"},"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["User Attributes"],"summary":"Create a user attribute","description":"Create a new user attribute.","operationId":"createUserAttribute","requestBody":{"content":{"application\/json":{"schema":{"description":"User attribute data.","required":["name"],"type":"object","properties":{"name":{"description":"A name for the new user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/UserAttributeCreateExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The new user attribute.","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true},"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/attributes":{"get":{"tags":["User Attributes"],"summary":"Get a list of user attributes","description":"Retrieve a list of all user attributes, optionally filtered using various parameters. This endpoint serves as an alternative to [\/userAttributes endpoint](#\/operations\/getUserAttributes).","operationId":"getUserAttributesAlternative","parameters":[{"name":"attribute_ids","in":"query","description":"A list of attribute IDs to filter the results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"names","in":"query","description":"Filter attributes by their names.","schema":{"type":"string"}},{"name":"remote_names","in":"query","description":"Filter attributes by their remote names.","schema":{"type":"string"}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of user attributes.","type":"array","items":{"title":"User attribute","type":"object","properties":{"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"},"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["User Attributes"],"summary":"Create a user attribute","description":"Create a new user attribute. This endpoint serves as an alternative to [\/userAttributes endpoint](#\/operations\/createUserAttribute).","operationId":"createUserAttributeAlternative","requestBody":{"content":{"application\/json":{"schema":{"description":"User attribute data.","required":["name"],"type":"object","properties":{"name":{"description":"A name for the new user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/UserAttributeCreateExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The new user attribute.","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true},"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/userAttributes\/{attribute_id}":{"get":{"tags":["User Attributes"],"summary":"Get the details of a single user attribute","description":"Get the details of a single user attribute.","operationId":"getUserAttribute","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The user attribute.","type":"object","properties":{"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"},"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["User Attributes"],"summary":"Update a user attribute","description":"Update a user attribute.","operationId":"updateUserAttribute","requestBody":{"content":{"application\/json":{"schema":{"description":"User attribute data.","type":"object","properties":{"name":{"description":"The name for the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/UserAttributeCreateExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The updated user attribute.","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"data":{"name":"New attribute","remote_name":"New attribute remote"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["User Attributes"],"summary":"Delete a user attribute","description":"Delete a user attribute.","operationId":"deleteUserAttribute","responses":{"204":{"description":"The user attribute has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/attributeIdInPath"}]},"\/users\/attributes\/{attribute_id}":{"get":{"tags":["User Attributes"],"summary":"Get the details of a single user attribute","description":"Get the details of a single user attribute. This endpoint serves as an alternative to [\/userAttributes\/{attribute_id} endpoint](#\/operations\/getUserAttribute).","operationId":"getUserAttributeAlternative","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The user attribute.","type":"object","properties":{"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"},"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/attributeIdInPath"}],"patch":{"tags":["User Attributes"],"summary":"Update a user attribute","description":"Update a user attribute. This endpoint serves as an alternative to [\/userAttributes\/{attribute_id} endpoint](#\/operations\/updateUserAttribute).","operationId":"updateUserAttributeAlternative","requestBody":{"content":{"application\/json":{"schema":{"description":"User attribute data.","type":"object","properties":{"name":{"description":"The name for the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/UserAttributeCreateExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The updated user attribute.","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"data":{"name":"New attribute","remote_name":"New attribute remote"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["User Attributes"],"summary":"Delete a user attribute","description":"Delete a user attribute. This endpoint serves as an alternative to [\/userAttributes\/{attribute_id} endpoint](#\/operations\/deleteUserAttribute).","operationId":"deleteUserAttributeAlternative","responses":{"204":{"description":"The user attribute has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/userAttributes\/batchOperations":{"post":{"tags":["User Attributes"],"summary":"Perform batch operations on user attributes","description":"Perform batch operations such as creating, updating, or deleting multiple user attributes in a single request.","operationId":"batchUserAttributesOperations","requestBody":{"content":{"application\/json":{"schema":{"description":"Batch operations data.","type":"object","properties":{"attributes_to_add":{"description":"A list of attributes to create.","type":"array","items":{"title":"Attribute to create","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}},"attributes_to_update":{"description":"A list of attributes to update.","type":"array","items":{"title":"Attribute to update","type":"object","properties":{"attribute_id":{"description":"The ID of the user attribute to update.","format":"int32","type":"integer"},"name":{"description":"The new name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The new remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}},"attribute_ids_to_delete":{"description":"A list of attribute IDs to delete.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"attributes_to_add":[{"name":"New Attribute","remote_name":"New Attribute Remote"}],"attributes_to_update":[{"attribute_id":1,"name":"Updated Attribute","remote_name":"Updated Remote Name"}],"attribute_ids_to_delete":[4,5]}}}},"responses":{"204":{"description":"The batch operations have been successfully processed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"}}}},"\/users\/attributes\/batchOperations":{"post":{"tags":["User Attributes"],"summary":"Perform batch operations on user attributes","description":"Perform batch operations such as creating, updating, or deleting multiple user attributes in a single request. This endpoint serves as an alternative to [\/userAttributes\/batchOperations endpoint](#\/operations\/batchUserAttributesOperations).","operationId":"batchUserAttributesOperationsAlternative","requestBody":{"content":{"application\/json":{"schema":{"description":"Batch operations data.","type":"object","properties":{"attributes_to_add":{"description":"A list of attributes to create.","type":"array","items":{"title":"Attribute to create","type":"object","properties":{"name":{"description":"The name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}},"attributes_to_update":{"description":"A list of attributes to update.","type":"array","items":{"title":"Attribute to update","type":"object","properties":{"attribute_id":{"description":"The ID of the user attribute to update.","format":"int32","type":"integer"},"name":{"description":"The new name of the user attribute.","type":"string","minLength":1,"maxLength":100},"remote_name":{"description":"The new remote name of the user attribute.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}},"attribute_ids_to_delete":{"description":"A list of attribute IDs to delete.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"attributes_to_add":[{"name":"New Attribute","remote_name":"New Attribute Remote"}],"attributes_to_update":[{"attribute_id":1,"name":"Updated Attribute","remote_name":"Updated Remote Name"}],"attribute_ids_to_delete":[4,5]}}}},"responses":{"204":{"description":"The batch operations have been successfully processed."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"}}}},"\/users\/{user_id}\/attributes":{"get":{"tags":["Users' Attributes"],"summary":"Get the attributes of a user","description":"Get all attributes assigned to a specific user.\nEach attribute includes the user's ID, the attribute's unique ID, and its value.\n\nRelated endpoints:\n- List all users: [\/users](#\/operations\/getUsers)\n- List all available attributes: [\/user attributes](#\/operations\/getUserAttributes)\n","operationId":"getUsersAttributes","responses":{"200":{"description":"Successfully retrieved the user's attributes.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of attribute objects assigned to the user.","type":"array","items":{"title":"User's attribute","type":"object","properties":{"user_id":{"description":"The ID of the user.","format":"int32","type":"integer"},"attribute_id":{"description":"The ID of the attribute.","format":"int32","type":"integer"},"value":{"description":"The value assigned to the attribute for this user.","type":"string"}}}}}},"example":{"$ref":"#\/components\/responseExamples\/UsersAttributesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/{user_id}\/attributes\/{attribute_id}":{"get":{"tags":["Users' Attributes"],"summary":"Get the value of a user attribute","description":"Get the value of a specific attribute assigned to a user.\n\nRelated endpoints:\n- List all users: [\/users](#\/operations\/getUsers)\n- List all available attributes: [\/user attributes](#\/operations\/getUserAttributes)\n- List attributes assigned to a user: [\/users attributes](#\/operations\/getUsersAttributes)\n","operationId":"getUsersAttribute","responses":{"200":{"description":"Successfully retrieved the user's attribute value.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"Object containing the user's attribute value.","type":"object","properties":{"user_id":{"description":"The ID of the user.","format":"int32","type":"integer"},"attribute_id":{"description":"The ID of the attribute.","format":"int32","type":"integer"},"value":{"description":"The value assigned to the attribute for this user.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/UsersAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Users' Attributes"],"summary":"Set the value of a user attribute","description":"Sets or updates the value of a specific attribute for a user.\n\nRelated endpoints:\n- List all users: [\/users](#\/operations\/getUsers)\n- List all available attributes: [\/user attributes](#\/operations\/getUserAttributes)\n- List attributes assigned to a user: [\/users attributes](#\/operations\/getUsersAttributes)\n","operationId":"setUserAttribute","requestBody":{"content":{"application\/json":{"schema":{"description":"The value to set for the user attribute.","required":["value"],"type":"object","properties":{"value":{"description":"The value to assign to the user attribute. Must be a string between 1 and 250 characters, or null.","type":"string","minLength":1,"maxLength":250,"nullable":true}}},"example":{"value":"Sales"}}}},"responses":{"200":{"description":"Successfully set the value of the user attribute.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"The updated user attribute value.","type":"object","properties":{"user_id":{"description":"The ID of the user.","format":"int32","type":"integer"},"attribute_id":{"description":"The ID of the user attribute.","format":"int32","type":"integer"},"value":{"description":"The value assigned to the attribute for this user.","type":"string","minLength":1,"maxLength":250,"nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/UsersAttributeExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Users' Attributes"],"summary":"Delete an attribute from a user","description":"Deletes the specified attribute from the user.\nThis operation will unassign the attribute and its value from the user.\n\nRelated endpoints:\n- List all users: [\/users](#\/operations\/getUsers)\n- List all available attributes: [\/user attributes](#\/operations\/getUserAttributes)\n- List attributes assigned to a user: [\/users attributes](#\/operations\/getUsersAttributes)\n","operationId":"deleteUsersAttribute","responses":{"204":{"description":"The attribute has been successfully removed from the user."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"},{"$ref":"#\/components\/parameters\/attributeIdInPath"}]},"\/users\/{user_id}\/boardRoles":{"get":{"tags":["User Boards"],"summary":"Get a list of boards the user is assigned to","description":"Get a list of the boards to which the user is assigned and with what role.","operationId":"getUserBoardRoles","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of boards and board roles.","type":"array","items":{"title":"Board and role","type":"object","properties":{"board_id":{"description":"The ID of the board the user is assigned to.","format":"int32","type":"integer"},"role_id":{"description":"The ID of the role the user has on the board.","format":"int32","type":"integer"}}}}}},"example":{"data":[{"board_id":1,"role_id":2},{"board_id":2,"role_id":4}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/history":{"get":{"tags":["User History"],"summary":"Get a list of user management history events","description":"Get a list of user management history events.","operationId":"getUsersHistory","parameters":[{"name":"affected_user_ids","in":"query","description":"A list of affected user IDs to filter the history results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"user_ids","in":"query","description":"A list of user IDs performing the action to filter the history results.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false},{"name":"event_types","in":"query","description":"Type of action executed on the user.","required":false,"schema":{"items":{"type":"string","enum":["user_confirmed","user_deleted","email_changed","username_changed","realname_changed","email_signature_changed","avatar_changed","tfa_changed","tfa_enabled","tfa_disabled","tfa_key_changed","tfa_key_reset","api_key_changed","timezone_changed","language_changed","password_changed","added_to_team","removed_from_team","added_to_team_managers","removed_from_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_from_dashboard_page","user_disabled","user_enabled","wip_limits_changed","global_privilege_added","global_privilege_removed","made_wm","made_non_wm","assigned_to_board","unassigned_from_board","board_role_changed","user_attribute_added","user_attribute_changed","user_attribute_removed","invitation_sent","invitation_code_changed"]}},"explode":false},{"name":"from","in":"query","description":"The earliest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The latest date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The earliest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The latest date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of user management history events.","type":"array","items":{"$ref":"#\/components\/schemas\/UserHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/UserHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/{user_id}\/involvedBusinessRules":{"get":{"tags":["User Involved Business Rules"],"summary":"Get a list of business rules that include the specified user","description":"Get a list of business rules that include the specified user. A business rule is considered to include a user if the user is either the creator of the rule or if the user is included as a filter.","operationId":"getUserInvolvedBusinessRules","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"object","description":"Contains the unique identifier of the specified user and the business rules associated with them.","additionalProperties":{"type":"array","items":{"title":"User Involved Business Rule","type":"object","description":"Contains the details of a business rule.","properties":{"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of the business rule."},"name":{"type":"string","description":"The name of the business rule."}}}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserInvolvedBusinessRulesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/{user_id}\/teams":{"get":{"tags":["User Teams"],"summary":"Get a list of teams to which the specified user is assigned","description":"Get a list of teams to which the specified user is assigned. You can add a user to a team by making a **PUT** request to the [teams\/{team_id}\/users\/{user_id}](#\/operations\/addTeamUser) endpoint.","operationId":"getUserTeams","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of teams.","type":"array","items":{"title":"User Team","type":"object","properties":{"team_id":{"format":"int32","type":"integer","description":"The unique identifier of the team."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/UserTeamsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/{user_id}\/teams\/{team_id}":{"get":{"tags":["User Teams"],"summary":"Check if the specified user is assigned to a particular team","description":"Check if the specified user is assigned to a particular team.","operationId":"checkUserTeam","responses":{"204":{"description":"The user is assigned to the team."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"},{"$ref":"#\/components\/parameters\/teamIdInPath"}]},"\/users":{"get":{"tags":["Users"],"summary":"Get a list of users","description":"Retrieves a list of users with their relevant details, optionally filtered using various parameters.","operationId":"getUsers","parameters":[{"name":"user_ids","in":"query","description":"Filters results to include only users with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"emails","in":"query","description":"Filters results to include only users with matching emails.","required":false,"schema":{"items":{"format":"string"}},"explode":false,"example":"email1@address.com,email2@address.com"},{"name":"usernames","in":"query","description":"Filters results to include only users with matching usernames.","required":false,"schema":{"items":{"format":"string"}},"explode":false,"example":"username1,username2"},{"name":"is_enabled","in":"query","description":"Filters users based on whether they are enabled.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"is_confirmed","in":"query","description":"Filters users based on whether they are confirmed.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"if_assigned_where_i_am","in":"query","description":"Filters users based on whether they are assigned to the same boards as the currently authenticated user.\nThe user needs to be assigned to **at least one board** to which the currently authenticated user is assigned.\n\nIt's possible to get the same user as a result when using this filter with a value of `1` or `0`, if the user is also assigned to other boards to which the currently authenticated user is not assigned.\n\nThe currently authenticated user will **always** be returned, regardless of the value of this filter.\n","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["user_id","email","username","realname","avatar","is_enabled","is_confirmed","is_tfa_enabled","registration_date","timezone","language"]}},"explode":false,"example":"user_id,email"},{"name":"expand","in":"query","description":"A list of properties to expand for additional details in the response.","schema":{"items":{"type":"string","enum":["invitation_status","global_privileges","board_roles","managed_workspaces","last_activity"]}},"explode":false,"example":"invitation_status,global_privileges"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of users.","type":"array","items":{"$ref":"#\/components\/schemas\/Users"}}},"example":{"$ref":"#\/components\/responseExamples\/UsersExample"}}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/{user_id}":{"get":{"tags":["Users"],"summary":"Get the details of the specified user","description":"Get the details of the specified user.\n\n\n> #### Info\n>\n> You can use the [GET \/users](#\/operations\/getUsers) endpoint with the `user_ids` query parameter to retrieve multiple users in a single request. You can further refine the response by adding query parameters such as `fields` to return only specific attributes, or `expand` to include additional details about related resources.\n","operationId":"getUser","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/User"}}},"example":{"$ref":"#\/components\/responseExamples\/UserExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Users"],"summary":"Update the specified user","description":"Update the specified user.","operationId":"updateUser","requestBody":{"content":{"application\/json":{"schema":{"description":"User data.","type":"object","properties":{"email":{"description":"The email address of the user.","format":"email","type":"string"},"username":{"description":"The username of the user.","type":"string","minLength":1,"maxLength":100},"realname":{"description":"The real name of the user.","type":"string","minLength":1,"maxLength":100},"avatar":{"type":"string","description":"A link to the uploaded file for the user's avatar.","default":null,"example":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80"},"email_signature":{"description":"The email signature of the user. This signature is automatically added to all email messages sent from the Comments section of a card.","type":"string","default":null,"example":"

Lorem ipsum dolor sit amet.<\/p>"},"is_enabled":{"description":"Indicates whether the user is enabled.","format":"int32","type":"integer","enum":[0,1],"default":0},"is_tfa_enabled":{"description":"Indicates whether two-factor authentication is enabled for the user.","format":"int32","type":"integer","enum":[0,1],"default":0},"attributes_to_add_or_update":{"description":"A list of additional attributes to add or update for the user.","type":"array","items":{"type":"object","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The unique identifier of the user attribute."},"value":{"type":"string","description":"The value of the user attribute."}}}},"attribute_ids_to_delete":{"description":"A list of attribute IDs to delete for the specified user.","type":"array","items":{"format":"int32","type":"integer"}}}},"example":{"$ref":"#\/components\/requestExamples\/UserRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/User"}}},"example":{"$ref":"#\/components\/responseExamples\/UserExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Users"],"summary":"Delete the specified user","description":"Delete the specified user.","operationId":"deleteUser","responses":{"204":{"description":"The user has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/users\/invite":{"post":{"tags":["Users"],"summary":"Add and invite a new user","description":"Add and invite a new user. This will send an invitation email to the user with a link to set their password and log in. Once the user accepts the invitation, they will have their `is_confirmed` and `is_enabled` parameters set to `1`.","operationId":"inviteUser","requestBody":{"content":{"application\/json":{"schema":{"description":"Specifies the user's email, attributes to be added, and whether a confirmation email will be sent.","required":["email"],"type":"object","properties":{"email":{"description":"The email of the new user.","format":"email","type":"string"},"attributes_to_add":{"description":"A list of attributes to add.","type":"array","items":{"type":"object","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The unique identifier of the user attribute."},"value":{"type":"string","description":"The value of the user attribute."}}}},"do_not_send_confirmation_email":{"description":"Determines whether to send a confirmation email to the new user. If set to `1`, no email will be sent, and an admin will need to use the [resendInvitation endpoint](#\/operations\/resendInvitation) to send the invitation email later.","format":"int32","type":"integer","default":0,"enum":[0,1]}}},"example":{"$ref":"#\/components\/requestExamples\/InviteUserRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"user_id":{"description":"The unique identifier of the user.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/User"}]}}},"example":{"$ref":"#\/components\/responseExamples\/UserInviteExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/users\/{user_id}\/resendInvitation":{"post":{"tags":["Users"],"summary":"Resend an invitation","description":"Send a new invitation email to the user.","operationId":"resendInvitation","parameters":[{"name":"user_id","in":"path","description":"The unique identifier of the user.","required":true,"schema":{"type":"integer"}}],"responses":{"204":{"description":"A new invitation email has been sent."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/webhooks":{"get":{"tags":["Webhooks"],"summary":"Get all webhooks","description":"Get a list of all currently defined webhooks.\nYou can optionally filter the results by providing one or more board IDs.\n\nYou can see a list of all boards using the [\/boards](#\/operations\/getBoards) endpoint.\n","operationId":"getWebhooks","parameters":[{"name":"board_ids","in":"query","description":"A list of board IDs to filter webhooks by. If not provided, returns webhooks for all boards.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2,3"}],"responses":{"200":{"description":"Successfully retrieved the list of webhooks.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of webhook objects.","type":"array","items":{"allOf":[{"type":"object","properties":{"webhook_id":{"description":"The ID of the webhook.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Webhook"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/WebhooksExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Webhooks"],"summary":"Create a webhook","description":"Creates a new webhook to receive notifications for board events.\n\nYou can see a list of all boards using the [\/boards](#\/operations\/getBoards) endpoint.\n","operationId":"createWebhook","requestBody":{"content":{"application\/json":{"schema":{"description":"The data to create a webhook.","required":["url"],"type":"object","properties":{"url":{"description":"The endpoint URL that will receive webhook notifications. Must be a valid HTTP or HTTPS address.","type":"string","minLength":1,"maxLength":65000},"is_enabled":{"description":"Indicates whether the webhook is enabled (`1`) or disabled (`0`). Disabled webhooks do not send notifications. Defaults to `1`.","format":"int32","type":"integer","enum":[0,1],"default":1},"board_id":{"description":"The unique identifier of the board for which the webhook will be triggered. If not set, the webhook will be invoked for events on all boards.","format":"int32","type":"integer","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/WebhookCreateRequestExample"}}}},"responses":{"200":{"description":"Successfully created the webhook.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"webhook_id":{"description":"The ID of the webhook.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Webhook"},{"type":"object","properties":{"secret":{"description":"The secret key used to sign webhook payloads. This key is only returned upon creation and should be securely stored by the client.","type":"string"}}}]}}},"example":{"$ref":"#\/components\/responseExamples\/WebhookCreateResponseExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/webhooks\/{webhook_id}":{"get":{"tags":["Webhooks"],"summary":"Get the details of a single webhook","description":"Retrieves the details of a specific webhook by its unique identifier.\n\nYou can see a list of all webhooks using the [\/webhooks](#\/operations\/getWebhooks) endpoint.\n","operationId":"getWebhook","responses":{"200":{"description":"Successfully retrieved the webhook details.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Webhook"}}},"example":{"$ref":"#\/components\/responseExamples\/WebhookExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Webhooks"],"summary":"Update a webhook","description":"Updates the configuration of an existing webhook.\nYou can change the webhook's URL, enabled status, or the board it is associated with.\nIf `board_id` is set to `null`, the webhook will receive events from all boards.\n\nRelated endpoints:\n- To see a list of all webhooks, use the [\/webhooks](#\/operations\/getWebhooks) endpoint.\n- To see a list of all boards, use the [\/boards](#\/operations\/getBoards) endpoint.\n","operationId":"updateWebhook","requestBody":{"content":{"application\/json":{"schema":{"description":"The data to update for the webhook.","type":"object","properties":{"url":{"description":"The endpoint URL for webhook notifications. Must be a valid HTTP or HTTPS address.","type":"string","minLength":1,"maxLength":65000},"is_enabled":{"description":"Indicates whether the webhook is enabled (`1`) or disabled (`0`). Disabled webhooks do not send notifications.","format":"int32","type":"integer","enum":[0,1]},"board_id":{"description":"The ID of the board for which the webhook will be triggered. If set to `null`, the webhook will be invoked for events on all boards.","format":"int32","type":"integer","nullable":true}}},"example":{"url":"https:\/\/example.com\/webhook1","is_enabled":1,"board_id":1}}}},"responses":{"200":{"description":"Successfully updated the webhook.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Webhook"}}},"example":{"$ref":"#\/components\/responseExamples\/WebhookExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Webhooks"],"summary":"Delete a webhook","description":"Deletes the specified webhook by its unique identifier.\nThis operation permanently removes the webhook and stops all future notifications to its URL.\n\nYou can see a list of all webhooks using the [\/webhooks](#\/operations\/getWebhooks) endpoint.\n","operationId":"deleteWebhook","responses":{"204":{"description":"The webhook has been successfully deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/webhookIdInPath"}]},"\/webhooks\/history":{"get":{"tags":["Webhook History"],"summary":"Get a list of webhooks creation, deletion and update events","description":"Retrieves a list of events related to webhooks.\nThis endpoint allows you to review the history of webhooks and can be tailored using various filtering options.\n","operationId":"getWebhooksHistory","parameters":[{"name":"webhook_ids","in":"query","description":"A list of webhook IDs used to filter the webhooks history to include only webhooks with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the webhooks history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the webhooks history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["created","updated","deleted"]}},"explode":false,"example":"created,updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of webhooks creation, deletion and update events.","type":"array","items":{"$ref":"#\/components\/schemas\/WebhookHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/WebhookHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/workspaces\/{workspace_id}\/managers":{"get":{"tags":["Workspace Managers"],"summary":"Get a list of workspace managers for the specified workspace","description":"Get a list of users who are workspace managers for the specified workspace. You can find a list of all workspaces by using the [workspaces endpoint](#\/operations\/getWorkspaces) and a list of all users by using the [users endpoint](#\/operations\/getUsers).","operationId":"getWorkspaceManagers","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of workspace managers.","type":"array","items":{"type":"object","title":"Workspace Manager","properties":{"manager_id":{"format":"int32","type":"integer","description":"The unique identifier of the user who is a workspace manager."}}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceManagersExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/workspaceIdInPath"}]},"\/workspaces\/{workspace_id}\/managers\/{user_id}":{"get":{"tags":["Workspace Managers"],"summary":"Check if the specified user is a workspace manager for a particular workspace","description":"Check if the specified user is a workspace manager for a particular workspace.","operationId":"checkWorkspaceManager","responses":{"204":{"description":"The user is a workspace manager for the specified workspace."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Workspace Managers"],"summary":"Assign a user as a workspace manager to the specified workspace","description":"Assign a user as a workspace manager to the specified workspace.","operationId":"addWorkspaceManager","responses":{"204":{"description":"The user is now a workspace manager."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Workspace Managers"],"summary":"Remove a user as a workspace manager from the specified workspace","description":"Remove a user as a workspace manager from the specified workspace.\r\n\r\n\r\n> ### Info\r\n>\r\n> This action only removes the user as a workspace manager from the workspace and does **not** delete the actual user.","operationId":"removeWorkspaceManager","responses":{"204":{"description":"The user is no longer a workspace manager."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/workspaceIdInPath"},{"$ref":"#\/components\/parameters\/userIdInPath"}]},"\/workspaces":{"get":{"tags":["Workspaces"],"summary":"Get a list of workspaces","description":"Retrieves a list of workspaces with their relevant details, optionally filtered using various parameters.\nThere are two types of workspaces:\n - **Team Workspace** - A collection of Team Kanban Boards where a team collaborates. Typical workspace names include 'Engineering', 'Marketing', 'Operations', 'Design', etc.\n - **Management Workspace** - Allows managers to connect one or more Team Kanban Boards to a single Management Board and manage work across multiple teams.","operationId":"getWorkspaces","parameters":[{"name":"workspace_ids","in":"query","description":"Filters results to include only workspaces with matching IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"type","in":"query","description":"Filters workspaces by their type.\n\nA value of `1` represents a **Team Workspace**, while a value of `2` represents a **Management Workspace**.","schema":{"format":"int32","type":"integer","enum":[1,2]}},{"name":"is_archived","in":"query","description":"Filters workspaces based on whether they are archived.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"if_workspace_manager","in":"query","description":"Filters workspaces based on whether the currently authenticated user is a workspace manager.","required":false,"schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"if_assigned_to_boards","in":"query","description":"Filters workspaces based on whether the currently authenticated user is assigned to any boards within the workspace.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"board_filter_is_archived","in":"query","description":"Filters boards based on their archived status, when the optional `expand` parameter includes `boards`.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"board_filter_if_assigned","in":"query","description":"Filters boards based on whether the currently authenticated user is assigned to any boards within the workspace, when the optional `expand` parameter includes `boards`.","schema":{"format":"int32","type":"integer","enum":[0,1]}},{"name":"fields","in":"query","description":"A list of fields to include in the response.","schema":{"items":{"type":"string","enum":["workspace_id","type","is_archived","name"]}},"explode":false,"example":"workspace_id,type"},{"name":"expand","in":"query","description":"Expand a list of the boards within each workspace. This filter can be used in combination with `board_filter_if_assigned` and `board_filter_is_archived` to filter the boards that are returned.","schema":{"items":{"type":"string","enum":["boards"]}},"example":"boards"}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of workspaces.","type":"array","items":{"allOf":[{"type":"object","properties":{"workspace_id":{"description":"The unique identifier of the workspace.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Workspace"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspacesExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Workspaces"],"summary":"Create a workspace","description":"Create a new workspace.","operationId":"createWorkspace","requestBody":{"content":{"application\/json":{"schema":{"description":"Workspace data.","required":["name"],"type":"object","properties":{"name":{"description":"The name of the workspace.","type":"string","minLength":1,"maxLength":100},"type":{"description":"The type of the workspace.\n\nA value of `1` represents a **Team Workspace**, while a value of `2` represents a **Management Workspace**.","format":"int32","type":"integer","enum":[1,2],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/WorkspaceRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"workspace_id":{"description":"The unique identifier of the workspace.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Workspace"}]}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceCreateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/workspaces\/{workspace_id}":{"get":{"tags":["Workspaces"],"summary":"Get the details of the specified workspace","description":"Get the details of the specified workspace.","operationId":"getWorkspace","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"title":"Workspace","description":"Workspace data.","type":"object","properties":{"is_archived":{"format":"int32","type":"integer","description":"Determines whether the workspace is archived.","enum":[0,1],"default":0},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the workspace."}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Workspaces"],"summary":"Update a workspace","description":"Update a workspace.","operationId":"updateWorkspace","requestBody":{"content":{"application\/json":{"schema":{"description":"Workspace data.","type":"object","properties":{"name":{"description":"The name of the workspace.","type":"string","minLength":1,"maxLength":100},"is_archived":{"description":"Determines whether the workspace is archived.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"example":{"$ref":"#\/components\/requestExamples\/WorkspaceUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Workspace"}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceUpdateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/workspaceIdInPath"}]},"\/workspaces\/history":{"get":{"tags":["Workspaces History"],"summary":"Get a list of workspace creation, deletion and update events","description":"Retrieves a list of events related to workspaces. This includes **boards** related to workspaces, as well as **workspace managers** and **dashboard page** associations.\n\nThis endpoint allows you to review the history of workspaces and can be tailored using various filtering options.\n","operationId":"getWorkspacesHistory","parameters":[{"name":"workspace_ids","in":"query","description":"A list of workspace IDs used to filter the workspaces history to include only workspaces with the specified IDs.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"1,2"},{"name":"user_ids","in":"query","description":"A list of user IDs used to filter the workspaces history to include only events performed by those users.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},{"name":"event_types","in":"query","description":"A list of event types used to filter the workspaces history to include only matching events.","required":false,"schema":{"items":{"type":"string","enum":["workspace_created","workspace_updated","workspace_archived","workspace_unarchived","board_created","board_renamed","board_deleted","board_archived","board_unarchived","board_moved_out","board_moved_in","wm_added","wm_removed","added_to_dashboard_page","removed_from_dashboard_page"]}},"explode":false,"example":"workspace_created,workspace_updated"},{"name":"from","in":"query","description":"The first date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},{"name":"to","in":"query","description":"The last date and time from which to retrieve results, in `YYYY-MM-DD HH:mm:ss` format.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},{"name":"from_date","in":"query","description":"The first date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},{"name":"to_date","in":"query","description":"The last date from which to retrieve results, in `YYYY-MM-DD` format.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},{"name":"page","in":"query","description":"Results are **always** paginated and returned in pages. This parameter controls which page is returned. Defaults to the **first** page if not specified.","required":false,"schema":{"format":"int32","type":"integer"}},{"name":"per_page","in":"query","description":"Controls how many results are returned per page. The default value is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200}}],"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"description":"A list of workspace management history events.","type":"array","items":{"$ref":"#\/components\/schemas\/WorkspaceHistoryEvent"}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceHistoryExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/workspaces\/dataFields\/showInDashboard":{"get":{"tags":["Workspace Data Fields with show in dashboard enabled"],"summary":"Get a list of data fields added to workspaces with show in dashboard functionality enabled","description":"This endpoint returns data fields that have the `show_in_dashboard` property set to 1, meaning they are configured to be displayed in the dashboard next to the workspace. It returns all workspace data fields if the user is owner or have admin privilege or only workspaces that the user is added as workspace manager.","operationId":"getWorkspaceDataFieldsWithShowInDashboard","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data fields with their values on the workspace.","type":"array","items":{"title":"Workspace data field data","type":"object","properties":{"data_field_id":{"format":"int32","type":"integer","description":"The ID of the data field."},"value":{"type":"string","description":"The value for data field on the workspace.","nullable":true},"baseline":{"type":"string","description":"The baseline for data field on the workspace.","nullable":true},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type `contributor`.","nullable":true}}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceDataFieldShowInDashboardExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}}},"\/workspaces\/{workspace_id}\/dataFields":{"get":{"tags":["Workspace Data Fields"],"summary":"Get a list of data fields available on a workspace","description":"Get a list of the data fields available on the specified workspace.","operationId":"getWorkspaceDataFields","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A list of data fields with their values on the workspace.","type":"array","items":{"title":"Workspace data field data","type":"object","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace."},"data_field_id":{"format":"int32","type":"integer","description":"The ID of the data field."},"value":{"type":"string","description":"The value for data field on the workspace.","nullable":true},"baseline":{"type":"string","description":"The baseline for data field on the workspace."},"show_in_dashboard":{"format":"int32","type":"integer","description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","enum":[0,1]},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type `contributor`.","nullable":true},"apply_to_all_boards_in_workspace":{"format":"int32","type":"integer","description":"Indicates whether the data field without value and baseline will be added to all boards in the workspace.","enum":[0,1],"default":0},"value_is_locked_for_all_boards":{"format":"int32","type":"integer","description":"Indicates whether the value is locked for all boards in the workspace.","enum":[0,1],"default":0}}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceDataFieldsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/workspaceIdInPath"}]},"\/workspaces\/{workspace_id}\/dataFields\/{data_field_id}":{"get":{"tags":["Workspace Data Fields"],"summary":"Get a data field's data on a workspace","description":"Get a data field's data on the specified workspace.","operationId":"getWorkspaceDataField","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A data field with its values on the workspace.","type":"object","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace."},"data_field_id":{"format":"int32","type":"integer","description":"The ID of the data field."},"value":{"type":"string","description":"The value for data field on the workspace.","nullable":true},"baseline":{"type":"string","description":"The baseline for data field on the workspace."},"show_in_dashboard":{"format":"int32","type":"integer","description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","enum":[0,1]},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user used if the data field is of type `contributor`.","nullable":true},"value_is_locked_for_all_boards":{"format":"int32","type":"integer","description":"Indicates whether the value is locked for all boards in the workspace.","enum":[0,1]},"apply_to_all_boards_in_workspace":{"format":"int32","type":"integer","description":"Indicates whether the data field without value and baseline will be added to all boards in the workspace.","enum":[0,1]}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceDataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"put":{"tags":["Workspace Data Fields"],"summary":"Add or update a data field to\/on a workspace","description":"Add or update a data field to\/on a workspace.","operationId":"addWorkspaceDataField","requestBody":{"content":{"application\/json":{"schema":{"description":"Add or update a data field to\/on workspace","type":"object","properties":{"value":{"type":"string","description":"The value to be set on workspace. If the value is null it will set empty value.","nullable":true},"baseline":{"type":"string","description":"The baseline to be set on workspace. If the baseline is null it will set empty baseline.","nullable":true},"show_in_dashboard":{"format":"int32","type":"integer","description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter specifies the ID of the value to be set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"The ID of an existing user, used when the data field is of type `contributor`.","nullable":true}}},"example":{"$ref":"#\/components\/requestExamples\/WorkspaceDataFieldAddOrUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"A data field with its values on the board.","type":"object","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace."},"value":{"type":"string","description":"The value for data field on the board.","nullable":true},"baseline":{"type":"string","nullable":true,"format":"int32","description":"The baseline for data field on the workspace."},"show_in_dashboard":{"format":"int32","type":"integer","description":"Indicates whether the data field value and baseline will be shown in dashboard next to the workspace. This works only for `number`, `date` or `calculated number` data fields.","enum":[0,1],"default":0},"dropdown_value_id":{"format":"int32","type":"integer","description":"If the data field is a `dropdown`, this parameter will be added to data and specify the ID of the value set.","nullable":true},"contributor_user_id":{"format":"int32","type":"integer","description":"If the data field is a `contributor`, this parameter will be added to data and specify the ID of the user set.","nullable":true}}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkspaceDataFieldExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Workspace Data Fields"],"summary":"Remove a data field from a workspace","description":"Remove a data field from a workspace.","operationId":"removeWorkspaceDataField","responses":{"204":{"description":"The data field is no longer available on the workspace."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/workspaceIdInPath"},{"$ref":"#\/components\/parameters\/dataFieldIdInPath"}]},"\/boards\/{board_id}\/workflows\/{workflow_id}\/cycleTimeColumns":{"get":{"tags":["Workflow Cycle Time Columns"],"summary":"Get workflow's cycle time columns","description":"Get the list of columns in a workflow that are configured to be included in the cycle time calculation for cards.\nCycle time is the total time a card spends in the selected columns, helping you measure process efficiency and identify bottlenecks.\nYou can configure which columns are counted towards cycle time for each workflow.\n\nRelated endpoints:\n- List boards: [Get Boards](#operations\/getBoards#Request)\n- List workflows for a specifed board: [Get Workflows](#operations\/getWorkflows#Request)\n- Get workflow's effective cycle time columns: [Get Workflow Effective Cycle Time Columns](#operations\/getWorkflowEffectiveCycleTimeColumns#Request)\n","operationId":"getWorkflowCycleTimeColumns","responses":{"200":{"description":"Successfully retrieved the workflow's cycle time columns.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of columns in the workflow that are included in cycle time calculations.","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowCycleTimeColumn"}}}},"example":{"data":[{"column_id":121,"name":"Requested"},{"column_id":122,"name":"In Progress"},{"column_id":125,"name":"New Column"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/workflowIdInPath"}]},"\/boards\/{board_id}\/workflows\/{workflow_id}\/effectiveCycleTimeColumns":{"get":{"tags":["Workflow Cycle Time Columns"],"summary":"Get workflow's effective cycle time columns","description":"Retrieves the list of columns in a workflow that are currently included in the effective cycle time calculation for cards.\nEffective cycle time columns reflect the actual columns used for measuring cycle time, based on the current board and workflow configuration.\nIf no columns are added to the cycle time configuration, all columns are included by default to the effective cycle time.\nUse this endpoint to see which columns are actively counted towards cycle time for more accurate analytics.\n\nRelated endpoints:\n- List boards: [Get Boards](#operations\/getBoards#Request)\n- List workflows for a specifed board: [Get Workflows](#operations\/getWorkflows#Request)\n- Get workflow's cycle time columns: [Get Workflow Cycle Time Columns](#operations\/getWorkflowCycleTimeColumns#Request)\n","operationId":"getWorkflowEffectiveCycleTimeColumns","responses":{"200":{"description":"Successfully retrieved the workflow's effective cycle time columns.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"description":"An array of columns in the workflow that are currently included in effective cycle time calculations.","type":"array","items":{"$ref":"#\/components\/schemas\/WorkflowCycleTimeColumn"}}}},"example":{"data":[{"column_id":120,"name":"Backlog"},{"column_id":121,"name":"Requested"},{"column_id":122,"name":"In Progress"},{"column_id":123,"name":"Done"},{"column_id":124,"name":"Ready to Archive"},{"column_id":125,"name":"New Column"}]}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/workflowIdInPath"}]},"\/boards\/{board_id}\/workflows":{"get":{"tags":["Workflows"],"summary":"Get a list of workflows for the specified board","description":"Retrieves a list of workflows for the specified board with their relevant details.\nThere are three types of workflows:\n - **Cards Workflow** - The Cards Workflow represents the team process. This is the place where all tasks are visualized as Kanban cards. In the Cards workflow, you can create new cards that are either independent or linked to an Initiative.\n - **Initiatives Workflow** - The Initiatives Workflow is the place where you can create Initiatives and track their automated progress. An initiative is a bigger task, epic, or a project, which you have to break down into smaller work items (cards).\n - **Timeline Workflow** - The Timeline Workflow allows you to visualize your Initiatives in a linear calendar view. The Initiative shows duration, progress and project delay.\n\n**All boards** have 1 cards and 1 initiatives workflow **by default**.\n\nYou can find a list of all boards by using the [boards endpoint](#operations\/getBoards#Request).","operationId":"getWorkflows","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"type":"array","items":{"allOf":[{"type":"object","properties":{"workflow_id":{"description":"The unique identifier of the workflow.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Workflow"}]}}}},"example":{"$ref":"#\/components\/responseExamples\/WorkflowsExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"post":{"tags":["Workflows"],"summary":"Create workflow","description":"Create a new workflow.","operationId":"createWorkflow","requestBody":{"content":{"application\/json":{"schema":{"description":"Workflow data.","required":["type"],"type":"object","properties":{"position":{"description":"The position of the workflow. A value of `0` indicates the topmost workflow.","format":"int32","type":"integer","default":0},"is_enabled":{"description":"Determines whether the workflow is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1},"is_collapsible":{"description":"Indicates if the workflow is collapsible. **All** workflows are collapsible by default.","format":"int32","type":"integer","enum":[0,1],"default":1},"name":{"description":"The name of the new workflow. If not provided, a default name will be assigned based on the workflow type.","type":"string","minLength":1,"maxLength":100},"type":{"description":"The type of the workflow.\n\nA value of `0` represents a **Cards workflow**, a value of `1` represents an **Initiative Workflow** and a value of `2` represents a **Timeline Workflow**.","format":"int32","type":"integer","enum":[0,1,2]}}},"example":{"$ref":"#\/components\/requestExamples\/WorkflowCreateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"allOf":[{"type":"object","properties":{"workflow_id":{"description":"The unique identifier of the workflow.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/Workflow"}]}}},"example":{"$ref":"#\/components\/responseExamples\/WorkflowCreateExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"}]},"\/boards\/{board_id}\/workflows\/{workflow_id}":{"get":{"tags":["Workflows"],"summary":"Get the details of a workflow for the specified board","description":"Get the details of a workflow for the specified board.","operationId":"getWorkflow","responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Workflow"}}},"example":{"$ref":"#\/components\/responseExamples\/WorkflowExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"patch":{"tags":["Workflows"],"summary":"Update a workflow for the specified board","description":"Update a workflow for the specified board.","operationId":"updateWorkflow","requestBody":{"content":{"application\/json":{"schema":{"description":"Workflow data.","type":"object","properties":{"position":{"description":"The position of the workflow. A value of `0` indicates the topmost workflow.","format":"int32","type":"integer","default":0},"is_enabled":{"description":"Determines whether the workflow is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1},"is_collapsible":{"description":"Indicates if the workflow is collapsible. **All** workflows are collapsible by default.","format":"int32","type":"integer","enum":[0,1],"default":1},"name":{"description":"The name of the new workflow. If not provided, a default name will be assigned based on the workflow type.","type":"string","minLength":1,"maxLength":100}}},"example":{"$ref":"#\/components\/requestExamples\/WorkflowUpdateRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/Workflow"}}},"example":{"$ref":"#\/components\/responseExamples\/WorkflowExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"delete":{"tags":["Workflows"],"summary":"Delete a workflow for the specified board","description":"Delete a workflow for the specified board.\r\n\r\n\r\n> ### Warning\r\n>\r\n> A workflow that contains cards **cannot** be deleted.\r\n","operationId":"workflowDelete","responses":{"204":{"description":"The workflow has been deleted."},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/workflowIdInPath"}]},"\/boards\/{board_id}\/workflows\/{workflow_id}\/copy":{"post":{"tags":["Workflows"],"summary":"Copy an existing workflow from the specified board","description":"Copy an existing workflow from the specified board.","operationId":"copyWorkflow","requestBody":{"content":{"application\/json":{"schema":{"description":"Workflow data.","required":["to_board_id"],"type":"object","properties":{"name":{"description":"The name of the copied workflow. If not provided, the name of the original workflow will be used.","type":"string","minLength":1,"maxLength":100},"to_board_id":{"description":"The unique identifier of the board to which the workflow will be copied.","format":"int32","type":"integer"},"copy_service_level_expectations":{"description":"Determines whether to copy service level expectations (SLEs).","format":"int32","type":"integer","enum":[0,1],"default":1},"copy_column_checklist_items":{"description":"Determines whether to copy exit criteria.","format":"int32","type":"integer","enum":[0,1],"default":1},"copy_arrival_rules":{"description":"Determines whether to copy arrival rules.","format":"int32","type":"integer","enum":[0,1],"default":1},"copy_departure_rules":{"description":"Determines whether to copy departure rules.","format":"int32","type":"integer","enum":[0,1],"default":1},"copy_default_templates":{"description":"Determines whether to copy workflow and lane default templates.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"example":{"$ref":"#\/components\/requestExamples\/WorkflowCopyRequestExample"}}}},"responses":{"200":{"description":"A successful response.","content":{"application\/json":{"schema":{"description":"A wrapper for a successful response.","type":"object","properties":{"data":{"$ref":"#\/components\/schemas\/WorkflowCopy"}}},"example":{"$ref":"#\/components\/responseExamples\/WorkflowCopyExample"}}}},"400":{"$ref":"#\/components\/responses\/ResponseBadRequest"},"401":{"$ref":"#\/components\/responses\/ResponseUnauthorized"},"403":{"$ref":"#\/components\/responses\/ResponseForbidden"},"404":{"$ref":"#\/components\/responses\/ResponseNotFound"},"409":{"$ref":"#\/components\/responses\/ResponseConflict"},"429":{"$ref":"#\/components\/responses\/ResponseTooManyRequests"},"500":{"$ref":"#\/components\/responses\/ResponseInternalServerError"},"503":{"$ref":"#\/components\/responses\/ResponseServiceUnavailable"}}},"parameters":[{"$ref":"#\/components\/parameters\/boardIdInPath"},{"$ref":"#\/components\/parameters\/workflowIdInPath"}]},"\/openSearch\/cards":{"post":{"tags":["Search for Cards"],"summary":"Search for Cards with OpenSearch","description":"Run advanced card searches backed by OpenSearch. Submit an OpenSearch Query DSL payload in the request body. Use standard OpenSearch parameters like `_source`, `size`, `from`, `sort`, and `query` within the JSON body for full control over search behavior.\n\nFor field definitions and end-to-end query examples, see the [OpenSearch Cards Index Documentation \u2197](https:\/\/demo.kanbanize.com\/openSearchCards).","operationId":"postOpenSearch","parameters":[{"name":"Include-Cards-From-Archived-Boards","in":"header","description":"Include cards from archived boards in search results (0 or 1)","required":false,"schema":{"type":"integer","enum":[0,1],"default":0}},{"name":"With-Names-And-Labels","in":"header","description":"Enrich response with human-readable names and labels (0 or 1)","required":false,"schema":{"type":"integer","enum":[0,1],"default":0}}],"requestBody":{"description":"OpenSearch Query DSL payload","required":false,"content":{"application\/json":{"schema":{"type":"object","description":"OpenSearch Query DSL structure"},"examples":{"Simple Text Search":{"summary":"Simple text search in card titles","value":{"query":{"match":{"title":"authentication"}}}},"Advanced Search with Filters":{"summary":"Complex search with multiple conditions and sorting","value":{"query":{"bool":{"must":[{"match":{"title":"bug"}},{"term":{"priority_name":"high"}}],"filter":[{"range":{"created_at":{"gte":"2024-01-01","lte":"2024-12-31"}}}]}},"sort":[{"created_at":{"order":"desc"}}],"size":20,"from":0}},"Statistics and Analytics":{"summary":"Get card statistics grouped by priority and board","value":{"query":{"match_all":{}},"aggs":{"cards_by_priority":{"terms":{"field":"priority_name"}}},"size":0}}}}}},"responses":{"200":{"description":"OpenSearch results","content":{"application\/json":{"schema":{"type":"object","properties":{"took":{"type":"integer","description":"Time in milliseconds it took to execute the search"},"timed_out":{"type":"boolean","description":"Whether the search timed out"},"hits":{"type":"object","properties":{"total":{"type":"object","properties":{"value":{"type":"integer"},"relation":{"type":"string"}}},"max_score":{"type":"number"},"hits":{"type":"array","items":{"type":"object","description":"Individual search result with card data and OpenSearch metadata"}}}}}},"examples":{"search_results":{"summary":"Successful search with card results","value":{"took":15,"timed_out":false,"_shards":{"total":3,"successful":3,"skipped":0,"failed":0},"hits":{"total":{"value":2,"relation":"eq"},"max_score":1.5,"hits":[{"_index":"cards","_type":"_doc","_id":"12345","_score":1.5,"_source":{"company_id":123,"card_id":12345,"custom_id":"PROJ-001","title":"Implement new feature","description":"Add user authentication to the application","board_id":456,"workflow_id":789,"section":1,"column_id":101,"lane_id":201,"position":1,"owner_user_id":301,"type_id":401,"color":"ff5722","size":8,"priority":2,"priority_name":"High","deadline":"2025-01-15 17:00:00","created_at":"2024-12-01 10:30:00","last_modified":"2024-12-05 14:22:00","is_archived":false,"is_discarded":false,"is_blocked":false,"sticker_count":2,"tag_count":3,"subtask_count":5,"finished_subtask_count":2,"unfinished_subtask_count":3,"comment_count":8,"attachment_count":2,"custom_fields":[{"field_id":501,"value":"Backend","is_visible":true}],"subtasks":[{"subtask_id":601,"description":"Design login form","is_finished":true,"finished_at":"2024-12-03 16:00:00"},{"subtask_id":602,"description":"Implement authentication API","is_finished":false,"deadline":"2024-12-10 17:00:00"}]}}]}}}}}}},"400":{"description":"Bad Request - Invalid search query or proxy\/OpenSearch error","content":{"application\/json":{"schema":{"type":"object","properties":{"source":{"type":"string","enum":["proxy","opensearch"],"description":"Source of the error"},"type":{"type":"string","description":"Error type - HTTP status code or 'invalid_json'"},"response":{"type":"string","description":"Raw error response from the source"}}}}}},"401":{"description":"Unauthorized"},"500":{"description":"Internal Server Error"}},"security":[{"apikey":[]}]}}},"components":{"parameters":{"attributeIdInPath":{"name":"attribute_id","in":"path","description":"An attribute ID.","required":true,"schema":{"format":"int32","type":"integer"}},"workspaceIdInPath":{"name":"workspace_id","in":"path","description":"A workspace ID.","required":true,"schema":{"format":"int32","type":"integer"}},"boardIdInPath":{"name":"board_id","in":"path","description":"A board ID.","required":true,"schema":{"format":"int32","type":"integer"}},"versionIdInPath":{"name":"version_id","in":"path","description":"An archived card version ID.","required":true,"schema":{"format":"int32","type":"integer"}},"dashboardPageIdInPath":{"name":"dashboard_page_id","in":"path","description":"A dashboard page ID.","required":true,"schema":{"format":"int32","type":"integer"}},"widgetIdInPath":{"name":"widget_id","in":"path","description":"A widget ID.","required":true,"schema":{"format":"int32","type":"integer"}},"revisionInPath":{"name":"revision","in":"path","description":"A revision number.","required":true,"schema":{"format":"int32","type":"integer"}},"laneIdInPath":{"name":"lane_id","in":"path","description":"A lane ID.","required":true,"schema":{"format":"int32","type":"integer"}},"columnIdInPath":{"name":"column_id","in":"path","description":"A column ID.","required":true,"schema":{"format":"int32","type":"integer"}},"areaIdInPath":{"name":"area_id","in":"path","description":"An area ID.","required":true,"schema":{"format":"int32","type":"integer"}},"checklistItemIdInPath":{"name":"item_id","in":"path","description":"A checklist item ID.","required":true,"schema":{"format":"int32","type":"integer"}},"userIdInPath":{"name":"user_id","in":"path","description":"A user ID.","required":true,"schema":{"format":"int32","type":"integer"}},"roleIdInPath":{"name":"role_id","in":"path","description":"A role ID.","required":true,"schema":{"format":"int32","type":"integer"}},"blockReasonIdInPath":{"name":"reason_id","in":"path","description":"A block reason ID.","required":true,"schema":{"format":"int32","type":"integer"}},"discardReasonIdInPath":{"name":"reason_id","in":"path","description":"A discard reason ID.","required":true,"schema":{"format":"int32","type":"integer"}},"stickerIdInPath":{"name":"sticker_id","in":"path","description":"A sticker ID.","required":true,"schema":{"format":"int32","type":"integer"}},"typeIdInPath":{"name":"type_id","in":"path","description":"A type ID.","required":true,"schema":{"format":"int32","type":"integer"}},"templateIdInPath":{"name":"template_id","in":"path","description":"A template ID.","required":true,"schema":{"format":"int32","type":"integer"}},"cardIdInPath":{"name":"card_id","in":"path","description":"A card ID.","required":true,"schema":{"format":"int32","type":"integer"}},"commentIdInPath":{"name":"comment_id","in":"path","description":"A comment ID.","required":true,"schema":{"format":"int32","type":"integer"}},"outcomeIdInPath":{"name":"outcome_id","in":"path","description":"An outcome ID.","required":true,"schema":{"format":"int32","type":"integer"}},"checkpointIdInPath":{"name":"checkpoint_id","in":"path","description":"A checkpoint ID.","required":true,"schema":{"format":"int32","type":"integer"}},"outcomeValueIdInPath":{"name":"value_id","in":"path","description":"An outcome value ID.","required":true,"schema":{"format":"int32","type":"integer"}},"subtaskIdInPath":{"name":"subtask_id","in":"path","description":"A subtask ID.","required":true,"schema":{"format":"int32","type":"integer"}},"attachmentIdInPath":{"name":"attachment_id","in":"path","description":"An attachment ID.","required":true,"schema":{"format":"int32","type":"integer"}},"selectedCardIdInPath":{"name":"selected_card_id","in":"path","description":"A selected card ID.","required":true,"schema":{"format":"int32","type":"integer"}},"tagIdInPath":{"name":"tag_id","in":"path","description":"A tag ID.","required":true,"schema":{"format":"int32","type":"integer"}},"outcomeTagIdInPath":{"name":"id","in":"path","description":"An outcome tag ID.","required":true,"schema":{"format":"int32","type":"integer"}},"outcomesIdInPath":{"name":"id","in":"path","description":"An outcome ID.","required":true,"schema":{"format":"int32","type":"integer"}},"milestoneIdInPath":{"name":"milestone_id","in":"path","description":"A milestone ID.","required":true,"schema":{"format":"int32","type":"integer"}},"loggedTimeIdInPath":{"name":"logged_time_id","in":"path","description":"A logged time ID.","required":true,"schema":{"format":"int32","type":"integer"}},"fieldIdInPath":{"name":"field_id","in":"path","description":"A custom field ID.","required":true,"schema":{"format":"int32","type":"integer"}},"fileIdInPath":{"name":"file_id","in":"path","description":"A file ID.","required":true,"schema":{"format":"int32","type":"integer"}},"dataFieldIdInPath":{"name":"data_field_id","in":"path","description":"A data field ID.","required":true,"schema":{"format":"int32","type":"integer"}},"valueIdInPath":{"name":"value_id","in":"path","description":"A value ID.","required":true,"schema":{"format":"int32","type":"integer"}},"webhookIdInPath":{"name":"webhook_id","in":"path","description":"A webhook ID.","required":true,"schema":{"format":"int32","type":"integer"}},"fieldName":{"name":"field_name","in":"path","description":"A field name.","required":true,"schema":{"type":"string"}},"settingName":{"name":"setting_name","in":"path","description":"A setting name.","required":true,"schema":{"type":"string"}},"permissionName":{"name":"permission_name","in":"path","description":"A permission name.","required":true,"schema":{"type":"string"}},"privilegeName":{"name":"privilege_name","in":"path","description":"A privilege name.","required":true,"schema":{"type":"string","enum":["owner","create_team_workspaces","make_payments","manage_business_rules","manage_integrations","invite_users","manage_teams","manage_user_wip_limits","manage_roles","manage_card_elements","manage_security_settings","manage_dashboards","manage_logged_time","manage_worklog_configurations","access_audit_logs","enable_and_disable_users","delete_users","manage_outcome_rules","manage_data_fields"]}},"featureIdInPath":{"name":"feature_id","in":"path","description":"A feature ID.","required":true,"schema":{"format":"int32","type":"integer"}},"planIdInPath":{"name":"plan_id","in":"path","description":"A plan ID.","required":true,"schema":{"format":"int32","type":"integer"}},"workflowIdInPath":{"name":"workflow_id","in":"path","description":"A workflow ID.","required":true,"schema":{"format":"int32","type":"integer"}},"teamIdInPath":{"name":"team_id","in":"path","description":"A team ID.","required":true,"schema":{"format":"int32","type":"integer"}},"categoryIdInPath":{"name":"category_id","in":"path","description":"A logged time category ID.","required":true,"schema":{"format":"int32","type":"integer"}},"viewIdInPath":{"name":"view_id","in":"path","description":"A view ID.","required":true,"schema":{"format":"int32","type":"integer","enum":[1,2,3,4]}},"ruleIdInPath":{"name":"rule_id","in":"path","description":"A rule ID.","required":true,"schema":{"format":"int32","type":"integer"}},"announcementIdInPath":{"name":"announcement_id","in":"path","description":"An announcement ID.","required":true,"schema":{"format":"int32","type":"integer"}},"promptIdInPath":{"name":"prompt_id","in":"path","description":"A prompt ID.","required":true,"schema":{"format":"int32","type":"integer"}},"exportFormat":{"name":"format","in":"query","description":"The export file format. Allowed values are `xml`, `excel`, `csv`, and `json`. Defaults to `json` if not specified.","required":false,"schema":{"type":"string","default":"json"},"explode":false,"example":"json"},"exportUserIds":{"name":"user_ids","in":"query","description":"A list of user IDs who performed the actions. Only events triggered by these users will be included.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"},"exportFrom":{"name":"from","in":"query","description":"The start date and time for filtering results, in `YYYY-MM-DD HH:mm:ss` format. Only events occurring on or after this date and time will be included.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-01-01 00:00:00"},"exportTo":{"name":"to","in":"query","description":"The end date and time for filtering results, in `YYYY-MM-DD HH:mm:ss` format. Only events occurring on or before this date and time will be included.","required":false,"schema":{"format":"date-time","type":"string"},"example":"2025-12-31 00:00:00"},"exportFromDate":{"name":"from_date","in":"query","description":"The start date for filtering results, in `YYYY-MM-DD` format. Only events occurring on or after this date will be included.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-01-01"},"exportToDate":{"name":"to_date","in":"query","description":"The end date for filtering results, in `YYYY-MM-DD` format. Only events occurring on or before this date will be included.","required":false,"schema":{"format":"date","type":"string"},"example":"2025-12-31"},"exportPage":{"name":"page","in":"query","description":"The page number of results to return. Results are always paginated. Defaults to the first page if not specified.","required":false,"schema":{"format":"int32","type":"integer"},"example":1},"exportPerPage":{"name":"per_page","in":"query","description":"The number of results to return per page. The default is `100` and the maximum is `200`.","required":false,"schema":{"format":"int","type":"integer","default":100,"maximum":200},"example":100},"exportWorkspaceIds":{"name":"workspace_ids","in":"query","description":"A list of workspace IDs to filter the history events. Only events related to these workspaces will be included.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},"exportBoardIds":{"name":"board_ids","in":"query","description":"A list of board IDs to filter the export by.\nOnly history events for these boards will be included.\n","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"10,11"},"exportAffectedUserIds":{"name":"affected_user_ids","in":"query","description":"A list of user IDs whose actions are included in the history events. Only events where these users were affected will be included.","required":false,"schema":{"items":{"format":"int32","type":"integer"}},"explode":false,"example":"2,3"}},"responses":{"ResponseBadRequest":{"description":"The request failed due to a client error.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseBadRequestExample"}}}},"ResponseUnauthorized":{"description":"You are not authorized to access the API.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseUnauthorizedExample"}}}},"ResponseForbidden":{"description":"You do not have the permissions required to access this resource or to perform this action.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseForbiddenExample"}}}},"ResponseNotFound":{"description":"This resource does not exist at the moment.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseNotFoundExample"}}}},"ResponseConflict":{"description":"The request could not be completed due to a conflict with the current state of the resource.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseConflictExample"}}}},"ResponseTooManyRequests":{"description":"This request will not be processed because you have sent too many requests recently.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ErrorResponse"},"example":{"$ref":"#\/components\/responseExamples\/ResponseTooManyRequestsExample"}}}},"ResponseInternalServerError":{"description":"The request failed due to an internal server error."},"ResponseServiceUnavailable":{"description":"The service is temporarily unavailable."}},"schemas":{"ErrorResponse":{"description":"The response of the API when there is a client error.","required":["error"],"type":"object","properties":{"error":{"description":"Information about a client error.","required":["reference","code","message"],"type":"object","properties":{"code":{"description":"A unique 4-character code associated with the error.","type":"string"},"message":{"description":"A description of the error.","type":"string"},"reference":{"description":"A reference that you can use if you need to contact customer support about the error.","type":"string"},"details":{"description":"Details specific to the error. Such as the values that caused it.","type":"object","additionalProperties":{"type":"string"}}}}}},"BoardAccessRequest":{"title":"Board access request","description":"Board access request data.","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board for which access is requested."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who is requesting access to the board."},"comment":{"type":"string","description":"An optional comment provided by the user requesting access, explaining why they need access to the board."},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the access request was submitted, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"Workspace":{"title":"Workspace","description":"Workspace data.","type":"object","properties":{"type":{"format":"int32","type":"integer","description":"The type of the workspace.\n\nA value of `1` represents a **Team Workspace**, while a value of `2` represents a **Management Workspace**.","enum":[1,2],"default":1},"is_archived":{"format":"int32","type":"integer","description":"Determines whether the workspace is archived.","enum":[0,1],"default":0},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the workspace."}}},"WorkspaceHistoryEvent":{"title":"Workspace history event","description":"An event recorded whenever a create, update, or delete action is performed for a workspace. This can include boards, dashboards or workspace managers associated with the workspace.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a workspace."},"workspace_id":{"format":"int32","type":"integer","description":"The unique identifier of the workspace."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","archived","unarchived","board_created","board_renamed","board_deleted","board_unarchived","board_moved_out","board_moved_in","wm_added","wm_removed","added_to_dashboard_page","removed_from_dashboard_page"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the workspace."},"details":{"type":"object","description":"Contains detailed information about the workspace associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `archived`, `unarchived`, `board_renamed`, `board_archived`, `board_unarchived`. Only the `details` object is included for **all** other event types.","properties":{"previous_state":{"type":"object","description":"Contains the state of the workspace before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the workspace."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"Board":{"title":"Board","description":"Board data.","type":"object","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace to which the board belongs."},"is_archived":{"format":"int32","type":"integer","description":"Controls whether the board is archived.","enum":[0,1]},"name":{"description":"The name of the board.","type":"string","minLength":1,"maxLength":100},"description":{"description":"The description of the board.","type":"string"},"type":{"format":"int32","type":"integer","description":"The type of the board. A value of `1` indicates a **Kanban board**, while a value of `2` indicates an **AI Canvas**.","enum":[1,2],"default":1},"revision":{"format":"int32","type":"integer","description":"The revision number of the board. It denotes the number of times edits were made to the board structure. A single revision can include multiple edits, if they were done at the same time."}}},"BoardSettings":{"title":"Board settings","description":"Board settings.","type":"object","properties":{"size_type":{"description":"Controls how the card sizes are entered and displayed. If set to 0, the card size is an input field, which allows any numeric value. If set to 1, the card size is a dropdown list with T-shirt sizes like S, M, L, XL, etc. If set to 2, the card size is a dropdown list with the Fibonacci numbers.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"allow_exceeding":{"description":"Controls whether exceeding the WIP limits on the board is allowed. If set to 0, the limits can always be exceeded. If set to 1, the limits can be exceeded only with an explanation. If set to 2, the limits cannot be exceeded.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"autoarchive_cards_after":{"description":"Controls number of days before automatically moving all cards from Ready to Archive to Permanent Archive.","format":"int32","type":"integer","enum":[7,14,30],"default":7},"limit_type":{"description":"Controls the measurement unit for work limits on the board. When limit type is 0, the board limits are calculated based on cards count. When limit type is 1, the board limits are calculated based on the size of the cards, cards without set size are counted as 1.","format":"int32","type":"integer","enum":[0,1],"default":0},"allow_repeating_custom_card_ids":{"description":"Controls whether repeating custom card ids are allowed on the board. When the value is 0, the custom ids of the cards have to be unique on the board. When the value is 1 repeating custom card ids are allowed.","format":"int32","type":"integer","enum":[0,1],"default":1},"is_discard_reason_required":{"description":"Controls whether providing a discard reason is required when discarding a card.","format":"int32","type":"integer","enum":[0,1],"default":0},"size_formula":{"description":"The formula for calculating card size. It can be set as a **Board level policy**.","type":"string","nullable":true,"example":"average(1,2)","default":null},"deadline_formula":{"description":"The formula for calculating card deadlines. It can be set as a **Board level policy**.","type":"string","nullable":true,"example":"end_of_day(card.created_at())","default":null},"default_sender_user_id":{"description":"The user ID of the default email sender of the board.\n\nThe default sender user ID can be set to the default notifications email adddress `{url}_notifications@businessmap.io` for your account. In this case the user ID will be 10-digits long and won't be visible in the `\/users` endpoint","format":"int32","type":"integer","nullable":true,"default":null},"default_receiver_user_id":{"description":"The user ID of the default email receiver of the board.\n\nThe default receiver used ID can be set to the **Reporter** or **Owner** of each card on the board. In this case the user ID will be 10-digits long and won't be visible in the `\/users` endpoint.","format":"int32","type":"integer","nullable":true,"default":null},"allowe_generic_blocker":{"description":"Indicates if generic blockers are allowed. If disabled, only specific blockers can be used.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"BoardWorkflowAndLaneDefaultSettings":{"title":"Default settings","description":"Default settings data.","type":"object","properties":{"name":{"type":"string","description":"The name of the setting."},"type":{"type":"string","description":"The data type of the setting's value.","enum":["int","string","url","color"]},"restrictions":{"type":"object","description":"The restrictions of the setting's value.","properties":{"min":{"type":"integer","format":"int32","description":"The minimum value of the setting.","default":1},"max":{"type":"integer","format":"int32","description":"The maximum value of the setting.","default":1000000000}}},"multiple_values":{"type":"boolean","description":"Indicates whether the setting can have multiple values."},"default_value":{"format":"int32","type":"integer","description":"The default value of the setting.","default":null,"nullable":true},"value":{"format":"int32","type":"integer","description":"The current value of the setting.","default":null,"nullable":true}}},"BoardRule":{"title":"Board rule","description":"Board rule data.","type":"object","properties":{"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of the rule."},"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1],"default":1},"workflow_id":{"description":"The ID of the workflow to which the rule applies.","format":"int32","type":"integer","nullable":true},"lane_id":{"description":"The ID of the lane to which the rule applies.","format":"int32","type":"integer","nullable":true},"column_id":{"description":"The ID of the column to which the rule applies.","format":"int32","type":"integer","nullable":true},"area_id":{"description":"The ID of the merged area to which the rule applies.","format":"int32","type":"integer","nullable":true},"conditions":{"type":"array","description":"Contains the conditions that the rule applies.\n\nAn example of a condition is: **Attachments are present**, which requires all cards to have at least one attachment before moving to the specified workflow, lane, column, or area.","items":{"title":"Rule Condition","type":"object","properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`."},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule, e.g. `=` or `!=`."},"ignore_if_not_present":{"type":"integer","format":"int32","description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","enum":[0,1],"default":0},"values":{"type":"array","items":{"description":"The values of the field added as a condition to the rule.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}},"nested_conditions":{"type":"array","description":"Contains nested conditions. Applicable for conditions of type `Parent cards`, `Child cards` and `Relative cards` with the operators `all_match`, `some_match`, `some_do_not_match`, `none_match` and `none_match_or_exist`.","items":{"type":"object"}}}}}}},"BoardArrivalRuleCreateRequest":{"description":"Board arrival rule create request.","type":"object","required":["conditions"],"properties":{"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1]},"workflow_id":{"description":"The ID of the workflow to which the rule applies.","format":"int32","type":"integer"},"lane_id":{"description":"The ID of the lane to which the rule applies.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column to which the rule applies. **Cannot** be used in combination with `area_id`.","format":"int32","type":"integer"},"area_id":{"description":"The ID of the merged area to which the rule applies. **Cannot** be used in combination with `column_id`.","format":"int32","type":"integer"},"conditions":{"type":"array","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleFromBoardCondition"},{"$ref":"#\/components\/schemas\/RuleFromWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleFromColumnCondition"},{"$ref":"#\/components\/schemas\/RuleFromLaneCondition"},{"$ref":"#\/components\/schemas\/RuleFromSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"BoardArrivalRuleUpdateRequest":{"description":"Board arrival rule update request.","type":"object","properties":{"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1]},"conditions":{"type":"array","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleFromBoardCondition"},{"$ref":"#\/components\/schemas\/RuleFromWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleFromColumnCondition"},{"$ref":"#\/components\/schemas\/RuleFromLaneCondition"},{"$ref":"#\/components\/schemas\/RuleFromSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"BoardBaiPrompt":{"title":"Board BAI prompt","description":"Board BAI prompt data.","type":"object","properties":{"prompt_id":{"format":"int32","type":"integer","description":"The unique identifier of a BAI prompt."},"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board where the BAI prompt is used."},"type":{"description":"The type of the BAI prompt. **Comments and Emails**, **Subtasks** and **Summaries** prompts correspond respectively to the values `1`, `2` and `3`.","format":"int32","type":"integer","enum":[1,2,3]},"color":{"type":"string","description":"The color of the BAI prompt in hexadecimal format.","default":""},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the BAI prompt. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the BAI prompt.","default":0},"name":{"type":"string","description":"The **unique** name assigned to the BAI prompt.","minLength":1,"maxLength":250},"context":{"type":"string","description":"Describes the general situation in which the AI assistant will operate.","minLength":1,"maxLength":65000},"topics":{"type":"string","description":"Contains a list of additional important topics to include in the generated content. This is available **only** for **Comments and Emails** and **Subtasks** BAI prompts.","maxLength":65000},"suggest_missing_topics":{"format":"int32","type":"integer","description":"Indicates whether the AI model can suggesttopics that may be missing from the generated content.","enum":[0,1]},"fields":{"type":"array","description":"An array of objects that specifies the **card properties** (e.g, Title, Description, Subtasks) to be sent to the AI model for analysis.\n\nThe **order** of the objects reflects the **priority**, with the most important properties listed first.\n\nEach object defines a specific field type and name.","items":{"type":"object","properties":{"field_type":{"type":"string","description":"Determines the type of field being sent for analysis to the AI model. Default fields like **Title**, **Description**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain","custom"]},"field_name":{"type":"string","description":"For fields of type `plain`, the name is stated explicitly (e.g., **Title**, **Description**). For fields of type `custom`, the field is represented by the [ID of the custom field](#\/operations\/getCustomFields#Request)."}}}},"author_user_id":{"format":"int32","type":"integer","description":"The ID of the user who created the BAI prompt."}}},"BoardBaiPromptCreateRequest":{"description":"Board BAI prompt create request.","type":"object","required":["type","name","context"],"properties":{"type":{"format":"int32","type":"integer","description":"The type of the BAI prompt. **Comments and Emails**, **Subtasks** and **Summaries** prompts correspond respectively to the values `1`, `2` and `3`.","enum":[1,2,3]},"color":{"type":"string","description":"The color of the BAI prompt in hexadecimal format.","default":""},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the BAI prompt. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the BAI prompt.","default":0},"name":{"type":"string","description":"The **unique** name assigned to the BAI prompt.","minLength":1,"maxLength":250},"context":{"type":"string","description":"Describes the general situation in which the AI assistant will operate.","minLength":1,"maxLength":65000},"topics":{"type":"string","description":"Contains a list of additional important topics to include in the generated content. This is available **only** for **Comments and Emails** and **Subtasks** BAI prompts.","maxLength":65000,"default":""},"suggest_missing_topics":{"format":"int32","type":"integer","description":"Indicates whether the AI model can suggesttopics that may be missing from the generated content.","default":0,"enum":[0,1]}}},"BoardBaiPromptUpdateRequest":{"description":"Board BAI prompt update request","type":"object","properties":{"color":{"type":"string","description":"The color of the BAI prompt in hexadecimal format.","default":""},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the BAI prompt. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the BAI prompt.","default":0},"name":{"type":"string","description":"The **unique** name assigned to the BAI prompt.","minLength":1,"maxLength":250},"context":{"type":"string","description":"Describes the general situation in which the AI assistant will operate.","minLength":1,"maxLength":65000},"topics":{"type":"string","description":"Contains a list of additional important topics to include in the generated content. This is available **only** for **Comments and Emails** and **Subtasks** BAI prompts.","maxLength":65000,"default":""},"suggest_missing_topics":{"format":"int32","type":"integer","description":"Indicates whether the AI model can suggesttopics that may be missing from the generated content.","default":0,"enum":[0,1]}}},"BoardDepartureRuleCreateRequest":{"description":"Board departure rule create request","type":"object","required":["name","conditions"],"properties":{"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1]},"workflow_id":{"description":"The ID of the workflow to which the rule applies.","format":"int32","type":"integer","nullable":true},"lane_id":{"description":"The ID of the lane to which the rule applies.","format":"int32","type":"integer","nullable":true},"column_id":{"description":"The ID of the column to which the rule applies.","format":"int32","type":"integer","nullable":true},"area_id":{"description":"The ID of the merged area to which the rule applies.","format":"int32","type":"integer","nullable":true},"conditions":{"type":"array","description":"Contains the conditions that the rule applies.\n\nAn example of a condition is: **Attachments are present**, which requires all cards to have at least one attachment before moving to the specified workflow, lane, column, or area.","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePositionInCellCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLocalCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleToBoardCondition"},{"$ref":"#\/components\/schemas\/RuleToWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleToColumnCondition"},{"$ref":"#\/components\/schemas\/RuleToLaneCondition"},{"$ref":"#\/components\/schemas\/RuleToSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"BoardDepartureRuleUpdateRequest":{"description":"Board departure rule update request","type":"object","properties":{"name":{"type":"string"},"is_enabled":{"format":"int32","type":"integer","enum":[0,1]},"conditions":{"type":"array","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePositionInCellCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLocalCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleToBoardCondition"},{"$ref":"#\/components\/schemas\/RuleToWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleToColumnCondition"},{"$ref":"#\/components\/schemas\/RuleToLaneCondition"},{"$ref":"#\/components\/schemas\/RuleToSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"BoardUserRoleSetRequest":{"title":"Board User Role Request","description":"Board User Role data.","type":"object","required":["user_id","role_id"],"properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user to whom the role is assigned."},"role_id":{"format":"int32","type":"integer","description":"The unique identifier of the role being assigned to the user."}}},"BoardStructure":{"title":"Board structure","description":"Contains all the information necessary to draw a board: the board details, its settings, workflows, lanes, columns, merged areas and cell limits.","type":"object","properties":{"version":{"type":"string","description":"The version of the board structure. This value is always set to `1.0`.","default":"1.0"},"workspace_id":{"format":"int32","type":"integer","description":"The unique identifier of a workspace. There are two workspace types: **Management** and **Team**."},"board_id":{"format":"int32","type":"integer","description":"The unique identifier of a board."},"name":{"type":"string","description":"The name of the board."},"description":{"type":"string","description":"The description of the board.","default":""},"is_archived":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the board is archived. Archived boards are no longer active but are retained for reference instead of being permanently deleted.","default":0},"workflow_order":{"type":"array","items":{"format":"int32","type":"integer"},"description":"The order of workflows in the board determined by their position in the array."},"workflows":{"type":"object","description":"A list of workflows defined within a board. Every board in Businessmap includes two default workflows - the **Initiatives Workflow** and the **Cards Workflow**.\n\nThe **Cards Workflow** is usually the first workflow in the API (and second workflow in the board UI) and the **Initiatives Workflow** is typically the second workflow in the API (and top workflow in the board UI). Boards can also include a **Timeline Workflow**.","additionalProperties":{"type":"object","properties":{"type":{"format":"int32","type":"integer","enum":[0,1,2],"description":"The type of the workflow. **Cards**, **Initiative** and **Timeline workflows** correspond respectively to the values `0`, `1` and `2`."},"position":{"format":"int32","type":"integer","description":"The position of the workflow. The topmost workflow has a position of `0`.","default":0},"is_enabled":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the workflow is currently active.\n\nA value of `1` means the workflow is enabled and visible on the board.\n\nA value of `0` means it is disabled and hidden, though its work items remain accessible via **Advanced Search** and can be re-enabled later.","default":1},"is_collapsible":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates if the workflow is collapsible. **All** workflows are collapsible by default.","default":1},"name":{"type":"string","description":"The name of the workflow."},"top_lanes":{"type":"array","items":{"format":"int32","type":"integer"},"description":"An array of lane IDs representing all lanes located at the top of the workflow.\n\nIf the workflow has multiple lanes, each lane will be included in this array by its unique identifier."},"bottom_lanes":{"type":"array","items":{"format":"int32","type":"integer"},"description":"An array of lane IDs that always matches the structure of `top_lanes` of the workflow.\n\nEach ID corresponds to the same lane as in `top_lanes`, ensuring a consistent layout between the top and bottom sections of the workflow."},"top_columns":{"type":"array","items":{"format":"int32","type":"integer"},"description":"An array of column objects that define the vertical structure of the top section of the workflow.\n\nBy default, there should be a single column for each area - **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive** - but since multiple columns can exist per area, `top_columns` includes only the topmost column for each area in the workflow.\n\nIf there are three or more columns for a given area, only the topmost and bottommost columns will be included in the respective `top_columns` and `bottom_columns` arrays."},"bottom_columns":{"type":"array","items":{"format":"int32","type":"integer"},"description":"An array of column objects that define the vertical structure of the bottom section of the workflow.\n\nBy default, there should be a single column for each area - **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive** - but since multiple columns can exist per area, `bottom_columns` includes only the bottommost column for each area in the workflow.\n\nIf there are three or more columns for a given area, only the topmost and bottommost columns will be included in the respective `top_columns` and `bottom_columns` arrays."},"section_columns":{"type":"object","description":"A mapping of section identifiers to the columns they contain within a workflow.\n\nThe five predefined sections are **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive**. They correspond respectively to the values `1`, `2`, `3`, `4`, and `5`.\n\nEach section can contain multiple columns at the same level - such as **Requested 1** and **Requested 2** - or nested structures where child columns are grouped under a parent column.","additionalProperties":{"type":"array","items":{"type":"integer","format":"int32"}}}}}},"lanes":{"type":"object","description":"A list of horizontal lanes defined within a board. By default each workflow has a single lane.","additionalProperties":{"type":"object","properties":{"workflow_id":{"format":"int32","type":"integer","description":"The ID of the workflow the lane belongs to."},"name":{"type":"string","description":"The name of the lane."},"description":{"type":"string","description":"The description of the lane.","default":""},"color":{"type":"string","description":"The color of the lane in hexadecimal format.","default":"ffffff"}}}},"columns":{"type":"object","description":"A list of columns defined within a workflow.\n\nThey are organized within predefined sections such as **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive**.\n\nColumns can exist independently at the same level or be structured hierarchically with parent-child relationships.","additionalProperties":{"type":"object","properties":{"workflow_id":{"format":"int32","type":"integer","description":"The ID of the workflow the column belongs to."},"section":{"format":"int32","type":"integer","description":"The section of the workflow the column belongs to.\n\nThe sections **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive** correspond respectively to the values `1`, `2`, `3`, `4`, and `5`."},"parent_column_id":{"format":"int32","type":"integer","description":"The ID of the parent column. It is possible to create hierarchical columns by setting this value to the ID of another column.","default":0},"name":{"type":"string","description":"The name of the column."},"description":{"type":"string","description":"The description of the column.","default":""},"color":{"type":"string","description":"The color of the column in hexadecimal format.","default":""},"limit":{"format":"int32","type":"integer","description":"The limit of cards in the column. A value of `0` indicates that there is no limit, allowing an unlimited number of cards in that area.","default":0},"cards_per_row":{"format":"int32","type":"integer","description":"The number of cards per row in the column.","default":1},"flow_type":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates the flow type of a column, which determines how work is handled in that stage of the process.\n\nA value of `0` represents an **Activity** column, where active work is being performed (e.g., \"Tech Design\").\n\nA value of `1` represents a **Queue** column, which indicates a waiting stage where no active work occurs (e.g., \"Ready for Review\").","default":0},"card_ordering":{"type":"string","nullable":true,"description":"Cards can be ordered by `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`.\n\nThe direction can either be ascending (`asc`) or descending (`desc`).\n\nThe `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"},"checklist_items":{"type":"array","items":{"format":"int32","type":"integer"},"description":"The IDs of the checklist items in the column.\n\n**Exit criteria** are predefined requirements that must be fulfilled before a card is allowed to move to the next column.\n\nThe `column_checklist_items` object contains all the checklist items for the board, keyed by checklist item IDs."}}}},"child_columns":{"type":"object","description":"Represents the child columns associated with a specific parent column on the board.\n\nThis field indicates whether a column has nested sub-columns, allowing for hierarchical organization within the workflow.","additionalProperties":{"type":"array","items":{"format":"int32","type":"integer"}}},"column_checklist_items":{"type":"object","description":"Checklist items for columns, keyed by checklist item IDs.\n\n**Exit criteria** are predefined requirements that must be fulfilled before a card is allowed to move to the next column (i.e., forward in the workflow).","additionalProperties":{"type":"object","properties":{"column_id":{"format":"int32","type":"integer","description":"The ID of the column this checklist item belongs to."},"text":{"type":"string","description":"The name of the exit criterion."},"position":{"format":"int32","type":"integer","description":"The position of the checklist item."}}}},"size_type":{"format":"int32","type":"integer","enum":[0,1,2],"description":"Defines the input format used for the `size` field on cards.\n\nA value of `0` corresponds to **No pattern**, allowing any numeric value.\n\nA value of `1` corresponds to the **Fibonacci sequence**, offering a dropdown of predefined Fibonacci numbers.\n\nA value of `2` corresponds to **T-shirt sizes**, providing labeled options such as S, M, L, XL, etc., internally mapped to numeric values.","default":0},"allow_exceeding":{"format":"int32","type":"integer","enum":[0,1,2],"description":"Determines how exceeding Work-In-Progress (WIP) limits is handled when adding new cards.\n\nA value of `0` permits cards to exceed the WIP limit without restriction.\n\nA value of `1` allows exceeding the limit only if the user provides a reason.\n\nA value of `2` strictly prevents any new cards from being added once the limit is reached.","default":0},"autoarchive_cards_after":{"format":"int32","type":"integer","enum":[1,7,14,30],"description":"Specifies the number of days a completed card should remain in the **Ready to Archive** column before being automatically archived.\n\nCards are moved to the **Permanent Archive** automatically after `1`, `7`, `14`, or `30` days, based on the configured value.","default":7},"limit_type":{"format":"int32","type":"integer","enum":[0,1],"description":"Specifies how the Work-In-Progress (WIP) limit is calculated for a workflow element, such as a column or lane.\n\nA value of `0` represents **Card Count**, which limits the number of individual cards allowed in a stage regardless of their size.\n\nA value of `1` represents **Card Size**, which restricts the total cumulative size of all cards in a stage based on the size values assigned to them.","default":0},"allow_repeating_custom_card_ids":{"format":"int32","type":"integer","enum":[0,1],"description":"Determines whether a Custom card ID can be used only once or multiple times across cards.\n\nThe custom card ID settings of the board **Unique value** and **Repeating value** correspond respectively to the values `0` and `1`.","default":1},"is_discard_reason_required":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates if a discard reason is required for every card.","default":0},"size_formula":{"type":"string","nullable":true,"description":"The formula for calculating card size. It can be set as a **Board level policy**.","example":"average(1,2)","default":null},"deadline_formula":{"type":"string","nullable":true,"description":"The formula for calculating card deadlines. It can be set as a **Board level policy**.","example":"end_of_day(card.created_at())","default":null},"default_sender_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The user ID of the default email sender of the board.\n\nThe default sender user ID can be set to the default notifications email adddress `{url}_notifications@businessmap.io` for your account. In this case the user ID will be 10-digits long and won't be visible in the `\/users` endpoint","default":null},"default_receiver_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The user ID of the default email receiver of the board.\n\nThe default receiver used ID can be set to the **Reporter** or **Owner** of each card on the board. In this case the user ID will be 10-digits long and won't be visible in the `\/users` endpoint.","default":null},"allow_generic_blocker":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates if generic blockers are allowed. If disabled, only specific blockers can be used.","default":1},"cell_card_orderings":{"type":"object","description":"Displays the cell ordering of columns grouped by lane IDs.\n\nCards can be ordered by `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`.\n\nThe direction can either be ascending (`asc`) or descending (`desc`).\n\nThe `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"},"cell_limits":{"type":"object","description":"Displays the cell limits of columns grouped by lane IDs."},"lane_section_limits":{"type":"object","description":"Specifies the maximum number of cards allowed in each predefined section of a swimlane, grouped by lane ID.\n\nEach entry maps a swimlane ID to one or more board sections, with the section identifier as the key and the Work-In-Progress (WIP) limit as the value.\n\nThe five predefined sections are **Backlog**, **Requested**, **In Progress**, **Done**, and **Ready to Archive**, corresponding respectively to the values `1`, `2`, `3`, `4`, and `5`."},"merged_areas":{"type":"object","description":"Merged areas in the board, keyed by area IDs.\n\nWhen there is more than one lane or column for an area, cells within it can be merged.\n\nCells can be merged horizontally when multiple columns are present and vertically when multiple lanes are present.","additionalProperties":{"type":"object","properties":{"primary_column_id":{"format":"int32","type":"integer","description":"The primary column ID for the merged area."},"limit":{"format":"int32","type":"integer","description":"The limit of cards within the merged area."},"card_ordering":{"type":"string","description":"Displays the cell ordering of columns grouped by lane IDs.\n\nCards can be ordered by `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`.\n\nThe direction can either be ascending (`asc`) or descending (`desc`).\n\nThe `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]","nullable":true},"lane_ids":{"type":"array","description":"An array of lane IDs included in the merged area.","items":{"format":"int32","type":"integer"}},"column_ids":{"type":"array","description":"An array of column IDs included in the merged area.","items":{"format":"int32","type":"integer"}}}}},"revision":{"format":"int32","type":"integer","description":"The revision number denotes the number of times edits were made to the board structure. A single revision can include multiple edits, if they were done at the same time."}}},"ArchiveCardVersion":{"title":"Archived card version","description":"Archived card version data.","type":"object","properties":{"version_id":{"format":"int32","type":"integer","description":"The unique identifier of the archived card version."},"name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the archived card version. Automatically created archived versions will have the name `Autoarchive: YYYY-MM-DD`.","example":"Autoarchive: YYYY-MM-DD"}}},"BoardHistoryEvent":{"title":"Board history event","description":"An event recorded when a board management action is performed for a board.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a board."},"board_id":{"format":"int32","type":"integer","description":"The unique identifier of a board."},"event_type":{"type":"string","description":"The type of history event.","enum":["board_created","board_updated","board_archived","board_unarchived","board_moved","workflow_created","workflow_updated","workflow_deleted","workflow_disabled","workflow_enabled","lane_created","lane_renamed","lane_deleted","lane_moved","column_created","column_renamed","column_deleted","column_moved","cell_limits_updated","lane_section_limits_updated","merged_areas_updated","related_boards_updated","user_assigned","user_unassigned","user_role_changed","discard_reason_added","discard_reason_removed","block_reason_added","block_reason_removed","sticker_added","sticker_removed","card_type_added","card_type_removed","tag_added","tag_removed","card_template_added","card_template_removed","custom_field_added","custom_field_removed","team_added","team_role_changed","team_removed","cell_card_orderings_updated","logged_time_category_added","logged_time_category_removed","cycle_time_columns_added","cycle_time_columns_removed"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the board."},"details":{"type":"object","description":"Contains detailed information about the board associated with the event. The object may greatly vary based on the type of event that occurred.\n\nUpdates to the board itself, e.g. changing its description, will result in larger history event containing `previous_state` and `changes`, whereas changes to single parameters, e.g. custom fields, will display details related only to that.","properties":{"previous state":{"type":"object","description":"Contains a list of parameteres describing the previous state of the board before the event occurred."},"changes":{"type":"object","description":"Contains a list of parameters describing the changes made to the board during the event."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"DashboardPage":{"title":"Dashboard page","description":"Dashboard Page data","type":"object","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page."},"name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the dashboard page."}}},"DashboardPageCloneData":{"title":"Cloned dashboard page details","description":"Contains all data returned when a dashboard page is cloned, including its name, unique identifier, and all associated users, teams, workspaces, and widgets.","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the cloned dashboard page."},"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the cloned dashboard page."},"dashboard_page_users":{"type":"array","description":"A list of users who have access to the cloned dashboard page, including their permissions.","items":{"type":"object","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user with access to the dashboard page."},"can_edit":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates if the user can manage the dashboard page.\n - `0` means the user can only view the dashboard page.\n - `1` means the user can edit the dashboard page."}}}},"dashboard_page_teams":{"type":"array","items":{"type":"object","description":"A list of teams with access to the cloned dashboard page, including their permissions.","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page."},"team_id":{"format":"int32","type":"integer","description":"The ID of the team with access to the dashboard page."},"can_edit":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates if the team can manage the dashboard page.\n - `0` means the team can only view the dashboard page.\n - `1` means the team can edit the dashboard page."}}}},"dashboard_page_workspaces":{"type":"array","items":{"type":"object","description":"A list of workspaces linked to the cloned dashboard page, including their positions.","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page."},"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace linked to the dashboard page."},"position":{"format":"int32","type":"integer","description":"The position of the workspace in the dashboard page."}}}},"dashboard_page_widgets":{"type":"array","description":"A list of widgets included in the cloned dashboard page.","items":{"type":"object","properties":{"widget_id":{"format":"int32","type":"integer","description":"The ID of the widget."},"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page to which the widget belongs."},"name":{"type":"string","description":"The name of the widget."},"type":{"format":"int32","type":"integer","description":"The type of the widget."},"configuration":{"type":"string","description":"The configuration of the widget in JSON format."}}}}}},"DashboardPageUser":{"title":"Assign a dashboard member","description":"Assign a user to a dashboard page as a **Dashboard member**.","type":"object","properties":{}},"DashboardPageUserAsManager":{"title":"Assign a dashboard manager","description":"Assign a user to a dashboard page as a **Dashboard manager**.","type":"object","required":["can_edit"],"properties":{"can_edit":{"description":"Indicates if the user can manage the dashboard page.\n\nA value of `0` represents **Dashboard member**, meaning the user can view the dashboard.\n\nA value of `1` represents **Dashboard manager**, meaning the user can add or remove users, workspaces, and widgets, as well as rename the dashboard.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"MyDashboardPage":{"title":"My dashboard page","description":"My dashboard page data.","type":"object","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The unique identifier of the dashboard page."},"position":{"format":"int32","type":"integer","description":"The position of the dashboard page in the list of dashboard pages. `0` is the topmost page.","default":0}}},"Workflow":{"title":"Workflow","description":"Workflow data.","type":"object","properties":{"type":{"format":"int32","type":"integer","description":"The type of the workflow.\n\nA value of `0` represents a **Cards workflow**, a value of `1` represents an **Initiative Workflow** and a value of `2` represents a **Timeline Workflow**.","enum":[0,1,2]},"position":{"format":"int32","type":"integer","description":"The position of the workflow. A value of `0` indicates the topmost workflow.","default":0},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the workflow is enabled.","enum":[0,1],"default":1},"is_collapsible":{"format":"int32","type":"integer","description":"Indicates if the workflow is collapsible. **All** workflows are collapsible by default.","enum":[0,1],"default":1},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the workflow."}}},"Lane":{"title":"Lane","description":"Lane data","type":"object","properties":{"workflow_id":{"description":"The ID of the workflow to which the lane belongs.","format":"int32","type":"integer"},"parent_lane_id":{"description":"The ID of the parent lane, if the lane is part of a hierarchical structure.","format":"int32","type":"integer","nullable":true},"position":{"description":"The position of the lane within the workflow. `0` means the first lane.","format":"int32","type":"integer"},"name":{"description":"The name of the lane.","type":"string","minLength":1,"maxLength":100},"description":{"description":"A brief description of the lane's purpose or usage. Defaults to an empty string if not provided.","type":"string"},"color":{"description":"The color associated with the lane, represented as a 6-character hexadecimal string or an empty string.","type":"string","default":"ffffff"}}},"ColumnMain":{"type":"object","properties":{"workflow_id":{"description":"The ID of the workflow to which the column belongs.","format":"int32","type":"integer"},"section":{"description":"The section of the workflow where the column is located. Valid values are:\n - `1` - Backlog\n - `2` - Requested\n - `3` - Progress\n - `4` - Done\n Adding columns to the **Archive area**, section `5`, is not allowed.","format":"int32","type":"integer","enum":[1,2,3,4]}}},"ColumnSubcolumn":{"type":"object","properties":{"parent_column_id":{"description":"The ID of the parent column, if the column is part of a hierarchical structure.","format":"int32","type":"integer"}}},"ColumnCreated":{"type":"object","properties":{"name":{"description":"The name of the new column.","type":"string","minLength":1,"maxLength":100},"position":{"description":"The position of the column within the section or its parent.","format":"int32","type":"integer"},"description":{"description":"A brief description of the column's purpose or usage. Defaults to an empty string if not provided.","type":"string","default":"\"\""},"color":{"description":"The color associated with the column, represented as a 6-character hexadecimal string or an empty string.","type":"string","default":"\"\""},"limit":{"description":"The Work-In-Progress (WIP) limit for the column, which restricts the number of cards that can be in the column at any given time. Defaults to `0` if not provided.","format":"int32","type":"integer","default":0},"cards_per_row":{"description":"The number of cards displayed per row in the column. Must be a positive integer. Defaults to `1` if not provided.","format":"int32","type":"integer","default":1},"flow_type":{"description":"The flow type of the column. Valid values are:\n - `1` - Activity\n - `2` - Queue\n Defaults to `1` if not provided.","format":"int32","type":"integer","default":1,"enum":[1,2]},"card_progress":{"format":"int32","type":"integer","minimum":0,"maximum":100,"description":"Specifies the manually assigned completion percentage for all cards in the column.","example":50},"card_progress_size_type":{"format":"int32","type":"integer","enum":[0,1,2],"description":"The progress roll-up method of the column. This determines how cards in the column contribute to their parents' progress.\n\nA value of `0` represents **Card size with fallback to cumulative size**, meaning the value explicitly set for size will be used. If no size is set, the cumulative size is used instead. If the size is not set and the cumulative size is 0 (for example, the card has no children), the card's size defaults to 1 .\n\nA value of `1` represents **Card size only**, meaning only the value explicitly set for size will be used. If the card's size is not set, it's counted as 1.\n\nA value of `2` represents **Cumulative size with fallback to card size**, meaning the card's cumulative size \u2014 the total size of all its child cards - will be used. If the cumulative size is 0, the card's size is used instead. If the size is not set, the card's size is counted as 1.","default":0}}},"ColumnUpdated":{"type":"object","properties":{"name":{"description":"The name of the new column.","type":"string","minLength":1,"maxLength":100},"position":{"description":"The position of the column within the section or its parent.","format":"int32","type":"integer"},"description":{"description":"A brief description of the column's purpose or usage. Defaults to an empty string if not provided.","type":"string","default":"\"\""},"color":{"description":"The color associated with the column, represented as a 6-character hexadecimal string or an empty string.","type":"string","default":"\"\""},"limit":{"description":"The Work-In-Progress (WIP) limit for the column, which restricts the number of cards that can be in the column at any given time. Defaults to `0` if not provided.","format":"int32","type":"integer","default":0},"cards_per_row":{"description":"The number of cards displayed per row in the column. Must be a positive integer. Defaults to `1` if not provided.","format":"int32","type":"integer","default":1},"flow_type":{"description":"The flow type of the column. Valid values are:\n - `1` - Activity\n - `2` - Queue\n Defaults to `1` if not provided.","format":"int32","type":"integer","default":1,"enum":[1,2]},"card_ordering":{"type":"string","nullable":true,"description":"Specifies how cards are ordered within the column. Cards can be ordered by fields such as `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`. The direction can be either ascending (`asc`) or descending (`desc`). The `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"},"card_progress":{"format":"int32","type":"integer","minimum":0,"maximum":100,"description":"Specifies the manually assigned completion percentage for all cards in the column.","example":50},"card_progress_size_type":{"format":"int32","type":"integer","enum":[0,1,2],"description":"The progress roll-up method of the column. This determines how cards in the column contribute to their parents' progress.\n\nA value of `0` represents **Card size with fallback to cumulative size**, meaning the value explicitly set for size will be used. If no size is set, the cumulative size is used instead. If the size is not set and the cumulative size is 0 (for example, the card has no children), the card's size defaults to 1 .\n\nA value of `1` represents **Card size only**, meaning only the value explicitly set for size will be used. If the card's size is not set, it's counted as 1.\n\nA value of `2` represents **Cumulative size with fallback to card size**, meaning the card's cumulative size \u2014 the total size of all its child cards - will be used. If the cumulative size is 0, the card's size is used instead. If the size is not set, the card's size is counted as 1.","default":0}}},"Column":{"title":"Column","description":"Column data.","type":"object","properties":{"workflow_id":{"format":"int32","type":"integer","description":"The ID of the workflow to which the column belongs."},"section":{"format":"int32","type":"integer","nullable":true,"description":"The section of the workflow where the column is located. Valid values are `1`, `2`, `3`, `4` or `5`. `Null` means the column is a subcolumn.\n - `1` - Backlog\n - `2` - Requested\n - `3` - Progress\n - `4` - Done\n - `5` - Archive"},"parent_column_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the parent column, if the column is part of a hierarchical structure."},"position":{"format":"int32","type":"integer","description":"The position of the column within the section."},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the column."},"description":{"type":"string","description":"A brief description of the column's purpose or usage."},"color":{"type":"string","description":"The color associated with the column, represented as a hexadecimal string.","default":""},"limit":{"format":"int32","type":"integer","description":"The Work-In-Progress (WIP) limit for the column, which restricts the number of cards that can be in the column at any given time."},"cards_per_row":{"format":"int32","type":"integer","description":"The number of cards displayed per row in the column."},"flow_type":{"format":"int32","type":"integer","enum":[1,2],"description":"The flow type of the column."},"card_ordering":{"type":"string","nullable":true,"description":"Specifies how cards are ordered within the column. Cards can be ordered by fields such as `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`. The direction can be either ascending (`asc`) or descending (`desc`). The `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"},"card_progress":{"format":"int32","type":"integer","minimum":0,"maximum":100,"description":"Specifies the manually assigned completion percentage for all cards in the column.","example":50},"card_progress_size_type":{"format":"int32","type":"integer","enum":[0,1,2],"description":"The progress roll-up method of the column. This determines how cards in the column contribute to their parents' progress.\n\nA value of `0` represents **Card size with fallback to cumulative size**, meaning the value explicitly set for size will be used. If no size is set, the cumulative size is used instead. If the size is not set and the cumulative size is 0 (for example, the card has no children), the card's size defaults to 1 .\n\nA value of `1` represents **Card size only**, meaning only the value explicitly set for size will be used. If the card's size is not set, it's counted as 1.\n\nA value of `2` represents **Cumulative size with fallback to card size**, meaning the card's cumulative size \u2014 the total size of all its child cards - will be used. If the cumulative size is 0, the card's size is used instead. If the size is not set, the card's size is counted as 1.","default":0}}},"MergedArea":{"title":"Merged area","description":"Merged area data","type":"object","properties":{"primary_column_id":{"description":"For merged areas spanning multiple columns, this is the ID of the column which will reflect the state of the cards in the merged cells in terms of board positioning.","format":"int32","type":"integer"},"limit":{"description":"The limit of cards within the merged area, which restricts the number of cards that can be in the merged area at any given time.","format":"int32","type":"integer"},"card_ordering":{"type":"string","nullable":true,"description":"Specifies how cards are ordered within the merged area. Cards can be ordered by fields such as `block_reason`, `created_at`, `custom_id`, `cycle_time`, `deadline`, `last_modified`, `local_cycle_time`, `owner`, and `priority`. The direction can be either ascending (`asc`) or descending (`desc`). The `field_type` is always set to `plain`.","example":"[{\\\"field_type\\\":\\\"plain\\\",\\\"direction\\\":\\\"asc\\\",\\\"field_name\\\":\\\"block_reason\\\"}]"},"lane_ids":{"description":"A list of lane IDs included in the merged area.","type":"array","items":{"format":"int32","type":"integer"}},"column_ids":{"description":"A list of column IDs included in the merged area.","type":"array","items":{"format":"int32","type":"integer"}}}},"ChecklistItem":{"title":"Checklist item","description":"Checklist item data.","type":"object","properties":{"item_id":{"format":"int32","type":"integer","description":"The unique identifier of the checklist item."},"text":{"type":"string","description":"The description of the checklist item."},"position":{"format":"int32","type":"integer","description":"The position of the checklist item. `0` is the first position."},"allowed_users":{"type":"array","description":"The list of users allowed to mark the checklist item as completed. If the list is empty, **all** users added to the board are allowed to mark the checklist item as completed.","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user allowed to mark the checklist item as completed"}}}}}},"CellLimit":{"title":"Cell limit","description":"Cell limit data.","type":"object","properties":{"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board."},"lane_id":{"format":"int32","type":"integer","description":"The unique identifier of the lane."},"column_id":{"format":"int32","type":"integer","description":"The unique identifier of the column."},"limit":{"format":"int32","type":"integer","description":"The work in progress (WIP) limit of cards in the cell.","maximum":100000}}},"LaneSectionLimit":{"title":"Lane section limit","description":"Lane section limit data.","type":"object","properties":{"lane_id":{"format":"int32","type":"integer","description":"The unique identifier of the lane."},"section":{"format":"int32","type":"integer","description":"The unique identifier of the section. Since this is an **In Progress** section limit, this is always set to `3`."},"limit":{"format":"int32","type":"integer","description":"The work in progress (WIP) limit of cards in the section."}}},"WorkflowCopy":{"title":"Workflow copy","description":"Workflow copy data.","type":"object","properties":{"board_structure":{"$ref":"#\/components\/schemas\/BoardStructure"},"cycle_time_column_ids":{"type":"array","description":"Contains a list of the IDs of the workflow's cycle time columns.","items":{"format":"int32","type":"integer"}},"initiative_workflow_settings":{"type":"array","description":"A list of **Initiative Workflow** settings for the copied workflow. These do **not** apply for **Cards** or **Timeline** workflows.","items":{"type":"object","title":"Initiative workflow setting","properties":{"workflow_id":{"description":"The unique identifier of the **Initiative Workflow**.","type":"integer"},"built_in_rules_can_start_initiatives":{"type":"integer","description":"Determines whether initiatives are started (moved to the **In Progress** column) when their first child is started.","enum":[0,1],"default":1},"built_in_rules_can_finish_initiatives":{"type":"integer","description":"Determines whether initiatives are finished (moved to the **Done** column) when all their children are finished.","enum":[0,1],"default":1},"built_in_rules_can_move_to_requested":{"type":"integer","description":"Determines whether initiatives are moved to the **Requested** column when all their children are in the **Requested** column.","enum":[0,1],"default":1},"built_in_rules_can_move_back_from_done":{"type":"integer","description":"Determines whether initiatives are outside the **Done** column if one their children is moved outside the **Done** column.","enum":[0,1],"default":1},"built_in_rules_can_move_from_backlog_to_requested":{"type":"integer","description":"Determines whether initiatives are moved from the **Backlog** column to the **Requested** column when their first child is moved to the **Requested** column.","enum":[0,1],"default":1},"built_in_rules_can_move_from_done_to_archive":{"type":"integer","description":"Determines whether initiatives can be moved from the **Done** column to the **Ready to Archive** column.","enum":[0,1],"default":0}}}},"new_workflow_default_templates":{"type":"object","properties":{"workflow_template_id":{"format":"int32","type":"integer","description":"The ID of the workflow template."},"lane_templates":{"type":"object","additionalProperties":{"type":"integer","format":"int32"},"description":"A map where keys are lane IDs and values are template IDs."}}}}},"WorkflowCycleTimeColumn":{"title":"Workflow cycle time column","description":"Represents a column in a workflow that is included in the cycle time calculation for cards.\n","type":"object","properties":{"column_id":{"format":"int32","type":"integer","description":"The ID of the column included in the cycle time calculation."},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The name of the column."}}},"WorkflowEffectiveCycleTimeColumn":{"title":"Workflow effective cycle time column","description":"Workflow effective cycle time column data.","type":"object","properties":{"column_id":{"format":"int32","type":"integer","description":"The unique identifier of the column."},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The **unique** name of the column."}}},"BoardEffectiveCycleTimeColumn":{"title":"Board workflow","description":"Board workflow data.","type":"object","properties":{"workflow_id":{"format":"int32","type":"integer","description":"The unique identifier of the workflow."},"name":{"type":"string","minLength":1,"maxLength":100,"description":"The **unique** name of the workflow."},"effective_cycle_time_columns":{"type":"array","description":"The list of effective cycle time columns in the workflow.","items":{"$ref":"#\/components\/schemas\/WorkflowEffectiveCycleTimeColumn"}}}},"BoardCustomFieldDataCommon":{"title":"Board Custom Field","description":"Board custom field data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the custom field on a board level. `0` is the first position. If you don't specify a position, the custom field will be added to the **end** of the list."},"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","enum":[0,1]}}},"BoardCustomFieldDataSingleLine":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Single-Line Text","description":"Board custom field data - single-line text.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":"","minLength":1,"maxLength":250},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataSingleLineWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"}]},"BoardCustomFieldDataSingleLineWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataSingleLine"}]},"BoardCustomFieldEffectiveSettingsDataSingleLine":{"allOf":[{"type":"object","title":"Single-Line Text","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"uniqueness_of_values":{"description":"Controls how unique the value of the custom field must be.\n\nA value of `0` corresponds to `Any value`, allowing the custom field to have any value.\n\nA value of `1` corresponds to `Unique value per board`, requiring the value of the custom field to be unique for each board.\n\nA value of `2` corresponds to `Unique value across al boards`, requiring the value of the custom field to be unique across all boards.","format":"int32","type":"integer","default":0,"enum":[0,1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":""}}}]},"BoardCustomFieldDataMultiLine":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Multi-Line Text","description":"Board custom field data - multi-line text.","properties":{"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":""},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataMultiLineWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"}]},"BoardCustomFieldDataMultiLineWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataMultiLine"}]},"BoardCustomFieldEffectiveSettingsDataMultiLine":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":""}}}]},"BoardCustomFieldDataNumber":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Number","description":"Board custom field data - number.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":2,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"double","type":"number","description":"The default value of the custom field on a board level.","default":null,"nullable":true},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataNumberWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"}]},"BoardCustomFieldDataNumberWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataNumber"}]},"BoardCustomFieldEffectiveSettingsDataNumber":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":2,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"uniqueness_of_values":{"description":"Controls how unique the value of the custom field must be.\n\nA value of `0` corresponds to `Any value`, allowing the custom field to have any value.\n\nA value of `1` corresponds to `Unique value per board`, requiring the value of the custom field to be unique for each board.\n\nA value of `2` corresponds to `Unique value across al boards`, requiring the value of the custom field to be unique across all boards.","format":"int32","type":"integer","default":0,"enum":[0,1,2]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"double","type":"number","description":"The default value of the custom field on a board level.","default":null,"nullable":true}}}]},"BoardCustomFieldDataDate":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Date","description":"Board custom field data - date.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"date","type":"string","description":"The default value of the custom field on a board level.","default":null,"nullable":true},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataDateWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"}]},"BoardCustomFieldDataDateWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDate"}]},"BoardCustomFieldEffectiveSettingsDataDate":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"int32","type":"integer","description":"The default value of the custom field on a board level.","default":null,"nullable":true}}}]},"BoardCustomFieldDataLink":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Link","description":"Board custom field data - link.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":"","minLength":1,"maxLength":250},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataLinkWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"}]},"BoardCustomFieldDataLinkWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataLink"}]},"BoardCustomFieldEffectiveSettingsDataLink":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":""}}}]},"BoardCustomFieldDataDropdown":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Dropdown","description":"Board custom field data - dropdown.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","default":0,"enum":[0,1]},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldDataDropdownWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"}]},"BoardCustomFieldDataDropdownWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataDropdown"}]},"BoardCustomFieldEffectiveSettingsDataDropdown":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","default":0,"enum":[0,1]},"allowed_values":{"type":"array","description":"The list of allowed values for the custom field on a board level.","items":{"type":"object","title":"Allowed value","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value."},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the allowed value is enabled on a board level.","default":1,"enum":[0,1]},"is_default":{"format":"int32","type":"integer","description":"Controls whether the allowed value is the default value on a board level.","default":0,"enum":[0,1]},"value":{"type":"string","description":"The name of the allowed value for the customer field.","minLength":1}}}}}}]},"BoardCustomFieldDataContributor":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Contributor","description":"Board custom field data - contributor.","properties":{"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1}}}]},"BoardCustomFieldDataContributorWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"}]},"BoardCustomFieldDataContributorWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataContributor"}]},"BoardCustomFieldEffectiveSettingsDataContributor":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1},"default_value":{"type":"array","description":"The default value of the custom field on a board level.","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user designated as a contributor for the custom field on a board level.","default":[]}}}}}}]},"BoardCustomFieldDataFile":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"File","description":"Board custom field data - file.","properties":{"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"BoardCustomFieldDataFileWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"}]},"BoardCustomFieldDataFileWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataFile"}]},"BoardCustomFieldEffectiveSettingsDataFile":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"BoardCustomFieldDataVote":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Vote","description":"Board custom field data - vote.","properties":{"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"BoardCustomFieldDataVoteWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"}]},"BoardCustomFieldDataVoteWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataVote"}]},"BoardCustomFieldEffectiveSettingsDataVote":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"BoardCustomFieldDataCardPicker":{"allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCommon"},{"type":"object","title":"Card Picker","description":"Board custom field data - card picker","properties":{"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":1}}}]},"BoardCustomFieldDataCardPickerWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]},"BoardCustomFieldDataCardPickerWithBoardId":{"allOf":[{"type":"object","properties":{"board_id":{"description":"The unique identifier of the board.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/BoardCustomFieldDataCardPicker"}]},"BoardCustomFieldEffectiveSettingsDataCardPicker":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":0},"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."}}}]},"BoardCustomFieldEffectiveSettingsDataCalculatedFieldNumber":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"sum(1,2)"},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8}}}]},"BoardCustomFieldEffectiveSettingsDataCalculatedFieldDate":{"allOf":[{"type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","default":0,"enum":[0,1]},"display_width":{"description":"When set to 1 the custom field will take all of the available width. When set to 2 the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"add_days(card.deadline(),1)"}}}]},"BoardCustomFieldAllowedValue":{"title":"Board custom field allowed value","description":"Board custom field allowed value data.","type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value."},"position":{"format":"int32","type":"integer","description":"The position of the allowed value. `0` is the first position."},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the allowed value is enabled on the specified board.","enum":[0,1]},"is_default":{"format":"int32","type":"integer","description":"Controls whether the allowed value is a default value for the custom field on the specified board.","default":1,"enum":[0,1]}}},"BoardCustomFieldCreateOrUpdateRequestCommon":{"description":"Board custom field data.","type":"object","properties":{"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether the custom field must always be present on all cards.","enum":[0,1]},"position":{"format":"int32","type":"integer","description":"The position of the custom field on a board level. `0` is the first position. If you don't specify a position, the custom field will be added to the **end** of the list."}}},"BoardCustomFieldCreateAnyType":{"title":"Add any type of custom field to a board","type":"object","description":"An empty request can be sent to add a custom field to a board without making any other updates."},"BoardCustomFieldCreateOrUpdateRequestSingleLine":{"title":"Add and update a single-line text custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - single-line text.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":"","minLength":1,"maxLength":250},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestMultiLine":{"title":"Add and update a multi-line text custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - multi-line text.","properties":{"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":""},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestNumber":{"title":"Add and update a number custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - number.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":2,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","default":"","minLength":1,"maxLength":250},"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0},"default_value":{"format":"double","type":"number","description":"The default value of the custom field on a board level.","default":null,"nullable":true},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestDate":{"title":"Add and update a date custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - date.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"date","type":"string","description":"The default value of the custom field on a board level.","default":null,"nullable":true},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestLink":{"title":"Add and update a link custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - link.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field on a board level.","default":"","minLength":1,"maxLength":250},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestDropdown":{"title":"Add and update a dropdown custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - dropdrown.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","default":0,"enum":[0,1]},"inherit_default_values":{"format":"int32","type":"integer","description":"Controls whether the global default values of the custom field should be used on a board level.","default":1,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestContributor":{"title":"Add and update a contributor custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - contributor.","properties":{"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1}}}]},"BoardCustomFieldCreateOrUpdateRequestFile":{"title":"Add and update a file custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - file.","properties":{"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"BoardCustomFieldCreateOrUpdateRequestVote":{"title":"Add and update a vote custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - vote.","properties":{"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"BoardCustomFieldCreateOrUpdateRequestCardPicker":{"title":"Add and update a card picker custom field to a board","allOf":[{"$ref":"#\/components\/schemas\/BoardCustomFieldCreateOrUpdateRequestCommon"},{"type":"object","description":"Board custom field data - card picker.","properties":{"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":1}}}]},"RuleAttachmentCondition":{"title":"Attachment condition","description":"An attachment condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["attachments"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["are_present","is_not_present"]}}},"RuleEffectiveIdCondition":{"title":"Effective ID condition","description":"An effective ID condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["effective_id"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleCustomIdCondition":{"title":"Custom ID condition","description":"A custom ID condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["custom_id"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleChildCardsCondition":{"title":"Child cards condition","description":"A child cards condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["child_cards"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["exist","do_not_exist","all_match","some_match","some_do_not_match","none_match","none_match_or_exist"]},"nested_conditions":{"type":"array","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n","items":{"type":"object","anyOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleColorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePriorityCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleReporterCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSizeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleStickersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTagsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTitleCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTypeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"}]}}}},"RuleParentCardsCondition":{"title":"Parent cards condition","description":"A parent cards condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["parent_cards"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["exist","do_not_exist","all_match","some_match","some_do_not_match","none_match","none_match_or_exist"]},"nested_conditions":{"type":"array","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n","items":{"type":"object","anyOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleColorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePriorityCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleReporterCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSizeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleStickersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTagsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTitleCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTypeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"}]}}}},"RuleRelativeCardsCondition":{"title":"Relative cards condition","description":"A relative cards condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["relative_cards"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["exist","do_not_exist","all_match","some_match","some_do_not_match","none_match","none_match_or_exist"]},"nested_conditions":{"type":"array","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n","items":{"type":"object","anyOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleColorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePriorityCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleReporterCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSizeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleStickersCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTagsCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTitleCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleTypeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition","description":"The nested conditions for the rule. Required when the operator is either one of:\n - all_match\n - some_match\n - some_do_not_match\n - none_match\n - none_match_or_exist\n"}]}}}},"RuleCoOwnersCondition":{"title":"Co-owners condition","description":"A co-owners condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["co_owners"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contain","do_not_contain","are_present","are_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleColorCondition":{"title":"Color condition","description":"A color condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["color"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleCommentsCondition":{"title":"Comments condition","description":"A comments condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["comments"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["are_present","are_not_present"]}}},"RuleDeadlineCondition":{"title":"Deadline condition","description":"A deadline condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["deadline"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_overdue","is_not_overdue","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string","format":"date"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleDescriptionCondition":{"title":"Description condition","description":"A description condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["description"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contains","does_not_contain","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleOwnerCondition":{"title":"Owner condition","description":"An owner condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["owner"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RulePositionInCellCondition":{"title":"Position in cell condition","description":"A position in cell condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["position_in_cell"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RulePriorityCondition":{"title":"Priority condition","description":"A priority condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["priority"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleReporterCondition":{"title":"Reporter condition","description":"A reporter condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["reporter"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleSizeCondition":{"title":"Size condition","description":"A size condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["size"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleStickersCondition":{"title":"Stickers condition","description":"A stickers condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["stickers"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contain","do_not_contain","are_present","are_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleSubtaskProgressCondition":{"title":"Subtask progress condition","description":"A subtask progress condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["subtask_progress"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleTagsCondition":{"title":"Tags condition","description":"A tags condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["tags"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contain","do_not_contain","are_present","are_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleTitleCondition":{"title":"Title condition","description":"A title condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["title"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleTypeCondition":{"title":"Type condition","description":"A type condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["type"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleBlockTimeCondition":{"title":"Block time condition","description":"A block time condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["block_time"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The block time can be provided as an integer representing days (e.g. `2` is treated as 2 days). For custom timeframes, you can specify the duration using the following formats as a string: `\"X days\"`, `\"X hours\"`, `\"X minutes\"`, or `\"X seconds\"`, where `X` can be either an integer or a decimal.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}}}},"RuleCycleTimeCondition":{"title":"Cycle time condition","description":"A cycle time condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["cycle_time"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The cycle time can be provided as an integer representing days (e.g. `2` is treated as 2 days). For custom timeframes, you can specify the duration using the following formats as a string: `\"X days\"`, `\"X hours\"`, `\"X minutes\"`, or `\"X seconds\"`, where `X` can be either an integer or a decimal.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}}}},"RuleLocalCycleTimeCondition":{"title":"Local cycle time condition","description":"A local cycle time condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["local_cycle_time"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The local cycle time can be provided as an integer representing days (e.g. `2` is treated as 2 days). For custom timeframes, you can specify the duration using the following formats as a string: `\"X days\"`, `\"X hours\"`, `\"X minutes\"`, or `\"X seconds\"`, where `X` can be either an integer or a decimal.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}}}},"RuleLoggedTimeCondition":{"title":"Logged time condition","description":"A logged time condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["logged_time"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The logged time can be provided as an integer representing days (e.g. `2` is treated as 2 days). For custom timeframes, you can specify the duration using the following formats as a string: `\"X days\"`, `\"X hours\"`, `\"X minutes\"`, or `\"X seconds\"`, where `X` can be either an integer or a decimal.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}}}},"RuleFromBoardCondition":{"title":"From board condition","description":"A from board condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["from_board"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleFromWorkflowCondition":{"title":"From workflow condition","description":"A from workflow condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["from_workflow"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleFromColumnCondition":{"title":"From column condition","description":"A from column condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["from_column"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleFromLaneCondition":{"title":"From lane condition","description":"A from lane condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["from_lane"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleFromSectionCondition":{"title":"From section condition","description":"A from section condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["from_section"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule. Section values must be integers between 1 and 5.","minItems":1,"items":{"type":"integer","format":"int32","minimum":1,"maximum":5}}}},"RuleToBoardCondition":{"title":"To board condition","description":"A to board condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["to_board"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleToWorkflowCondition":{"title":"To workflow condition","description":"A to workflow condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["to_workflow"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleToColumnCondition":{"title":"To column condition","description":"A to column condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["to_column"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleToLaneCondition":{"title":"To lane condition","description":"A to lane condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["to_lane"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleToSectionCondition":{"title":"To section condition","description":"A to section condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["to_section"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule. Section values must be integers between 1 and 5.","minItems":1,"items":{"type":"integer","format":"int32","minimum":1,"maximum":5}}}},"RuleAuthorCondition":{"title":"Author condition","description":"An author condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["author"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!="]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RulePlannedStartDateCondition":{"title":"Planned start date condition","description":"A planned start date condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["planned_start_date"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_overdue","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string","format":"date"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RulePlannedEndDateCondition":{"title":"Planned end date condition","description":"A planned end date condition.","type":"object","required":["field_type","field_name","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain"]},"field_name":{"type":"string","description":"The name of the field added as a condition to the rule.","enum":["planned_end_date"]},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_overdue","is_empty","is_not_empty"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string","format":"date"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldSingleLineTextCondition":{"title":"Custom field single line text condition","description":"A custom field single line text condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The values used in the condition can be a list of integers or strings. Note that if integers are provided, they will be automatically converted to strings.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldMultiLineTextCondition":{"title":"Custom field multi line text condition","description":"A custom field multi line text condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The values used in the condition can be a list of integers or strings. Note that if integers are provided, they will be automatically converted to strings.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldNumberCondition":{"title":"Custom field number condition","description":"A custom field number condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The values used in the condition can be a list of integers or strings. Note that if integers are provided, they will be automatically converted to strings.","type":"integer","format":"int32"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldDateCondition":{"title":"Custom field date condition","description":"A custom field date condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","<","<=",">",">=","between","between_exclusive","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"If an integer is provided, the date will be calculated as `X` days in the future (for positive values) or `X` days in the past (for negative values).\n\nFor custom timeframes, you can specify the duration using the following formats as a string: `\"X days\"`, `\"X hours\"`, `\"X minutes\"`, or `\"X seconds\"`, where `X` can be an integer or decimal and can be positive or negative.\n\nAdditionally, if a string is used, any of the following date formats will be accepted: \r\n- `YYYY-MM-DD` \r\n- `YYYY-MM-DD HH-MM-SS`\r\n \r\nYou can also use natural language terms like `today`, `tomorrow`, `yesterday`, `next week`, `last week`, `this week`, `last month`, `this month`, and `next month`.\r\n","oneOf":[{"type":"string"},{"type":"integer"}]}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldLinkCondition":{"title":"Custom field link condition","description":"A custom field link condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["=","!=","contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"description":"The values used in the condition can be a list of integers or strings. Note that if integers are provided, they will be automatically converted to strings.","oneOf":[{"type":"integer","format":"int32"},{"type":"string"}]}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldDropdownCondition":{"title":"Custom field dropdown condition","description":"A custom field dropdown condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values used in the condition must follow specific patterns.\n\n- Use `\"Av:{integer}\"` for allowed values of custom fields, where `{integer}` is the ID of the value.\r\n- Use `\"Ov:{string}\"` for other values of custom fields, where `{string}` can be any value.\n\nThe `{integer}` must be a valid ID of an allowed value for a custom field (you can check the allowed values of a custom field by calling the [\/customFields\/{field_id}\/allowedValues](#\/operations\/getCustomFieldAllowedValues#Request) endpoint), while `{string}` can represent any string.","minItems":1,"items":{"type":"string","enum":["ov:{value_id}","av:{string}"]}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"RuleCustomFieldContributorCondition":{"title":"Custom field contributor condition","description":"A custom field contributor condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}}}},"RuleCustomFieldFileCondition":{"title":"Custom field file condition","description":"A custom field file condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"string"}}}},"RuleCustomFieldVoteCondition":{"title":"Custom field vote condition","description":"A custom field vote condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["is_present","is_not_present"]}}},"RuleCustomFieldCardPickerCondition":{"title":"Custom field card picker condition","description":"A custom field card picker condition.","type":"object","required":["field_type","field_id","operator"],"properties":{"field_type":{"type":"string","description":"The type of the field added as a condition to the rule. Default fields like **Attachments**, **Author**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["custom"]},"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field used for the rule."},"operator":{"type":"string","description":"The operator of the field added as a condition to the rule.","enum":["contains","does_not_contain","is_empty","is_not_empty","is_present","is_not_present"]},"values":{"type":"array","description":"The values of the field added as a condition to the rule.","minItems":1,"items":{"type":"integer","format":"int32"}},"ignore_if_not_present":{"description":"Determines whether the field added as a condition to the rule should be ignored if not present. This applies **only** for the **Custom ID** field and fields of type `custom`. That way if a card is **missing** a custom ID or a custom field, it can skip the applied condition and still be moved to the specified workflow, lane, column or merged area.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"User":{"title":"User","description":"User data.","type":"object","properties":{"email":{"type":"string","format":"email","description":"The email address of the user."},"username":{"type":"string","description":"The username of the user.","minLength":1,"maxLength":100},"realname":{"type":"string","description":"The real name of the user.","minLength":1,"maxLength":100},"avatar":{"type":"string","description":"A link to the uploaded file for the user's avatar.","default":null,"example":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80"},"email_signature":{"description":"The email signature of the user. This signature is automatically added to all email messages sent from the Comments section of a card.","type":"string","default":null,"example":"

Lorem ipsum dolor sit amet.<\/p>"},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the user is enabled.","enum":[0,1],"default":0},"is_confirmed":{"format":"int32","type":"integer","description":"Indicates whether the user has confirmed their invitation to create an account.","enum":[0,1],"default":0},"is_tfa_enabled":{"format":"int32","type":"integer","description":"Indicates whether two-factor authentication is enabled for the user.","enum":[0,1],"default":0},"registration_date":{"type":"string","format":"date","description":"The registration date of the user, in `YYYY-MM-DD` format.","example":"2025-01-01"},"timezone":{"description":"The timezone of the current user.","type":"string","example":"Europe\/Sofia","default":"UTC"},"language":{"description":"The UI language of the current user.","type":"string","enum":["en","de","es","pt","fr","it","pl"],"default":"en"},"attributes":{"type":"array","description":"A list of additional attributes associated with the user.","items":{"type":"object","title":"User attribute","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The unique identifier of the user attribute."},"value":{"type":"string","description":"The value of the user attribute."}}}}}},"Users":{"title":"User","description":"User data.","type":"object","properties":{"user_id":{"description":"The unique identifier of the user.","format":"int32","type":"integer"},"username":{"type":"string","description":"The username of the user.","minLength":1,"maxLength":100},"realname":{"type":"string","description":"The real name of the user.","minLength":1,"maxLength":100},"avatar":{"type":"string","description":"A link to the uploaded file for the user's avatar.","default":null,"example":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80"},"attributes":{"type":"array","description":"A list of additional attributes associated with the user.","items":{"type":"object","title":"User attribute","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The unique identifier of the user attribute."},"value":{"type":"string","description":"The value of the user attribute."}}}}}},"UserHistoryEvent":{"title":"User history event","description":"An event recorded when a user management action is executed on users resource","type":"object","properties":{"id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"affected_user_id":{"description":"The ID of the user affected by the history event.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who performed the action that triggered the history event.","format":"int32","type":"integer"},"event_type":{"description":"The type of the history event.","type":"string","enum":["user_confirmed","user_deleted","email_changed","username_changed","realname_changed","email_signature_changed","avatar_changed","tfa_changed","tfa_enabled","tfa_disabled","tfa_key_changed","tfa_key_reset","api_key_changed","timezone_changed","language_changed","password_changed","added_to_team","removed_from_team","added_to_team_managers","removed_to_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_to_dashboard_page","user_disabled","user_enabled","wip_limits_changed","global_privilege_added","global_privilege_removed","made_wm","made_non_wm","assigned_to_board","unassigned_from_board","board_role_changed","user_attribute_added","user_attribute_changed","user_attribute_removed","invitation_sent","invitation_code_changed"]},"details":{"description":"Contains additional information about the history event, where applicable.","type":"object","oneOf":[{"title":"User Confirmed Event Details","description":"Details for a user confirmed event.","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of the user who was confirmed."},"email":{"type":"string","description":"The email of the user who was confirmed."},"username":{"type":"string","description":"The username of the user who was confirmed."},"realname":{"type":"string","description":"The real name of the user who was confirmed."},"timezone":{"type":"string","description":"The timezone of the user who was confirmed."},"language":{"type":"string","description":"The language of the user who was confirmed."},"avatar":{"type":"string","description":"The avatar of the user who was confirmed.","nullable":true},"email_signature":{"type":"string","description":"The email signature of the user who was confirmed.","nullable":true},"is_tfa_enabled":{"format":"int32","type":"integer","description":"Indicates whether two-factor authentication is enabled for the user.","enum":[0,1]},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the user is enabled.","enum":[0,1]},"is_confirmed":{"format":"int32","type":"integer","description":"Indicates whether the user is confirmed.","enum":[0,1]},"role_in_company":{"type":"string","description":"The role of the user in the company."},"registration_date":{"type":"string","format":"date","description":"The registration date of the user, in `YYYY-MM-DD` format."}}},{"title":"User Deleted Event Details","description":"Details for a user deleted event.","properties":{"username":{"type":"string","description":"The username of the user who was deleted."}}},{"title":"Email Change Eevent Details","description":"Details for an email change event.","properties":{"old_email":{"type":"string","description":"The old email of the user."},"new_email":{"type":"string","description":"The new email of the user."}}},{"title":"Username Change Event Details","description":"Details for a username change event.","properties":{"old_username":{"type":"string","description":"The old username of the user."},"new_username":{"type":"string","description":"The new username of the user."}}},{"title":"Real Name Change Event Details","description":"Details for a realname change event.","properties":{"old_realname":{"type":"string","description":"The old real name of the user."},"new_realname":{"type":"string","description":"The new real name of the user."}}},{"title":"Email Signature Change Event Details","description":"Details for an email signature change event.","properties":{"old_email_signature":{"type":"string","description":"The old email signature of the user."},"new_email_signature":{"type":"string","description":"The new email signature of the user."}}},{"title":"Added to Team Event Details","description":"Details for an added to team event.","properties":{"team_id":{"format":"int32","type":"integer","description":"The ID of the team to which the user was added."}}},{"title":"Removed from Team Event Details","description":"Details for a removed from team event.","properties":{"team_id":{"format":"int32","type":"integer","description":"The ID of the team from which the user was removed."}}},{"title":"Added to Team Managers Event Details","description":"Details for an added to team managers event.","properties":{"team_id":{"format":"int32","type":"integer","description":"The ID of the team to which the user was added as a manager."}}},{"title":"Removed from Team Managers Event Details","description":"Details for a removed from team managers event.","properties":{"team_id":{"format":"int32","type":"integer","description":"The ID of the team from which the user was removed as a manager."}}},{"title":"Added to Dashboard Page Event Details","description":"Details for an added to dashboard page event.","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page to which the user was added."}}},{"title":"Removed from Dashboard Page Event Details","description":"Details for a removed from dashboard page event.","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page from which the user was removed."}}},{"title":"Change Permissions for Dashboard Page Event Details","description":"Details for a change permissions for dashboard page event.","properties":{"dashboard_page_id":{"format":"int32","type":"integer","description":"The ID of the dashboard page for which the permissions were changed."},"old_can_edit":{"format":"int32","type":"integer","description":"Indicates whether the user could edit the dashboard page before the change.","enum":[0,1]},"new_can_edit":{"format":"int32","type":"integer","description":"Indicates whether the user can edit the dashboard page after the change.","enum":[0,1]}}},{"title":"Global Privilege Added Event Details","description":"Details for a global privilege added event.","properties":{"privilege_name":{"type":"string","description":"The name of the global privilege that was added to the user."}}},{"title":"Global Privilege Removed Event Details","description":"Details for a global privilege removed event.","properties":{"privilege_name":{"type":"string","description":"The name of the global privilege that was removed from the user."}}},{"title":"Made Workspace Manager Event Details","description":"Details for a made workspace manager event.","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace for which the user was made a manager."}}},{"title":"Removed from Workspace Managers Event Details","description":"Details for a removed from workspace managers event.","properties":{"workspace_id":{"format":"int32","type":"integer","description":"The ID of the workspace from which the user was removed as a manager."}}},{"title":"Assigned to Board Event Details","description":"Details for an assigned to board event.","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board to which the user was assigned."},"role_id":{"format":"int32","type":"integer","description":"The ID of the role assigned to the user on the board."}}},{"title":"Unassigned from Board Event Details","description":"Details for an unassigned from board event.","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board from which the user was unassigned."},"role_id":{"format":"int32","type":"integer","description":"The ID of the role that was unassigned from the user on the board."}}},{"title":"Board Role Changed Event Details","description":"Details for a board role changed event.","properties":{"board_id":{"format":"int32","type":"integer","description":"The ID of the board for which the role was changed."},"old_role_id":{"format":"int32","type":"integer","description":"The ID of the role that was previously assigned to the user on the board."},"new_role_id":{"format":"int32","type":"integer","description":"The ID of the new role assigned to the user on the board."}}},{"title":"User Attribute Added Event Details","description":"Details for a user attribute added event.","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The ID of the user attribute that was added."},"value":{"type":"string","description":"The value of the user attribute that was added."}}},{"title":"User Attribute Changed Event Details","description":"Details for a user attribute changed event.","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The ID of the user attribute that was changed."},"old_value":{"type":"string","description":"The old value of the user attribute."},"new_value":{"type":"string","description":"The new value of the user attribute."}}},{"title":"User Attribute Removed Event Details","description":"Details for a user attribute removed event.","properties":{"attribute_id":{"format":"int32","type":"integer","description":"The ID of the user attribute that was removed."},"value":{"type":"string","description":"The value of the user attribute that was removed."}}},{"title":"Invitation Sent Event Details","description":"Details for an invitation sent event.","properties":{"email":{"type":"string","description":"The email to which the invitation was sent."}}},{"title":"Invitation Code Changed Event Details","description":"Details for an invitation code changed event.","properties":{"email":{"type":"string","description":"The email for which the invitation code was changed."}}}]},"time":{"description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","type":"string","format":"date","example":"2025-06-10T00:00:00+00:00"}}},"Role":{"title":"Role","description":"Role data.","type":"object","properties":{"name":{"type":"string","description":"The **unique** name of the role.","minLength":1,"maxLength":100}}},"BlockReason":{"title":"Block reason","description":"Block reason data.","type":"object","properties":{"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of the block reason."},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the block reason. `0` represents a system icon, while `1` represents a user-defined icon.","enum":[0,1],"default":0},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the block reason.","default":0},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The **unique** label (i.e. the name) assigned to the block reason."},"color":{"type":"string","description":"The color of the block reason in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the block reason.\n\nA value of `0` represents **On-demand**, meaning the block reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the block reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the block reason is automatically added to all boards across all workspaces. Once a block reason's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the block reason is enabled.","enum":[0,1],"default":1}}},"RoleHistoryEvent":{"title":"Role history event","description":"An event recorded whenever a create, update, or delete action is performed for a role.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a role."},"role_id":{"format":"int32","type":"integer","description":"The unique identifier of a role."},"event_type":{"type":"string","description":"The type of the history event.","enum":["create","update","delete","permissions_changed"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the role."},"details":{"type":"object","description":"Contains detailed information about the role associated with the event.\n\nThe `previous_state` and `changes` objects are included for the events of type `updated`. Only the `details` object is included for **all** other event types.\n\nFor the `permissions_changed` event the `details` object can contain the `added` and `removed` arrays which describe the changes to the permissions of the role.","properties":{"previous_state":{"type":"object","description":"Contains the state of the role before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the role."},"added":{"type":"array","description":"An array of permissions that were added to the role.","items":{"type":"string"}},"removed":{"type":"array","description":"An array of permissions that were removed from the role.","items":{"type":"string"}}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"BlockReasonNullable":{"title":"Block reason","description":"Block reason data","type":"object","nullable":true,"properties":{"reason_id":{"format":"int32","type":"integer"},"icon_type":{"format":"int32","type":"integer","enum":[0,1]},"icon_id":{"format":"int32","type":"integer"},"label":{"type":"string","minLength":1,"maxLength":250},"color":{"type":"string"},"with_cards":{"format":"int32","type":"integer","enum":[0,1]},"with_date":{"format":"int32","type":"integer","enum":[0,1]},"with_users":{"format":"int32","type":"integer","enum":[0,1]},"availability":{"format":"int32","type":"integer","enum":[0,1,2]},"is_enabled":{"format":"int32","type":"integer","enum":[0,1]}}},"DiscardReason":{"title":"Discard reason","description":"Discard reason data.","type":"object","properties":{"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of the discard reason."},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The **unique** label (i.e. the name) assigned to the discard reason."},"availability":{"format":"int32","type":"integer","description":"The availability level of the discard reason.\n\nA value of `0` represents **On-demand**, meaning the discard reason can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the discard reason is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the discard reason is automatically added to all boards across all workspaces. Once a discard reason's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the discard reason is enabled.","enum":[0,1],"default":1}}},"Sticker":{"title":"Sticker","description":"Sticker data.\n","type":"object","properties":{"sticker_id":{"format":"int32","type":"integer","description":"The ID of the sticker."},"icon_type":{"format":"int32","type":"integer","enum":[0,1],"description":"The type of icon associated with the sticker. `0` for system icon, `1` for user-defined icon."},"icon_id":{"format":"int32","type":"integer","description":"The ID of the icon used for the sticker."},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The name or label of the sticker."},"color":{"type":"string","description":"The color of the sticker, represented as a hexadecimal string."},"availability":{"format":"int32","type":"integer","enum":[0,1,2],"description":"The availability level of the sticker:\n- `0`: On-demand (manually added\/removed from boards)\n- `1`: Auto (automatically added to new boards)\n- `2`: Global (added to all boards across all workspaces)\n"},"is_enabled":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the sticker is enabled (`1`) or disabled (`0`)."},"board_ids":{"type":"array","items":{"type":"object","properties":{"board_id":{"format":"int32","type":"integer"}}},"description":"(expandable) An array of board IDs where the sticker is available."},"board_count":{"type":"array","items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"}}},"description":"(expandable) The total number of boards where the sticker is available."},"card_count":{"type":"array","items":{"type":"object","properties":{"count":{"format":"int32","type":"integer"}}},"description":"(expandable) The total number of cards where the sticker is assigned."},"business_rules":{"type":"array","items":{"type":"object","properties":{"rule_id":{"format":"int32","type":"integer"},"name":{"type":"string"}}},"description":"(expandable) An array of business rules associated with the sticker."},"arrival_rule_ids":{"type":"array","items":{"type":"object","properties":{"rule_id":{"format":"int32","type":"integer"}}},"description":"(expandable) An array of arrival rule IDs linked to the sticker."},"arrival_rule_count":{"type":"object","properties":{"count":{"format":"int32","type":"integer"}},"description":"(expandable) The total number of arrival rules linked to the sticker."},"departure_rule_ids":{"type":"array","items":{"type":"object","properties":{"rule_id":{"format":"int32","type":"integer"}}},"description":"(expandable) An array of departure rule IDs linked to the sticker."},"departure_rule_count":{"type":"object","properties":{"count":{"format":"int32","type":"integer"}},"description":"(expandable) The total number of departure rules linked to the sticker."},"template_ids":{"type":"array","items":{"type":"object","properties":{"template_id":{"format":"int32","type":"integer"}}},"description":"(expandable) An array of template IDs where the sticker is used."},"template_count":{"type":"object","properties":{"count":{"format":"int32","type":"integer"}},"description":"(expandable) The total number of templates where the sticker is used."}}},"Team":{"title":"Team","description":"Team data","type":"object","properties":{"team_id":{"description":"The unique identifier of the team.","format":"int32","type":"integer"},"name":{"description":"The name of the team.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the team.","type":"string"}}},"TeamHistoryEvent":{"title":"Team history event","description":"Team history event data","type":"object","properties":{"history_id":{"description":"The unique identifier of a history event for a team.","format":"int32","type":"integer"},"team_id":{"description":"The ID of the team.","format":"int32","type":"integer"},"event_type":{"description":"The type of the history event.","type":"string","enum":["created","updated","deleted","added_to_board","change_role_for_board","removed_from_board","user_added_to_team","user_removed_from_team","user_added_to_team_managers","user_removed_from_team_managers","added_to_dashboard_page","change_permissions_for_dashboard_page","removed_from_dashboard_page"]},"user_id":{"description":"The ID of the user who performed the action on the team.","format":"int32","type":"integer"},"details":{"description":"Contains detailed information about the changes made to the team.","type":"object"},"time":{"description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","type":"string","format":"date-time","example":"2025-06-10T00:00:00+00:00"}}},"Tag":{"title":"Tag","description":"Tag data.","type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The unique identifier of the tag."},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The **unique** label (i.e. the name) assigned to the tag."},"color":{"type":"string","description":"The color of the tag in hexadecimal format.","example":"eceff1","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the tag.\n\nA value of `0` represents **On-demand**, meaning the tag can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the tag is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the tag is automatically added to all boards across all workspaces. Once a tag's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the tag is enabled.","enum":[0,1],"default":1}}},"OutcomeTag":{"title":"OutcomeTag","description":"Outcome tag data.","type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome tag."},"label":{"type":"string","minLength":1,"maxLength":250,"description":"The label (i.e. the name) assigned to the outcome tag."},"outcome_ids":{"description":"Array of outcomes associated with this tag (each with outcome_id). Present when expanded via the expand parameter.","type":"array","items":{"type":"object","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."}}}},"outcome_count":{"description":"The number of outcomes associated with this tag. Present when expanded via the expand parameter.","type":"object","properties":{"count":{"format":"int32","type":"integer"}}}}},"OutcomeTagAndLabel":{"title":"OutcomeTagAndLabel","description":"Outcome tag create data.","type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome tag."},"label":{"type":"string","description":"The label (i.e. the name) assigned to the outcome tag.","minLength":1,"maxLength":250}}},"Outcome":{"title":"Outcome","description":"Outcome data.","type":"object","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."},"card_id":{"format":"int32","type":"integer","description":"The card this outcome is attached to, if any."},"field_id":{"format":"int32","type":"integer","description":"Custom field ID, if applicable."},"rule_id":{"format":"int32","type":"integer","description":"Calculated rule ID for automatic outcome, if applicable."},"name":{"type":"string","maxLength":255,"description":"The name of the outcome."},"operator":{"type":"string","enum":["or_less","or_more"],"description":"The operator for the outcome (or_less or or_more)."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The user ID of the outcome owner."},"prefix":{"type":"string","maxLength":250,"description":"Prefix for display."},"suffix":{"type":"string","maxLength":250,"description":"Suffix for display."},"starting_time":{"type":"string","format":"date-time","description":"The starting time for the outcome."},"target_time":{"type":"string","format":"date-time","description":"The target time for the outcome."},"current_value_since":{"type":"string","format":"date-time","description":"When the current value was last set."},"starting_value":{"type":"number","format":"double","description":"Starting value."},"target_value":{"type":"number","format":"double","description":"Target value."},"current_value":{"type":"number","format":"double","description":"Current value."},"comment":{"type":"string","description":"Comment."},"starting_value_formula":{"type":"string","description":"Formula for starting value, if used."},"target_value_formula":{"type":"string","description":"Formula for target value, if used."},"current_value_formula":{"type":"string","description":"Formula for current value, if used."},"weight":{"format":"int32","type":"integer","description":"Weight of the outcome."},"created_by_user_id":{"format":"int32","type":"integer","description":"User who created the outcome."},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp."},"checkpoints":{"type":"array","description":"Present when expanded via the expand parameter."},"values":{"type":"array","description":"Present when expanded via the expand parameter."},"links_to_cards":{"type":"array","description":"Present when expanded via the expand parameter."},"links_to_outcomes":{"type":"array","description":"Present when expanded via the expand parameter."},"links_from_outcomes":{"type":"array","description":"Present when expanded via the expand parameter."},"tag_ids":{"type":"array","description":"Present when expanded via the expand parameter."},"usage":{"type":"object","description":"Present when expanded via the expand parameter."}}},"OutcomeId":{"title":"Outcome","description":"Outcome data. When returned by GET by id, outcome_id is omitted (the id is in the path).","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The card this outcome is attached to, if any."},"field_id":{"format":"int32","type":"integer","description":"Custom field ID, if applicable."},"rule_id":{"format":"int32","type":"integer","description":"Calculated rule ID for automatic outcome, if applicable."},"name":{"type":"string","maxLength":255,"description":"The name of the outcome."},"operator":{"type":"string","enum":["or_less","or_more"],"description":"The operator for the outcome (or_less or or_more)."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The user ID of the outcome owner."},"prefix":{"type":"string","maxLength":250,"description":"Prefix for display."},"suffix":{"type":"string","maxLength":250,"description":"Suffix for display."},"starting_time":{"type":"string","format":"date-time","description":"The starting time for the outcome."},"target_time":{"type":"string","format":"date-time","description":"The target time for the outcome."},"current_value_since":{"type":"string","format":"date-time","description":"When the current value was last set."},"starting_value":{"type":"number","format":"double","description":"Starting value."},"target_value":{"type":"number","format":"double","description":"Target value."},"current_value":{"type":"number","format":"double","description":"Current value."},"comment":{"type":"string","description":"Comment."},"starting_value_formula":{"type":"string","description":"Formula for starting value, if used."},"target_value_formula":{"type":"string","description":"Formula for target value, if used."},"current_value_formula":{"type":"string","description":"Formula for current value, if used."},"starting_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the initial value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the starting value, the value will be set to `null`.\n"},"target_value_predefined_formula_type":{"format":"int32","type":"number","description":"The formula type for calculating the target value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the target value, the value will be set to `null`.\n"},"current_value_predefined_formula_type":{"format":"int32","type":"number","description":"The formula type for calculating the current value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the current value, the value will be set to `null`.\n"},"weight":{"format":"int32","type":"integer","description":"Weight of the outcome."},"created_by_user_id":{"format":"int32","type":"integer","description":"User who created the outcome."},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp."}}},"OutcomePatch":{"title":"Outcome","description":"Outcome","allOf":[{"type":"object","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."}}},{"$ref":"#\/components\/schemas\/OutcomeId"}]},"Milestone":{"title":"Milestone","description":"Milestone data.","type":"object","properties":{"milestone_id":{"format":"int32","type":"integer","description":"The unique identifier of the milestone."},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the milestone. `0` represents a system icon, while `1` represents a user-defined icon.","enum":[0,1],"default":0},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the milestone.","default":0},"label":{"type":"string","description":"The **unique** name assigned to the milestone.","minLength":1,"maxLength":250},"description":{"type":"string","description":"A description of the milestone.","default":null},"color":{"type":"string","description":"The color of the milestone in hexadecimal format.","default":""},"availability":{"format":"int32","type":"integer","description":"The availability level of the milestone.\n\nA value of `0` represents **On-demand**, meaning the milestone can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the milestone is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the milestone is automatically added to all boards across all workspaces. Once a milestone's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the milestone is enabled.","enum":[0,1],"default":1},"date":{"type":"string","format":"date","description":"The date for which the milestone is scheduled in `YYYY-MM-DD` format.","example":"2025-01-01"}}},"CustomFieldDataCommon":{"title":"Custom Field","description":"Custom field data.","type":"object","properties":{"name":{"type":"string","description":"The **unique** name of the custom field.","minLength":1,"maxLength":250},"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"type":{"type":"string","description":"The type of the custom field.","enum":["single_line_text","multi_line_text","number","date","link","dropdown","contributor","file","vote","card_picker","calculated_number","calculated_date"]},"is_immutable":{"format":"int32","type":"integer","description":"Controls whether the value of this custom field can be changed after it has first been set.","enum":[0,1],"default":0},"is_always_present":{"format":"int32","type":"integer","description":"Controls whether this custom field must always be present on all cards.","enum":[0,1],"default":0},"all_properties_are_locked":{"format":"int32","type":"integer","description":"Controls whether the custom field properties are locked and cannot be changed per board.","enum":[0,1],"default":0},"availability":{"format":"int32","type":"integer","description":"The availability level of the custom field.\n\nA value of `0` represents **On-demand**, meaning the custom field can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the custom field is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the custom field is automatically added to all boards across all workspaces. Once a custom field's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the custom field is enabled.","enum":[0,1],"default":1},"category_id":{"format":"int32","type":"integer","description":"The unique identifier of the category to which the custom field belongs. If this is set to `null`, the category will be **None**.","nullable":true,"default":null}}},"CustomFieldDataSingleLine":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Single-Line Text","description":"Custom field data - single-line text.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["single_line_text"]},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldDataSingleLineWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataSingleLine"}]},"CustomFieldDataMultiLine":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Multi-Line Text","description":"Custom field data - multi-line text.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["multi_line_text"]},"value_is_rich_text":{"format":"int32","type":"integer","description":"Controls whether the value of the custom field should be rendered as HTML.","enum":[0,1],"default":0},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","enum":[0,1],"default":0},"default_value":{"description":"The default value of the custom field.","type":"string"}}}]},"CustomFieldDataMultiLineWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataMultiLine"}]},"CustomFieldDataNumber":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Number","description":"Custom field data - number.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["number"]},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display after the custom field value.","minLength":1,"maxLength":250},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0},"default_value":{"format":"double","type":"number","description":"The default value of the custom field.","default":null,"nullable":true}}}]},"CustomFieldDataNumberWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataNumber"}]},"CustomFieldDataDate":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Date","description":"Custom field data - date.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["date"]},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_with_time":{"format":"int32","type":"integer","description":"Controls whether the custom field value should include time information.","enum":[0,1],"default":0},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"format":"date","type":"string","description":"The default value of the custom field on a board level.","default":null,"nullable":true}}}]},"CustomFieldDataDateWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataDate"}]},"CustomFieldDataLink":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Link","description":"Custom field data - link.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["link"]},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldDataLinkWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataLink"}]},"CustomFieldDataDropdown":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Dropdown","description":"Custom field data - dropdown.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["dropdown"]},"allowed_values_are_locked":{"format":"int32","type":"integer","description":"Determines whether the allowed values of the custom field are locked and cannot be changed on a board level.","enum":[0,1],"default":0},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","enum":[0,1],"default":0},"allowed_values":{"type":"array","description":"The allowed values of the custom field.","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","description":"The value of the allowed value.","minLength":1,"maxLength":250},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value. Multiple allowed values can be set as default.","enum":[0,1],"default":0}}}}}}]},"CustomFieldDataDropdownWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataDropdown"}]},"CustomFieldDataContributor":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Contributor","description":"Custom field data - contributor.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["contributor"]},"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1}}}]},"CustomFieldDataContributorWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataContributor"}]},"CustomFieldDataFile":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - File","description":"Custom field data - file.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["file"]},"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"CustomFieldDataFileWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataFile"}]},"CustomFieldDataVote":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Vote","description":"Custom field data - vote.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["vote"]},"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"CustomFieldDataVoteWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataVote"}]},"CustomFieldDataCardPicker":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Card Picker","description":"Custom field data - card picker.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["card_picker"]},"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":1}}}]},"CustomFieldDataCardPickerWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataCardPicker"}]},"CustomFieldDataCalculatedNumber":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Calculated Number","description":"Custom field data - calculated number.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["calculated_number"]},"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"sum(1,2)"}}}]},"CustomFieldDataCalculatedNumberWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedNumber"}]},"CustomFieldDataCalculatedDate":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldDataCommon"},{"type":"object","title":"Custom Field - Calculated Date","description":"Custom field data - calculated date.","properties":{"type":{"type":"string","description":"The type of the custom field.","enum":["calculated_date"]},"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"add_days(card.deadline(),1)"}}}]},"CustomFieldDataCalculatedDateWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the custom field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CustomFieldDataCalculatedDate"}]},"CustomFieldAllowedValue":{"title":"Custom Field Allowed Value","description":"Represents an allowed value for a custom field of type dropdown.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the allowed value in the dropdown list. `0` represents the first position."},"is_enabled":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the allowed value is enabled.\n - `0`: Disabled\n - `1`: Enabled"},"is_default":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the allowed value is selected by default.\n - `0`: Not default\n - `1`: Default"},"value":{"type":"string","minLength":1,"maxLength":250,"description":"The actual value of the allowed option in the dropdown."}}},"CustomFieldAllowedValueBatchOperation":{"title":"Custom field dropdown value data","description":"Custom field dropdown value data","type":"object","properties":{"value_id":{"format":"int32","type":"integer"},"position":{"format":"int32","type":"integer"},"is_enabled":{"format":"int32","type":"integer","enum":[0,1]},"is_default":{"format":"int32","type":"integer","enum":[0,1]},"value":{"type":"string","minLength":1,"maxLength":250}}},"CustomFieldCreateRequestCommon":{"description":"Custom field data.","required":["name","type"],"type":"object","discriminator":{"propertyName":"type","mapping":{"single_line_text":"#\/components\/schemas\/CustomFieldCreateRequestSingleLine","multi_line_text":"#\/components\/schemas\/CustomFieldCreateRequestMultiLine","number":"#\/components\/schemas\/CustomFieldCreateRequestNumber","date":"#\/components\/schemas\/CustomFieldCreateRequestDate","link":"#\/components\/schemas\/CustomFieldCreateRequestLink","dropdown":"#\/components\/schemas\/CustomFieldCreateRequestDropdown","contributor":"#\/components\/schemas\/CustomFieldCreateRequestContributor","file":"#\/components\/schemas\/CustomFieldCreateRequestFile","vote":"#\/components\/schemas\/CustomFieldCreateRequestVote","card_picker":"#\/components\/schemas\/CustomFieldCreateRequestCardPicker"}},"properties":{"name":{"type":"string","description":"The **unique** name of the custom field.","minLength":1,"maxLength":250},"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"type":{"type":"string","description":"The type of the custom field.","enum":["single_line_text","multi_line_text","number","date","link","dropdown","contributor","file","vote","card_picker","calculated_number","calculated_date"]},"is_immutable":{"format":"int32","type":"integer","description":"Controls whether the value of this custom field can be changed after it has first been set.","enum":[0,1],"default":0},"is_always_present":{"description":"Controls whether this custom field must always be present on all cards.","format":"int32","type":"integer","enum":[0,1],"default":0},"all_properties_are_locked":{"format":"int32","type":"integer","description":"Controls whether the custom field properties are locked and cannot be changed per board.","enum":[0,1],"default":0},"availability":{"format":"int32","type":"integer","description":"The availability level of the custom field.\n\nA value of `0` represents **On-demand**, meaning the custom field can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the custom field is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the custom field is automatically added to all boards across all workspaces. Once a custom field's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the custom field is enabled.","enum":[0,1],"default":1},"category_id":{"format":"int32","type":"integer","description":"The unique identifier of the category to which the custom field belongs. If this is set to `null`, the category will be **None**.","nullable":true,"default":null}}},"CustomFieldCreateRequestSingleLine":{"title":"Create single-line text custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - single-line text.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldCreateRequestMultiLine":{"title":"Create multi-line text custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - multi-line text.","properties":{"value_is_rich_text":{"format":"int32","type":"integer","description":"Controls whether the value of the custom field should be rendered as HTML.","enum":[0,1],"default":0},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","enum":[0,1],"default":0},"default_value":{"description":"The default value of the custom field.","type":"string"}}}]},"CustomFieldCreateRequestNumber":{"title":"Create number custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - number.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display after the custom field value.","minLength":1,"maxLength":250},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0},"default_value":{"format":"double","type":"number","description":"The default value of the custom field.","default":null,"nullable":true}}}]},"CustomFieldCreateRequestDate":{"title":"Create custom field of type date","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - date.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldCreateRequestLink":{"title":"Create link custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - link.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldCreateRequestDropdown":{"title":"Create dropdown custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - dropdrown.","properties":{"allowed_values_are_locked":{"format":"int32","type":"integer","description":"Determines whether the allowed values of the custom field are locked and cannot be changed on a board level.","enum":[0,1],"default":0},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","enum":[0,1],"default":0},"allowed_values":{"type":"array","description":"The allowed values of the custom field.","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","description":"The value of the allowed value.","minLength":1,"maxLength":250},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value. Multiple allowed values can be set as default.","enum":[0,1],"default":0}}}}}}]},"CustomFieldCreateRequestContributor":{"title":"Create contributor custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - contributor.","properties":{"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1}}}]},"CustomFieldCreateRequestFile":{"title":"Create file custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - file.","properties":{"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"CustomFieldCreateRequestVote":{"title":"Create vote custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - vote.","properties":{"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"CustomFieldCreateRequestCardPicker":{"title":"Create card picker custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - card picker.","properties":{"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":1}}}]},"CustomFieldAllowedValueCreateRequest":{"title":"Create Allowed Values for Dropdown Custom Field","description":"Data to create one or more allowed values for a custom field of type `dropdown`.","type":"array","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","minLength":1,"maxLength":250,"description":"The value of the allowed value."},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1],"default":0},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value. Multiple allowed values can be set as default.","enum":[0,1]},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."}}}},"CustomFieldCreateRequestCalculatedNumber":{"title":"Create calculated number custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - calculated number.","required":["formula"],"properties":{"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"sum(1,2)"}}}]},"CustomFieldCreateRequestCalculatedDate":{"title":"Create calculated date custom field","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldCreateRequestCommon"},{"type":"object","description":"Custom field data - calculated date.","required":["formula"],"properties":{"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"add_days(card.deadline(),1)"}}}]},"CustomFieldUpdateRequestCommon":{"description":"Custom field data.","type":"object","properties":{"name":{"type":"string","description":"The **unique** name of the custom field.","minLength":1,"maxLength":250},"color":{"type":"string","description":"The color of the custom field in hexadecimal format.","default":""},"type":{"type":"string","description":"The type of the custom field.","enum":["single_line_text","multi_line_text","number","date","link","dropdown","contributor","file","vote","card_picker","calculated_number","calculated_date"]},"is_immutable":{"format":"int32","type":"integer","description":"Controls whether the value of this custom field can be changed after it has first been set.","enum":[0,1],"default":0},"is_always_present":{"description":"Controls whether this custom field must always be present on all cards.","format":"int32","type":"integer","enum":[0,1],"default":0},"all_properties_are_locked":{"format":"int32","type":"integer","description":"Controls whether the custom field properties are locked and cannot be changed per board.","enum":[0,1],"default":0},"availability":{"format":"int32","type":"integer","description":"The availability level of the custom field.\n\nA value of `0` represents **On-demand**, meaning the custom field can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the custom field is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the custom field is automatically added to all boards across all workspaces. Once a custom field's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the custom field is enabled.","enum":[0,1],"default":1},"category_id":{"format":"int32","type":"integer","description":"The unique identifier of the category to which the custom field belongs. If this is set to `null`, the category will be **None**.","nullable":true,"default":null}}},"CustomFieldUpdateRequestSingleLine":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - single-line text.","properties":{"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","default":1,"enum":[1,2]},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"suffix":{"type":"string","description":"A suffix to display before the custom field value.","minLength":1,"maxLength":250,"default":""},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldUpdateRequestMultiLine":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - multi-line text.","properties":{"value_is_rich_text":{"format":"int32","type":"integer","description":"Controls whether the value of the custom field should be rendered as HTML.","enum":[0,1],"default":0},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","enum":[0,1],"default":0},"default_value":{"description":"The default value of the custom field.","type":"string"}}}]},"CustomFieldUpdateRequestNumber":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - number.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"prefix":{"type":"string","description":"A prefix to display before the custom field value.","minLength":1,"maxLength":250},"suffix":{"type":"string","description":"A suffix to display after the custom field value.","minLength":1,"maxLength":250},"uniqueness_of_values":{"format":"int32","type":"integer","description":"The level of uniqueness of the custom field's value.\n\nA value of `0` represents **Any value**, meaning the custom field value doesn't have to be unique.\n\nA value of `1` represents **Unique value per board**, meaning the custom field value must be unique on a board level.\n\nA value of `2` represents **Unique value across all boards**, meaning the custom field value must be unique across all boards to which the custom field is added.","default":0,"enum":[0,1,2]},"min_value":{"format":"double","type":"number","description":"The minimum of the range allowed for the custom field value.","default":null,"nullable":true},"max_value":{"format":"double","type":"number","description":"The maximum of the range allowed for the custom field value.","default":null,"nullable":true},"decimal_places":{"format":"int32","type":"integer","description":"The number of decimal places allowed for the custom field value.","default":0,"minimum":0,"maximum":8},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0},"default_value":{"format":"double","type":"number","description":"The default value of the custom field.","default":null,"nullable":true}}}]},"CustomFieldUpdateRequestDate":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - date.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldUpdateRequestLink":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - link.","properties":{"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"value_is_required":{"format":"int32","type":"integer","description":"Controls whether the custom field must always have a value for the cards to which it's applied.","default":0,"enum":[0,1]},"default_value":{"type":"string","description":"The default value of the custom field.","default":"","minLength":1,"maxLength":250}}}]},"CustomFieldUpdateRequestDropdown":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - dropdrown.","properties":{"allowed_values_are_locked":{"format":"int32","type":"integer","description":"Determines whether the allowed values of the custom field are locked and cannot be changed on a board level.","enum":[0,1],"default":0},"display_width":{"description":"The display width of the custom field in the UI. When set to `1` the custom field will take all of the available width. When set to `2` the custom field will take half of the available width.","format":"int32","type":"integer","enum":[1,2],"default":1},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of allowed values that can be selected per card for this custom field on a board level.","default":0},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of allowed values that can be selected per card for this custom field on a board level.","default":1},"allow_other_value":{"format":"int32","type":"integer","description":"Controls whether the custom field will allow users to manually add additional allowed values on a board level.","enum":[0,1],"default":0}}}]},"CustomFieldUpdateRequestContributor":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - contributor.","properties":{"min_number_of_contributors":{"format":"int32","type":"integer","description":"The minimum number of users, designated as contributors, that can be selected for the custom field on each card.","default":0},"max_number_of_contributors":{"format":"int32","type":"integer","description":"The maximum number of users, designated as contributors, that can be selected for the custom field on each card.","default":1}}}]},"CustomFieldUpdateRequestFile":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - file.","properties":{"min_number_of_files":{"format":"int32","type":"integer","description":"The minimum number of files that can be attached to the custom field per card.","default":0},"max_number_of_files":{"format":"int32","type":"integer","description":"The maximum number of files that can be attached to the custom field per card.","default":1}}}]},"CustomFieldUpdateRequestVote":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - vote.","properties":{"comment_is_required":{"format":"int32","type":"integer","description":"Controls whether a user must include a comment in order to vote.","default":0,"enum":[0,1]}}}]},"CustomFieldUpdateRequestCardPicker":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - card picker.","properties":{"search":{"type":"string","description":"A search query to filter the cards that can be selected for the custom field. Due to the query's compelxity it's best to add it through the UI."},"min_number_of_selected_cards":{"format":"int32","type":"integer","description":"The minimum number of cards that can be selected for the custom field per card.","default":0},"max_number_of_selected_cards":{"format":"int32","type":"integer","description":"The maximum number of cards that can be selected for the custom field per card.","default":1}}}]},"CustomFieldUpdateRequestCalculatedNumber":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - calculated number.","properties":{"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"sum(1,2)"}}}]},"CustomFieldUpdateRequestCalculatedDate":{"allOf":[{"$ref":"#\/components\/schemas\/CustomFieldUpdateRequestCommon"},{"type":"object","description":"Custom field data - calculated date.","properties":{"formula":{"type":"string","description":"The formula used to calculate the value of the custom field.","example":"add_days(card.deadline(),1)"}}}]},"CustomFieldAllowedValueUpdateRequest":{"title":"Update Allowed Values for Dropdown Custom Field","description":"Data to update one or more allowed values for a dropdown custom field.","type":"array","items":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value to be updated."},"value":{"type":"string","minLength":1,"maxLength":250,"description":"The value of the allowed value."},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1],"default":0},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value. Multiple allowed values can be set as default.","enum":[0,1]},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."}}}},"CustomFieldAllowedValueDeleteRequest":{"title":"Delete Allowed Values for Dropdown Custom Field","description":"Data to delete one or more allowed values for a dropdown custom field. Optionally, specify a replacement value for cards using the deleted value.","type":"array","items":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value to be deleted."},"replace_with_value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value that will replace the deleted one. If not provided, the allowed value will be deleted without replacement."}}}},"CustomFieldAllowedValueBatchOperationsResponse":{"title":"Batch Operations Response for Dropdown Custom Field Allowed Values","description":"Represents the response data for batch operations (create, update, or delete) performed on allowed values for a dropdown custom field.","type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value."},"value":{"type":"string","minLength":1,"maxLength":250,"description":"The actual value of the dropdown option."},"is_enabled":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the value is enabled.\n - `0`: Disabled\n - `1`: Enabled"},"is_default":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the value is selected by default.\n - `0`: Not default\n - `1`: Default"},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the first position."}}},"DataFieldDataCommon":{"title":"Data Field","description":"Data field data.","type":"object","properties":{"name":{"type":"string","description":"The unique name of the data field.","minLength":1,"maxLength":250},"color":{"type":"string","description":"The color of the data field in hexadecimal format.","default":"eceff1"},"type":{"type":"string","description":"The type of the data field.","enum":["single_line_text","number","date","dropdown","contributor","calculated_number"]},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the data field is enabled.","enum":[0,1],"default":1}}},"DataFieldDataSingleLine":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Single-Line Text","description":"Data field data - single-line text.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["single_line_text"]}}}]},"DataFieldDataSingleLineWithFieldId":{"allOf":[{"type":"object","properties":{"data_field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataSingleLine"}]},"DataFieldDataNumber":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Number","description":"Data field data - number.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["number"]}}}]},"DataFieldDataNumberWithFieldId":{"allOf":[{"type":"object","properties":{"data_field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataNumber"}]},"DataFieldDataDate":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Date","description":"Data field data - date.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["date"]}}}]},"DataFieldDataDateWithFieldId":{"allOf":[{"type":"object","properties":{"data_field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataDate"}]},"DataFieldDataDropdownWithoutAllowedValues":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Dropdown","description":"Data field data - dropdown.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["dropdown"]}}}]},"DataFieldDataDropdown":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Dropdown","description":"Data field data - dropdown.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["dropdown"]},"allowed_values":{"type":"array","description":"The allowed values of the data field.","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","description":"The value of the allowed value.","minLength":1,"maxLength":250},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value. Multiple allowed values can be set as default.","enum":[0,1],"default":0}}}}}}]},"DataFieldDataDropdownWithFullAllowedValues":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Dropdown","description":"Data field data - dropdown.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["dropdown"]},"allowed_values":{"type":"array","description":"The allowed values of the data field.","items":{"type":"object","title":"Allowed value","properties":{"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1],"default":1},"value":{"type":"string","description":"The value of the allowed value.","minLength":1,"maxLength":250},"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value."}}}}}}]},"DataFieldDataDropdownWithoutAllowedValuesWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataDropdownWithoutAllowedValues"}]},"DataFieldDataDropdownWithFullAllowedValuesAndFieldId":{"allOf":[{"type":"object","properties":{"data_field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataDropdownWithFullAllowedValues"}]},"DataFieldDataDropdownWithFieldId":{"allOf":[{"type":"object","properties":{"data_field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataDropdown"}]},"DataFieldDataContributor":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Contributor","description":"Data field data - contributor.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["contributor"]}}}]},"DataFieldDataContributorWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataContributor"}]},"DataFieldDataCalculatedNumber":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldDataCommon"},{"type":"object","title":"Data Field - Calculated Number","description":"Data field data - calculated number.","properties":{"type":{"type":"string","description":"The type of the data field.","enum":["calculated_number"]},"formula_type":{"type":"string","description":"The formula type used to calculate the value of the data field.","enum":["min","max","sum","average"]}}}]},"DataFieldDataCalculatedNumberWithFieldId":{"allOf":[{"type":"object","properties":{"field_id":{"description":"The unique identifier of the data field.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/DataFieldDataCalculatedNumber"}]},"DataFieldCreateRequestCommon":{"description":"Data field data.","required":["name","type"],"type":"object","discriminator":{"propertyName":"type","mapping":{"single_line_text":"#\/components\/schemas\/CustomFieldCreateRequestSingleLine","number":"#\/components\/schemas\/CustomFieldCreateRequestNumber","date":"#\/components\/schemas\/CustomFieldCreateRequestDate","dropdown":"#\/components\/schemas\/CustomFieldCreateRequestDropdown","contributor":"#\/components\/schemas\/CustomFieldCreateRequestContributor","calculated_number":"#\/components\/schemas\/DataFieldCreateRequestCalculatedNumber"}},"properties":{"name":{"type":"string","description":"The **unique** name of the data field.","minLength":1,"maxLength":250},"description":{"type":"string","description":"A description of the data field.","minLength":1,"maxLength":65535,"default":""},"color":{"type":"string","description":"The color of the data field in hexadecimal format.","default":"eceff1"},"type":{"type":"string","description":"The type of the data field.","enum":["single_line_text","number","date","dropdown","contributor","calculated_number"]},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the data field is enabled.","enum":[0,1],"default":1}}},"DataFieldCreateRequestSingleLine":{"title":"Create single-line text data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - single-line text."}]},"DataFieldCreateRequestNumber":{"title":"Create number data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - number."}]},"DataFieldCreateRequestDate":{"title":"Create date data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - date."}]},"DataFieldCreateRequestDropdown":{"title":"Create dropdown data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - dropdrown.","properties":{"allowed_values":{"type":"array","description":"The allowed values of the dropdown data field.","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","description":"The value of the allowed value.","minLength":1,"maxLength":250},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is enabled.","enum":[0,1],"default":0},"reference":{"type":"string","description":"A reference to the allowed value that can be used to identify it in other contexts.","minLength":1}}}}}}]},"DataFieldCreateRequestContributor":{"title":"Create contributor data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - contributor."}]},"DataFieldAllowedValueCreateRequest":{"title":"Create Allowed Values for Dropdown Data Field","description":"Data to create one or more allowed values for a data field of type `dropdown`.","type":"array","items":{"type":"object","title":"Allowed value","properties":{"value":{"type":"string","minLength":1,"maxLength":250,"description":"The value of the allowed value."},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1],"default":0},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is a default value.","enum":[0,1]},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."}}}},"DataFieldCreateRequestCalculatedNumber":{"title":"Create calculated number data field","allOf":[{"$ref":"#\/components\/schemas\/DataFieldCreateRequestCommon"},{"type":"object","description":"Data field data - calculated number.","required":["formula_type"],"properties":{"formula_type":{"type":"string","description":"The formula used to calculate the value of the data field.","enum":["min","max","sum","average"],"example":"sum"}}}]},"DataFieldUpdateRequestCommon":{"description":"Data field data.","type":"object","properties":{"name":{"type":"string","description":"The unique name of the data field.","minLength":1,"maxLength":250},"description":{"type":"string","description":"A description of the data field.","minLength":1,"maxLength":65535,"default":""},"color":{"type":"string","description":"The color of the data field in hexadecimal format.","default":"eceff1"},"is_enabled":{"format":"int32","type":"integer","description":"Controls whether the data field is enabled.","enum":[0,1],"default":1}}},"DataFieldUpdateRequestSingleLine":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update single-line text data field"}]},"DataFieldUpdateRequestNumber":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update number data field"}]},"DataFieldUpdateRequestDate":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update date data field"}]},"DataFieldUpdateRequestDropdown":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update dropdown data field","properties":{"values_to_create":{"description":"A list of allowed values to add.","type":"array","items":{"title":"Allowed value to create","type":"object","properties":{"value":{"description":"The value of the allowed value.","type":"string","minLength":1,"maxLength":250},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1]},"position":{"description":"The position of the value within the dropdown list. `0` represents the top-most position.","format":"int32","type":"integer"},"reference":{"type":"string","description":"A reference to the allowed value that can be used to identify it in other contexts.","minLength":1}}}},"values_to_update":{"description":"A list of allowed values to update.","type":"array","items":{"title":"Allowed value to update","type":"object","properties":{"value_id":{"description":"The unique identifier of the allowed value to be updated.","format":"int32","type":"integer"},"value":{"description":"The value of the allowed value.","type":"string","minLength":1,"maxLength":250},"is_enabled":{"description":"Determines whether the value is enabled.","format":"int32","type":"integer","enum":[0,1]},"position":{"format":"int32","type":"integer"}}}},"values_to_delete":{"description":"A list of value IDs to delete.","type":"array","items":{"format":"int32","type":"integer"}}}}]},"DataFieldUpdateRequestContributor":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update contributor data field"}]},"DataFieldUpdateRequestCalculatedNumber":{"allOf":[{"$ref":"#\/components\/schemas\/DataFieldUpdateRequestCommon"},{"type":"object","title":"Update calculated number data field","properties":{"formula_type":{"type":"string","description":"The formula type used to calculate the value of the data field of a workspace based on board values.","enum":["min","max","sum","average"],"example":"sum"}}}]},"DataFieldAllowedValueUpdateRequest":{"title":"Update Allowed Values for Dropdown Data Field","description":"Data to update one or more allowed values for a dropdown data field.","type":"array","items":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the allowed value to be updated."},"value":{"type":"string","minLength":1,"maxLength":250,"description":"The value of the allowed value."},"is_enabled":{"format":"int32","type":"integer","description":"Determines whether the value is enabled.","enum":[0,1],"default":0},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."}}}},"Cards":{"title":"Card","description":"Card data","type":"object","properties":{"card_id":{"description":"The unique identifier of the card.","format":"int32","type":"integer"},"custom_id":{"description":"A user-defined custom identifier of the card.","type":"string","minLength":1,"nullable":true},"board_id":{"description":"The ID of the board the card belongs to.","format":"int32","type":"integer"},"workflow_id":{"description":"The ID of the workflow the card belongs to.","format":"int32","type":"integer"},"title":{"description":"The title of the card.","type":"string"},"owner_user_id":{"description":"The ID of the user who owns the card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The ID of the type assigned to the card.","format":"int32","type":"integer","nullable":true},"color":{"description":"The color of the card.","type":"string"},"section":{"description":"The board section in which the card is currently located.","format":"int","type":"integer"},"column_id":{"description":"The ID of the column the card is currently in. Applicable for active cards only.","format":"int32","type":"integer"},"lane_id":{"description":"The ID of the lane the card is currently in. Applicable for active cards only.","format":"int32","type":"integer"},"position":{"description":"The position of the card in the column. `0` represents the first position.","format":"int32","type":"integer"}}},"Card":{"title":"Card","description":"Card data","type":"object","properties":{"card_id":{"description":"The unique identifier of the card.","format":"int32","type":"integer"},"custom_id":{"description":"A user-defined custom identifier of the card.","type":"string","minLength":1,"nullable":true},"board_id":{"description":"The ID of the board the card belongs to.","format":"int32","type":"integer"},"workflow_id":{"description":"The ID of the workflow the card belongs to.","format":"int32","type":"integer"},"title":{"description":"The title of the card.","type":"string"},"owner_user_id":{"description":"The ID of the user who owns the card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The ID of the type assigned to the card.","format":"int32","type":"integer","nullable":true},"color":{"description":"The color of the card.","type":"string"},"section":{"description":"The board section in which the card is currently located.","format":"int","type":"integer"},"column_id":{"description":"The ID of the column the card is currently in. Applicable for active cards only.","format":"int32","type":"integer"},"lane_id":{"description":"The ID of the lane the card is currently in. Applicable for active cards only.","format":"int32","type":"integer"},"last_column_id":{"description":"The id of the last column the card was in. Applicable for archived and discarded cards only.","format":"int32","type":"integer"},"last_lane_id":{"description":"The id of the last lane the card was in. Applicable for archived and discarded cards only.","format":"int32","type":"integer"},"position":{"description":"The position of the card in the column. `0` represents the first position.","format":"int32","type":"integer"},"description":{"description":"The description of the card.","type":"string"},"size":{"description":"The size assigned the card.","format":"double","type":"number","nullable":true},"priority":{"format":"int32","type":"integer","description":"Determines the card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","default":3,"minimum":1,"maximum":250,"nullable":true},"deadline":{"description":"The deadline of the card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"reporter":{"description":"The ID of the user who is the card's reporter (original creator).","type":"object","properties":{"type":{"description":"The type of the reporter user - internal or external.","type":"string"},"value":{"description":"The ID of the reporter user.","format":"int32","type":"integer"}}},"created_at":{"description":"The date and time when the card was created, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"revision":{"description":"The current revision number of the card.","format":"int32","type":"integer"},"last_modified":{"description":"The date and time when the card was last modified, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"in_current_position_since":{"description":"The date and time when the card was last moved to its current position, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"first_request_time":{"description":"The date and time when the card was first requested, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"first_start_time":{"description":"The date and time when the card was first started, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"first_end_time":{"description":"The date and time when the card was first ended, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"last_request_time":{"description":"The date and time when the card was last requested, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"last_start_time":{"description":"The date and time when the card was last started, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"last_end_time":{"description":"The date and time when the card was last ended, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"is_blocked":{"description":"Indicates whether the card is blocked.","format":"int32","type":"integer"},"block_reason":{"description":"Block reason data","type":"object","nullable":true,"properties":{"block_type":{"format":"int32","type":"integer"},"reason_id":{"description":"The ID of the block reason.","format":"int32","type":"integer"},"comment":{"description":"A comment left by the user when blocking the card.","type":"string"}}},"child_card_stats":{"description":"Details about the card's child items.","type":"object","properties":{"child_card_size_sum":{"description":"The total size of all child cards.","format":"int32","type":"integer"},"finished_bottom_child_card_size_sum":{"description":"The sum of the sizes of all completed child cards on the bottom-most level in the hierarchy under this parent card.","format":"int32","type":"integer"},"unfinished_bottom_child_card_size_sum":{"description":"The sum of the sizes of all unfinished child cards on the bottom-most level in the hierarchy under this parent card.","format":"int32","type":"integer"},"has_unfinished_child_cards":{"description":"Indicates whether the card has unfinished child cards.","type":"boolean"},"last_unfinished_child_card_deadline":{"description":"The deadline of the last unfinished child card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true}}},"finished_subtask_count":{"description":"The number of finished subtasks associated with the card.","format":"int32","type":"integer"},"unfinished_subtask_count":{"description":"The number of unfinished subtasks associated with the card.","format":"int32","type":"integer"},"custom_fields":{"description":"A list of card custom fields and their values.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLineWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumberWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDateWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLinkWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdownWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributorWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFileWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVoteWithFieldId"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPickerWithFieldId"}]}},"stickers":{"description":"A list of stickers associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardSticker"}},"tag_ids":{"description":"A list of tag IDs associated with the card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids":{"description":"A list of milestone IDs associated with the card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids":{"description":"A list of user IDs of co-owners of the card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids":{"description":"A list of user IDs of watchers of the card.","type":"array","items":{"format":"int32","type":"integer"}},"checked_column_checklist_items":{"description":"A list of checklist items associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardColumnChecklistItem"}},"annotations":{"description":"A list of annotations associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/Annotation"}},"attachments":{"description":"A list of attachments associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachment"}},"cover_image":{"description":"The cover image associated with the card.","$ref":"#\/components\/schemas\/CoverImageNullable"},"subtasks":{"description":"A list of subtasks associated with the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}},"linked_cards":{"description":"A list of linked cards associated with the card.","type":"array","items":{"title":"Linked Cards","type":"object","properties":{"card_id":{"description":"The ID of the linked card.","format":"int32","type":"integer"},"link_type":{"description":"The type of link between the cards.","type":"string","enum":["child","parent","relative","predecessor","successor"]}}}},"reference":{"description":"A reference to the card, which can be used to identify it in other contexts.","type":"string"}}},"CardInitiativeDetails":{"description":"Details specific to a work item of type initiative.","type":"object","properties":{"initiative_details":{"title":"Details for initiatives","type":"object","properties":{"track":{"type":"integer","format":"int32","description":"The number of the track in which the new card will be placed if it is created in a timeline workflow.","minimum":0},"has_manually_set_start_time":{"type":"integer","format":"int32","description":"Indicates whether the start time of the initiative has been manually set.","enum":[0,1],"default":0},"has_manually_set_end_time":{"type":"integer","format":"int32","description":"Indicates whether the end time of the initiative has been manually set.","enum":[0,1],"default":0},"planned_start_date_sync_type":{"type":"integer","format":"int32","description":"Specifies how the planned start date of the new card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_start_date` parameter.\n- `1`: The planned start date will be inherited as the earliest start date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned start date will be inherited from a child initiative or card.\n- `3`: The planned start date will be inherited from a child initiative or card, with adjustments for working days.\nUse this parameter to automatically sync the planned start date based on the dates of child items.\n","enum":[1,2,3],"nullable":true},"planned_start_date_sync_monday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Monday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_tuesday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Tuesday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_wednesday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Wednesday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_thursday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Thursday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_friday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Friday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_saturday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Saturday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date_sync_sunday_is_working_day":{"type":"integer","format":"int32","description":"Indicates whether Sunday is considered a working day when syncing the planned start date.","enum":[0,1],"default":1},"planned_start_date":{"type":"string","format":"date","description":"The planned start date of the initiative. Cannot be used together with `planned_start_date_sync_type`.","nullable":true},"planned_end_date_sync_type":{"type":"integer","format":"int32","description":"Specifies how the planned end date of the new card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_end_date` parameter.\n- `1`: The planned end date will be inherited as the latest end date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned end date will be inherited from a child initiative or card.\nUse this parameter to automatically sync the planned end date based on the dates of child items.\n","enum":[1,2],"nullable":true},"planned_end_date":{"type":"string","format":"date","description":"The planned end date of the initiative. Cannot be used together with `planned_end_date_sync_type`.","nullable":true},"actual_start_time":{"type":"string","format":"date-time","description":"The actual start time of the initiative, in `ISO 8601` format.","nullable":true},"actual_end_time":{"type":"string","format":"date-time","description":"The actual end time of the initiative, in `ISO 8601` format.","nullable":true}}}}},"CardRevisionCard":{"title":"Card Revision Card","description":"Represents the data of a specific revision of a card.","allOf":[{"$ref":"#\/components\/schemas\/CardRevision"}]},"CardRevisionInitiative":{"title":"Card Revision Initiative","description":"Represents the data of a specific revision of an initiative.","allOf":[{"$ref":"#\/components\/schemas\/CardRevision"},{"$ref":"#\/components\/schemas\/CardInitiativeDetails"}]},"CardRevision":{"title":"Card Revision","description":"Represents the data of a specific revision of a card.","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of the card."},"custom_id":{"type":"string","minLength":1,"nullable":true,"description":"A custom identifier for the card, if applicable."},"board_id":{"format":"int32","type":"integer","description":"The ID of the board to which the card belongs."},"workflow_id":{"format":"int32","type":"integer","description":"The ID of the workflow associated with the card."},"title":{"type":"string","description":"The title of the card."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the user assigned as the owner of the card, if applicable."},"type_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the card type, if applicable."},"color":{"type":"string","description":"The color assigned to the card, represented as a hexadecimal value."},"section":{"format":"int","type":"integer","description":"The section of the board where the card is located."},"column_id":{"format":"int32","type":"integer","description":"The ID of the column where the card is located."},"lane_id":{"format":"int32","type":"integer","description":"The ID of the lane where the card is located."},"position":{"format":"int32","type":"integer","description":"The position of the card within its column."},"description":{"type":"string","description":"The description of the card."},"size":{"format":"double","type":"number","description":"The size of the card."},"priority":{"format":"int32","type":"integer","default":3,"minimum":1,"maximum":250,"nullable":true,"description":"Determines the priority level of the card. \n - `1`: Critical priority \n - `2`: High priority \n - `3`: Average priority (default) \n - `4`: Low priority \n Values above `4` are considered as `Low` priority, and `null` is treated as `Average` priority."},"deadline":{"format":"date-time","type":"string","nullable":true,"description":"The deadline for completing the card, if applicable."},"reporter":{"type":"object","properties":{"type":{"type":"string","description":"The type of the reporter."},"value":{"format":"int32","type":"integer","description":"The ID of the reporter."}},"description":"Information about the reporter of the card."},"created_at":{"format":"date-time","type":"string","description":"The timestamp when the card was created."},"revision":{"format":"int32","type":"integer","description":"The revision number of the card."},"in_current_position_since":{"format":"date-time","type":"string","description":"The timestamp indicating when the card was moved to its current position."},"is_blocked":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the card is blocked (`1` for blocked, `0` for not blocked)."},"block_reason":{"$ref":"#\/components\/schemas\/CardBlockReason","description":"The reason for blocking the card, if applicable."},"child_card_stats":{"type":"object","description":"Statistics related to child cards of the card.","properties":{"child_card_size_sum":{"format":"int32","type":"integer","description":"The total size of all first-level child cards associated with the specified card."},"finished_bottom_child_card_size_sum":{"format":"int32","type":"integer","description":"The total size of all bottom-level child cards that have been completed."},"unfinished_bottom_child_card_size_sum":{"format":"int32","type":"integer","description":"The total size of all bottom-level child cards that are yet to be completed."},"has_unfinished_child_cards":{"type":"boolean","description":"Indicates whether there are any unfinished child cards for the specified card revision. Returns `true` if unfinished child cards exist, otherwise `false`."},"last_unfinished_child_card_deadline":{"format":"date-time","type":"string","nullable":true,"description":"The latest deadline among all unfinished child cards, if applicable."}}},"finished_subtask_count":{"format":"int32","type":"integer","description":"The number of subtasks that have been completed."},"unfinished_subtask_count":{"format":"int32","type":"integer","description":"The number of subtasks that are yet to be completed."},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachment"}},"custom_fields":{"description":"A list of card custom field values.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPicker"}]}},"stickers":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardSticker"}},"tag_ids":{"type":"array","description":"A list of tag IDs associated with the card.","items":{"format":"int32","type":"integer"}},"co_owner_ids":{"type":"array","description":"A list of user IDs assigned as co-owners of the card.","items":{"format":"int32","type":"integer"}},"watcher_ids":{"type":"array","description":"A list of user IDs watching the card.","items":{"format":"int32","type":"integer"}},"annotations":{"type":"array","description":"A list of annotations added to the card.","items":{"$ref":"#\/components\/schemas\/Annotation"}},"outcomes":{"type":"array","description":"A list of outcomes associated with the card.","items":{"$ref":"#\/components\/schemas\/CardOutcomeWithId"}},"subtasks":{"type":"array","description":"A list of subtasks associated with the card.","items":{"$ref":"#\/components\/schemas\/CardSubtaskWithId"}},"linked_cards":{"type":"array","description":"A list of cards linked to the card, along with their relationship type.","items":{"type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of the linked card."},"link_type":{"type":"string","description":"The type of relationship between the cards.","enum":["child","parent","relative","predecessor","successor"]}}}},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who made the revision."},"replaced_at":{"format":"date-time","type":"string","description":"The timestamp indicating when the revision was replaced."}}},"CardCreateRequest":{"title":"Card","description":"Card data.","type":"object","properties":{"template_id":{"description":"The template ID to use when creating a new card.","format":"int32","type":"integer"},"card_properties_to_copy":{"description":"A list of card properties to be copied from a source card to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CopyCardPropertiesRequest"}},"custom_fields_to_copy":{"description":"A list of custom fields to be copied from a source card to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CopyCustomFieldsRequest"}},"column_id":{"description":"The column ID of the new card.","format":"int32","type":"integer"},"lane_id":{"description":"The lane ID of the new card.","format":"int32","type":"integer"},"position":{"description":"The position of the new card in the column. `0` represents the first position.","format":"int32","type":"integer"},"track":{"description":"The number of the track in which the new card will be placed if it is created in a timeline workflow.","format":"int32","type":"integer","minimum":0},"planned_start_date_sync_type":{"description":"Specifies how the planned start date of the new card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_start_date` parameter.\n- `1`: The planned start date will be inherited as the earliest start date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned start date will be inherited from a child initiative or card.\n- `3`: The planned start date will be inherited from a child initiative or card, with adjustments for working days.\nUse this parameter to automatically sync the planned start date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2,3],"nullable":true},"planned_start_date_sync_monday_is_working_day":{"description":"Indicates whether Monday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_tuesday_is_working_day":{"description":"Indicates whether Tuesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_wednesday_is_working_day":{"description":"Indicates whether Wednesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_thursday_is_working_day":{"description":"Indicates whether Thursday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_friday_is_working_day":{"description":"Indicates whether Friday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_saturday_is_working_day":{"description":"Indicates whether Saturday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_sunday_is_working_day":{"description":"Indicates whether Sunday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date":{"description":"The manually set planened start date of the new card, represented in the format `YYYY-MM-DD`.","format":"date","type":"string"},"planned_end_date_sync_type":{"description":"Specifies how the planned end date of the new card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_end_date` parameter.\n- `1`: The planned end date will be inherited as the latest end date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned end date will be inherited from a child initiative or card.\nUse this parameter to automatically sync the planned end date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2],"nullable":true},"planned_end_date":{"description":"The manually set planened end date of the new card, represented in the format `YYYY-MM-DD`.","format":"date","type":"string"},"actual_start_time":{"description":"The actual start time of the new card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"actual_end_time":{"description":"The actual end time of the new card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"title":{"description":"The title of the new card.","type":"string"},"description":{"description":"The description of the new card.","type":"string"},"custom_id":{"description":"The custom ID assigned to the new card.","type":"string","minLength":1,"nullable":true},"owner_user_id":{"description":"The ID of the user assigned as owner of the new card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The ID of the type assigned to the new card.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size assigned to the new card.","format":"double","type":"number","maximum":1000000000000000,"nullable":true},"priority":{"description":"Determines the card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","default":3,"format":"int32","type":"integer","minimum":1,"maximum":250,"nullable":true},"color":{"description":"The color of the new card in hexadecimal format.","type":"string"},"deadline":{"description":"The deadline of the new card, represented in `ISO 8601` format with timezone offset.","type":"string","format":"date-time","nullable":true},"reference":{"description":"A reference that can be used to find the specific new card in the response.","type":"string","minLength":1},"block_reason":{"$ref":"#\/components\/schemas\/CardBlockReasonSetRequestNullable"},"card_outcomes_to_add":{"description":"A list of card outcomes to add on the card. Each object may include outcome identification for updates and the same fields as when creating a card outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeAddOrUpdateRequest"}},"stickers_to_add":{"description":"A list of stickers which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardStickerAddRequest"}},"tag_ids_to_add":{"description":"A list of tag IDs which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"tag_ids_to_remove":{"description":"A list of tag IDs which will be removed from the new card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_add":{"description":"A list of milestone IDs which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_remove":{"description":"A list of milestone IDs which will be removed from the new card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_add":{"description":"A list of doc IDs which will be linked to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_add":{"description":"A list of user IDs which will be added as co-owners to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_remove":{"description":"A list of user IDs which will be removed as co-owners from the new card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_add":{"description":"A list of user IDs which will be added as watchers to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_remove":{"description":"A list of user ids which will be removed as watchers from the new card.","type":"array","items":{"format":"int32","type":"integer"}},"custom_fields_to_add_or_update":{"description":"A list of custom fields which will be added or updated for the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldWithIdAddOrUpdateRequest"}},"custom_field_ids_to_remove":{"description":"A list of custom field IDs which will be removed from the new card.","type":"array","items":{"format":"int32","type":"integer"}},"attachments_to_add":{"description":"A list of attachments which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"}},"cover_image_link":{"description":"The URL of an internal attachment which will be set as the cover image of the new card.","type":"string","nullable":true},"subtasks_to_add":{"description":"A list of subtasks which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/SubtaskCreateRequest"}},"column_checklist_items_to_check_or_update":{"description":"A list of exit criteria.","type":"array","items":{"$ref":"#\/components\/schemas\/CardColumnChecklistItemWithIdAddOrUpdateRequest"}},"annotations_to_add":{"description":"A list of annotations which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"links_to_existing_cards_to_add_or_update":{"description":"A list of links to existing cards which will be add or update.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkAddOrUpdateRequest"}},"links_to_new_cards_to_add":{"description":"A list of links to new cards which will be added.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkToNewCardToAddRequest"}},"watch":{"description":"When set to 1 the active user will become the card's watcher.","format":"int32","type":"integer","enum":[0,1],"default":0},"created_at":{"description":"The creation date and time of the new card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"is_archived":{"description":"When set to 1 the card will be archived.","format":"int32","type":"integer","enum":[0,1],"default":0},"version_id":{"description":"The version ID of the new card.","format":"int32","type":"integer"},"archived_at":{"description":"The archival date and time of the new card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"is_discarded":{"description":"When set to 1 the card will be discarded.","format":"int32","type":"integer","enum":[0,1],"default":0},"discarded_at":{"description":"The discard date and time of the new card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"}}},"CardUpdateWithCardIdRequest":{"allOf":[{"type":"object","title":"Card","description":"Card data.","required":["card_id"],"properties":{"card_id":{"description":"The ID of the card to be updated.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardUpdateRequest"}]},"CardUpdateRequest":{"description":"Card data.","type":"object","properties":{"column_id":{"description":"The column ID of the updated card. The card will be moved to this column.","format":"int32","type":"integer"},"lane_id":{"description":"The lane ID of the updated card. The card will be moved to this lane.","format":"int32","type":"integer"},"position":{"description":"The position of the updated card. `0` represents the first position.","format":"int32","type":"integer"},"track":{"description":"The track of the updated card. This is applicable only for cards in a timeline workflow. The card will be moved to this track.","format":"int32","type":"integer","minimum":0},"planned_start_date_sync_type":{"description":"Specifies how the planned start date of the card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_start_date` parameter.\n- `1`: The planned start date will be inherited as the earliest start date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned start date will be inherited from a child initiative or card.\n- `3`: The planned start date will be inherited from a child initiative or card, with adjustments for working days.\nUse this parameter to automatically sync the planned start date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2,3],"nullable":true},"planned_start_date_sync_monday_is_working_day":{"description":"Indicates whether Monday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_tuesday_is_working_day":{"description":"Indicates whether Tuesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_wednesday_is_working_day":{"description":"Indicates whether Wednesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_thursday_is_working_day":{"description":"Indicates whether Thursday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_friday_is_working_day":{"description":"Indicates whether Friday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_saturday_is_working_day":{"description":"Indicates whether Saturday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_sunday_is_working_day":{"description":"Indicates whether Sunday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date":{"description":"The planned start date of the updated card, represented in the format `YYYY-MM-DD`.","format":"date","type":"string","nullable":true},"planned_end_date_sync_type":{"description":"Specifies how the planned end date of the card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_end_date` parameter.\n- `1`: The planned end date will be inherited as the latest end date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned end date will be inherited from a child initiative or card.\nUse this parameter to automatically sync the planned end date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2],"nullable":true},"planned_end_date":{"description":"The planned end date of the updated card, represented in the format `YYYY-MM-DD`.","format":"date","type":"string","nullable":true},"actual_start_time":{"description":"The actual start time of the updated card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"actual_end_time":{"description":"The actual end time of the updated card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"title":{"description":"The title of the updated card.","type":"string"},"description":{"description":"The description of the updated card.","type":"string"},"custom_id":{"description":"A custom ID assigned to the card.","type":"string","minLength":1,"nullable":true},"owner_user_id":{"description":"The ID of the user assigned as owner of the new card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The ID of type assigned to the updated card.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size assigned to the updated card.","format":"double","type":"number","nullable":true},"priority":{"description":"Determines the card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","type":"integer","format":"int32","default":3,"minimum":1,"maximum":250,"nullable":true},"color":{"description":"The color of the updated card in hexadecimal format.","type":"string"},"deadline":{"description":"The deadline of the updated card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","nullable":true},"block_reason":{"$ref":"#\/components\/schemas\/CardBlockReasonSetRequestNullable","nullable":true},"card_outcomes_to_add_or_update":{"description":"A list of card outcomes to add or update on the card. Each object may include outcome identification for updates and the same fields as when creating a card outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeAddOrUpdateRequest"},"nullable":true},"card_outcome_ids_to_remove":{"description":"A list of card outcome IDs to remove from the card.","type":"array","items":{"format":"int32","type":"integer"},"nullable":true},"stickers_to_add":{"description":"A list of stickers which will be added to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardStickerAddRequest"}},"sticker_ids_to_remove":{"description":"A list of card sticker IDs which will be removed from the updated card. These are the values returned by GET|POST \/cards\/{card_id}\/stickers in the 'id' property.","type":"array","items":{"format":"int32","type":"integer"}},"tag_ids_to_add":{"description":"A list of tag IDs which will be added to the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"tag_ids_to_remove":{"description":"A list of tag IDs which will be removed from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_add":{"description":"A list of milestone IDs which will be added to the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_remove":{"description":"A list of milestone IDs which will be removed from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_add":{"description":"A list of doc IDs which will be linked to the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_remove":{"description":"A list of doc IDs which will be unlinked from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_add":{"description":"A list of user IDs which will be added as co-owners to the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_remove":{"description":"A list of user IDs which will be removed as co-owners from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_add":{"description":"A list of user IDs which will be added as watchers to the update card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_remove":{"description":"A list of user IDs which will be removed as watchers from the update card.","type":"array","items":{"format":"int32","type":"integer"}},"custom_fields_to_add_or_update":{"description":"A list of custom fields which will be added or updated to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldWithIdAddOrUpdateRequest"}},"custom_field_ids_to_remove":{"description":"A list of custom field IDs which will be removed from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"attachments_to_add":{"description":"A list of attachments which will be added to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"}},"attachments_to_update":{"description":"A list of attachments which will be updated for the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithIdUpdateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachment IDs which will be removed from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"cover_image_link":{"description":"The URL of an internal attachment which will be set as the cover image of the updated card.","type":"string","nullable":true},"subtasks_to_add":{"description":"A list of subtasks which will be added to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/SubtaskCreateRequest"}},"subtasks_to_update":{"description":"A list of subtasks which will be updated for the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/SubtaskWithIdUpdateRequest"}},"subtasks_to_convert_into_cards":{"description":"A list of subtasks which will be converted into cards.","type":"array","items":{"$ref":"#\/components\/schemas\/SubtaskWithIdConvertIntoCardRequest"}},"subtask_ids_to_remove":{"description":"A list of subtask IDs which will be removed from the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"column_checklist_items_to_check_or_update":{"description":"A list of exit criteria that will be checked or updated for the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardColumnChecklistItemWithIdAddOrUpdateRequest"}},"column_checklist_item_ids_to_uncheck":{"description":"A list of exit criteria IDs which will be unchecked for the updated card.","type":"array","items":{"format":"int32","type":"integer"}},"annotations_to_add":{"description":"A list of annotations which will be added to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"annotations_to_update":{"description":"A list of annotations which will be updated for the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"annotations_to_remove":{"description":"A list of annotations which will be removed from the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationRemoveRequest"}},"links_to_existing_cards_to_add_or_update":{"description":"A list of links to existing cards which will be added or updated for the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkAddOrUpdateRequest"}},"links_to_existing_cards_to_remove":{"description":"A list of links to existing cards which will be removed from the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkRemoveRequest"}},"links_to_new_cards_to_add":{"description":"A list of links to new cards which will be added to the updated card.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkToNewCardToAddRequest"}},"watch":{"description":"When set to 1 the active user will become a card's watcher.","format":"int32","type":"integer","enum":[0,1],"default":0},"is_archived":{"description":"When set to 1 the card will be archived.","format":"int32","type":"integer","enum":[0,1]},"version_id":{"description":"The version ID of the updated card.","format":"int32","type":"integer","nullable":true},"is_discarded":{"description":"When set to 1 the card will be discarded.","format":"int32","type":"integer","enum":[0,1]}}},"CardCustomFieldAddOrUpdateRequest":{"description":"Cards custom field data required to add or update a custom field on a card.","type":"object","properties":{"value":{"description":"The value of custom field.\nApplicable to `single-line text`, `multi-line text`, `number`, `date`, and `link` custom fields.\n","type":"string","nullable":true},"selected_values_to_add_or_update":{"description":"A list of selected values to add or update. Applicable to `dropdown` custom fields.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldSelectedValueAddOrUpdateRequest"}},"selected_value_ids_to_remove":{"description":"A list of IDs of selected values to remove. Applicable to `dropdown` custom fields.","type":"array","items":{"format":"int32","type":"integer"}},"other_value":{"description":"An additional value for the custom field. Applicable to `dropdown` custom fields when \"Other\" is selected.","type":"string","nullable":true},"contributor_ids_to_add":{"description":"A list of contributor IDs to add to the custom field. Applicable to `contributor` custom fields.","type":"array","items":{"format":"int32","type":"integer"}},"contributor_ids_to_remove":{"description":"A list of contributor IDs to remove from the custom field. Applicable to `contributor` custom fields.","type":"array","items":{"format":"int32","type":"integer"}},"files_to_add":{"description":"A list of files to add to the custom field. Applicable to `file` custom fields.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldFileCreateRequest"}},"files_to_update":{"description":"A list of files to update in the custom field. Applicable to `file` custom fields.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldFileWithIdUpdateRequest"}},"file_ids_to_remove":{"description":"A list of file IDs to remove from the custom field. Applicable to `file` custom fields.","type":"array","items":{"format":"int32","type":"integer"}},"vote":{"description":"Your vote for the custom field. `0` represents a negative vote, and `1` represents a positive vote. Applicable to `vote` custom fields.","format":"int32","type":"integer","enum":[0,1],"nullable":true},"comment":{"description":"A comment associated with your vote for the custom field. Applicable to `vote` custom fields.","type":"string","nullable":true},"selected_cards_to_add_or_update":{"description":"A list of selected card IDs to add or update in the custom field. Applicable to `card picker` custom fields.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldSelectedCardAddOrUpdateRequest"}},"selected_card_ids_to_remove":{"description":"A list of selected card IDs to remove from the custom field. Applicable to `card picker` custom fields.","type":"array","items":{"format":"int32","type":"integer"}}}},"CardCustomFieldWithIdAddOrUpdateRequest":{"allOf":[{"type":"object","title":"Card custom field data","description":"Card custom field data.","required":["field_id"],"properties":{"field_id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardCustomFieldAddOrUpdateRequest"}]},"CardCustomFieldSelectedValueAddOrUpdateRequest":{"description":"Card custom field selected value data.","title":"Selected values","type":"object","properties":{"value_id":{"description":"The id of the selected value.","format":"int32","type":"integer"},"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of selected values. `0` represents the top-most position."}}},"CardCustomFieldFileCreateRequest":{"description":"Card custom field file data.","title":"Files","type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The name of the file.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link to the file. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","example":"\/files\/abc123xyz","type":"string"},"position":{"description":"The position of the file within the list of files. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardCustomFieldFileUpdateRequest":{"description":"Card custom field file data.","type":"object","properties":{"file_name":{"description":"The name of the file.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link to the file.","type":"string"},"position":{"description":"The position of the file within the list of files.","format":"int32","type":"integer"}}},"CardCustomFieldFileWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card custom field file data","description":"Card custom field file data.","required":["id"],"properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the file attachment."}}},{"$ref":"#\/components\/schemas\/CardCustomFieldFileUpdateRequest"}]},"CardCustomFieldSelectedCardAddOrUpdateRequest":{"description":"Card custom field selected card data.","title":"Selected cards","type":"object","properties":{"selected_card_id":{"description":"The id of the selected card.","format":"int32","type":"integer"},"position":{"description":"The position of the card within the list of selected cards.","format":"int32","type":"integer"}}},"CopyCardPropertiesRequest":{"title":"Source card data","description":"Card properties to copy.","type":"object","required":["properties","card_id"],"properties":{"properties":{"description":"A list of card properties that would be copied.","type":"array","items":{"type":"string","enum":["position","title","description","custom_id","owner","type","size","priority","color","deadline","block_reason","stickers","tags","contributors","custom_fields","attachments","cover_image","subtasks","unfinished_subtasks","annotations","comments","parents"]}},"card_id":{"description":"The card ID of the source card from which properties will be copied.","format":"int32","type":"integer"}}},"CopyCustomFieldsRequest":{"title":"Source card data","description":"Custom fields to copy from a source card to a new card.","type":"object","required":["field_ids","card_id"],"properties":{"field_ids":{"description":"A list of custom field IDs to be copied from a source card to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"card_id":{"description":"The card ID of the source card from which custom fields will be copied.","format":"int32","type":"integer"}}},"CardBlockReasonSetRequest":{"title":"Block reason","description":"Card block reason data.","type":"object","properties":{"reason_id":{"description":"The ID of the block reason.","format":"int32","type":"integer"},"comment":{"description":"A comment left by the user when setting the block reason.","type":"string","minLength":1,"maxLength":250}}},"CardBlockReasonSetRequestNullable":{"description":"Card block reason data.","type":"object","nullable":true,"properties":{"reason_id":{"description":"The ID of the block reason.","format":"int32","type":"integer"},"comment":{"description":"A comment left by the user when setting the block reason.","type":"string","minLength":1,"maxLength":250}}},"CardStickerAddRequest":{"title":"Sticker","description":"Card sticker data.","type":"object","required":["sticker_id"],"properties":{"sticker_id":{"description":"The ID of the sticker.","format":"int32","type":"integer"},"if_not_present":{"description":"When set to 1 the sticker will be added only if it is not already present on the card.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"CardAttachmentCreateRequest":{"description":"Card attachment data.","type":"object","title":"Attachment","required":["file_name","link"],"properties":{"file_name":{"description":"The name of the file that is attached.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link associated with the attachment. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","type":"string","example":"\/files\/abc123xyz"},"position":{"description":"The position of the attachment within the list of attachments on the card. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardAttachmentUpdateRequest":{"description":"Card attachment data.","type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The name of the file that is attached.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link associated with the attachment. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","type":"string","example":"\/files\/abc123xyz"},"position":{"description":"The position of the attachment within the list of attachments on the card. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardAttachmentWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card attachment data","description":"Card attachment data.","required":["id"],"properties":{"id":{"description":"The id of the attachment.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardAttachmentUpdateRequest"}]},"CommentCreateRequest":{"description":"Represents the data required to create a new comment on a card.","type":"object","required":["text"],"properties":{"text":{"description":"The content of the comment.","type":"string"},"attachments_to_add":{"description":"An optional list of attachments to be added to the new comment.\nEach attachment must include the file name and file link.\n","type":"array","items":{"$ref":"#\/components\/schemas\/CommentAttachmentCreateRequest"}}}},"CommentUpdateRequest":{"description":"Subtask data.","type":"object","properties":{"text":{"description":"The content of the comment.","type":"string","minLength":1},"attachments_to_add":{"description":"A list of attachments to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CommentAttachmentCreateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachments to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"CommentAttachmentCreateRequest":{"description":"The data required to create a new attachment for a card comment.","type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The name of the attachment file.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link to the attachment file.\nFor files uploaded through the application UI, this is a path starting with `\/files\/` followed by a unique string identifier.\nFor external files, this can be a full URL pointing to the file's location.\n","example":"\/files\/abc123xyz","type":"string"}}},"CardOutcomeCreateRequest":{"description":"Card outcome data.","type":"object","required":["operator"],"properties":{"starting_value":{"description":"Starting value","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000},"target_value":{"description":"Target value","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000},"operator":{"description":"Operator","type":"string","enum":["or_less","or_more"]},"comment":{"description":"An outcome comment.","type":"string","default":null},"weight":{"description":"Weight","format":"int32","type":"integer","default":1},"field_id":{"description":"Field id","format":"int32","type":"integer"},"checkpoints_to_add":{"description":"A list of checkpoints to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}}}},"CardOutcomeCheckpointCreateRequest":{"title":"Card outcome checkpoint","description":"Card outcome checkpoint data.","type":"object","required":["time","name","value"],"properties":{"time":{"description":"The target date and time for achieving the checkpoint value in `ISO 8601` format with timezone offset.","format":"date-time","type":"string","example":"2025-07-20T12:00:00+00:00"},"name":{"description":"The name of the checkpoint.","type":"string","minLength":1,"maxLength":250},"value":{"description":"The value associated with the checkpoint.","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000}}},"CardOutcomeValueCreateRequest":{"description":"Card outcome value data.","type":"object","required":["value"],"properties":{"value":{"description":"Value associated with the outcome.","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000},"time":{"description":"The date and time input by the user for the outcome value, in in `ISO 8601` format. This does not represent the system creation time of the value.","example":"2025-07-20T15:00:00+00:00","format":"date-time","type":"string"},"note":{"type":"string","description":"Optional note for the outcome value."}}},"OutcomeValueCreateRequest":{"description":"Outcome value create payload. Both time and value are required. Time cannot be in the future.","type":"object","required":["time","value"],"properties":{"time":{"description":"The date and time for the outcome value in `ISO 8601` format. Cannot be in the future.","format":"date-time","type":"string","example":"2025-07-20T15:00:00+00:00"},"value":{"description":"The numerical value of the outcome.","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000},"note":{"type":"string","description":"Optional note for the outcome value."}}},"UpdateManualOutcomeWithCustomFieldRequest":{"title":"Update Manual Outcome With Custom Field","description":"A list of outcomes to update. To update the `current_value` of an outcome with a custom field, you need to update the **value** of the custom field **itself**.","type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field which the outcome will use for calculation.","nullable":true},"starting_value":{"format":"double","type":"number","description":"The initial value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"target_value":{"format":"double","type":"number","description":"The target value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"operator":{"type":"string","description":"The operator of the outcome. The operator is based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_less","or_more"]},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"weight":{"format":"int32","type":"integer","default":1,"description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome."},"checkpoints_to_add":{"description":"A list of checkpoints to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"checkpoints_to_update":{"description":"A list of checkpoints to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithIdUpdateRequest"}},"checkpoint_ids_to_remove":{"description":"A list of checkpoints to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"UpdateManualOutcomeOwnValueRequest":{"title":"Update Manual Outcome With Own Value","description":"A list of outcomes to update.","type":"object","properties":{"starting_value":{"format":"double","type":"number","description":"The initial value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"target_value":{"format":"double","type":"number","description":"The target value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"current_value":{"format":"double","type":"number","description":"The current value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"operator":{"type":"string","description":"The operator of the outcome. The operator is based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_less","or_more"]},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"weight":{"format":"int32","type":"integer","default":1,"description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome."},"checkpoints_to_add":{"description":"A list of checkpoints to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"checkpoints_to_update":{"description":"A list of checkpoints to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithIdUpdateRequest"}},"checkpoint_ids_to_remove":{"description":"A list of checkpoints to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"UpdateAutomaticOutcomeWithRuleRequest":{"title":"Update Automatic Outcome With Outcome Rule","description":"A list of outcomes to update. The `current_value` parameter of an outcome that uses an outcome rule **cannot** be updated manually, as it's calculated automatically.","type":"object","properties":{"rule_id":{"format":"int32","type":"integer","description":"The ID of the outcome rule which the outcome will use for calculation. This should be used **only** if you want to create an outcome of type **Automatic** with an **Outcome rule**.","nullable":true},"starting_value":{"format":"double","type":"number","description":"The initial value assigned to the outcome. If you are using an outcome of type **Automatic** with a **Formula** the starting value will be calculated automatically using the `starting_value_formula`.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"target_value":{"format":"double","type":"number","description":"The target value assigned to the outcome. If you are using an outcome of type **Automatic** with a **Formula** the target value will be calculated automatically using the `target_value_formula`.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"operator":{"type":"string","description":"The operator of the outcome. The operator is based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_less","or_more"]},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"weight":{"format":"int32","type":"integer","default":1,"description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome."},"checkpoints_to_add":{"description":"A list of checkpoints to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"checkpoints_to_update":{"description":"A list of checkpoints to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithIdUpdateRequest"}},"checkpoint_ids_to_remove":{"description":"A list of checkpoints to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"UpdateAutomaticOutcomeWithFormulaRequest":{"title":"Update Automatic Outcome With Formula","description":"A list of outcomes to update. The `starting_value`, `taget_value` and `current_value` parameters **cannot** be updated manually as they're calculated automatically by using the `starting_value_formula`, `target_value_formula` and `current_value_formula` parameters.","type":"object","properties":{"starting_value_formula":{"type":"string","description":"The formula for calculating the initial value of the outcome.","nullable":true},"target_value_formula":{"type":"string","description":"The formula for calculating the target value of the outcome.","nullable":true},"current_value_formula":{"type":"string","description":"The formula for calculating the current value of the outcome.","nullable":true},"starting_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the initial value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the starting value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"target_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the target value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the target value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"current_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the current value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the current value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"operator":{"type":"string","description":"The operator of the outcome. The operator is based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_less","or_more"]},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"weight":{"format":"int32","type":"integer","default":1,"description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome."},"checkpoints_to_add":{"description":"A list of checkpoints to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"checkpoints_to_update":{"description":"A list of checkpoints to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithIdUpdateRequest"}},"checkpoint_ids_to_remove":{"description":"A list of checkpoints to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"CardOutcomeCheckpointWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card outcome checkpoint","description":"Card outcome checkpoint data.","required":["id"],"properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the checkpoint."}}},{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointUpdateRequest"}]},"CardOutcomeCheckpointUpdateRequest":{"description":"Card outcome checkpoint data.","type":"object","properties":{"time":{"format":"date-time","type":"string","description":"The target date and time for achieving the checkpoint value in `ISO 8601` format with timezone offset.","example":"2025-07-20T15:00:00+00:00"},"name":{"description":"The name of the checkpoint.","type":"string","minLength":1,"maxLength":250},"value":{"description":"The value associated with the checkpoint.","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000}}},"CardOutcomeValueWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card outcome value data","description":"Card outcome value data.","required":["id"],"properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the value."}}},{"$ref":"#\/components\/schemas\/CardOutcomeValueUpdateRequest"}]},"CardOutcomeValueUpdateRequest":{"description":"Card outcome value data.","type":"object","properties":{"value":{"description":"The value associated with the outcome.","format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000},"time":{"format":"date-time","type":"string","description":"The date and time input by the user for the outcome value, in YYYY-MM-DD HH:mm:ss format. This does not represent the system creation time of the value.","example":"2025-07-20 12:00:00"},"note":{"type":"string","description":"Optional note for the outcome value."}}},"SubtaskCreateRequest":{"title":"Subtask","description":"Subtask data.","type":"object","required":["description"],"properties":{"description":{"description":"The content of the subtask.","type":"string","minLength":1},"owner_user_id":{"description":"The user ID of the assignee.","format":"int32","type":"integer"},"is_finished":{"description":"The status of the subtask. When set to 1 the subtask is already finished.","format":"int32","type":"integer","enum":[0,1],"default":0},"deadline":{"description":"The deadline set for the subtask. It is represented in `ISO 8601` format including a timezone designator.","type":"string","format":"date-time","example":"2025-07-20T12:00:00Z"},"position":{"description":"The position of the subtask within the list of subtasks. `0` represents the top-most position.","format":"int32","type":"integer"},"attachments_to_add":{"description":"A list of attachments which will be added to the new subtask.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"}}}},"SubtaskUpdateRequest":{"description":"Subtask data.","type":"object","properties":{"description":{"description":"The content of the subtask.","type":"string","minLength":1},"owner_user_id":{"description":"The user ID of the assignee.","format":"int32","type":"integer"},"is_finished":{"description":"The status of the subtask. When set to 1 the subtask is already finished.","format":"int32","type":"integer","enum":[0,1],"default":0},"deadline":{"description":"The deadline set for the subtask. It is represented in `ISO 8601` format including a time zone designator.","type":"string","format":"date-time"},"position":{"description":"The position of the subtask within the list of subtasks. `0` represents the top-most position.","format":"int32","type":"integer"},"attachments_to_add":{"description":"A list of attachments to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"}},"attachments_to_update":{"description":"A list of attachments to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithIdUpdateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachments to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"SubtaskWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Subtask","description":"Subtask","required":["subtask_id"],"properties":{"subtask_id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/SubtaskUpdateRequest"}]},"SubtaskConvertIntoCardRequest":{"description":"Subtask convert into card data.","type":"object","required":["subtask_id"],"properties":{"subtask_id":{"description":"The ID of the subtask that will be converted into a card.","format":"int32","type":"integer"},"template_id":{"description":"The ID of the template that will be used for the converted card.","format":"int32","type":"integer"},"column_id":{"description":"The column ID of the converted card. The new card will be created in this column.","format":"int32","type":"integer"},"lane_id":{"description":"The lane ID of the converted card. The new card will be created in this lane.","format":"int32","type":"integer"},"position":{"description":"The position of the converted card. `0` represents the top-most position.","format":"int32","type":"integer"},"track":{"description":"The track of the converted card. This is applicable only for cards in a timeline workflow. The card will be created in this track.","format":"int32","type":"integer","minimum":0},"planned_start_date_sync_type":{"description":"Specifies how the planned start date of the card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_start_date` parameter.\n- `1`: The planned start date will be inherited as the earliest start date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned start date will be inherited from a child initiative or card.\n- `3`: The planned start date will be inherited from a child initiative or card, with adjustments for working days.\nUse this parameter to automatically sync the planned start date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2,3],"nullable":true},"planned_start_date_sync_monday_is_working_day":{"description":"Indicates whether Monday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_tuesday_is_working_day":{"description":"Indicates whether Tuesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_wednesday_is_working_day":{"description":"Indicates whether Wednesday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_thursday_is_working_day":{"description":"Indicates whether Thursday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_friday_is_working_day":{"description":"Indicates whether Friday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_saturday_is_working_day":{"description":"Indicates whether Saturday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date_sync_sunday_is_working_day":{"description":"Indicates whether Sunday is considered a working day when syncing the planned start date.","format":"int32","type":"integer","enum":[0,1],"default":1},"planned_start_date":{"description":"The planned start date of the updated card, represented in `ISO 8601` format with timezone offset.","format":"date","type":"string","nullable":true},"planned_end_date_sync_type":{"description":"Specifies how the planned end date of the card is determined. This option is available only for portfolio initiatives and cannot be used together with the `planned_end_date` parameter.\n- `1`: The planned end date will be inherited as the latest end date from all child initiatives in the hierarchy (excluding cards).\n- `2`: The planned end date will be inherited from a child initiative or card.\nUse this parameter to automatically sync the planned end date based on the dates of child items.\n","format":"int32","type":"integer","enum":[1,2],"nullable":true},"planned_end_date":{"description":"The planned end date of the converted card, represented in `ISO 8601` format with timezone offset.","format":"date","type":"string","nullable":true},"actual_start_time":{"description":"The actual start time of the converted card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"actual_end_time":{"description":"The actual end time of the converted card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"title":{"description":"The title of the converted card.","type":"string"},"description":{"description":"The description of the converted card.","type":"string"},"custom_id":{"description":"A custom ID assigned to the converted card.","type":"string","minLength":1},"owner_user_id":{"description":"The ID of the user who will be assigned as the owner of the converted card.","format":"int32","type":"integer"},"type_id":{"description":"The ID of the type that will be assigned to the converted card.","format":"int32","type":"integer"},"size":{"description":"The size assigned of the converted card.","format":"double","type":"number"},"priority":{"description":"The priority of the card, converted from a subtask.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","format":"int32","type":"integer","default":3,"minimum":1,"maximum":250,"nullable":true},"color":{"description":"The color of the converted card in hexadecimal format.","type":"string"},"deadline":{"description":"The deadline of the converted card, represented in `ISO 8601` format with timezone offset.","format":"date-time","type":"string"},"reference":{"description":"A reference to the converted card, which can be used to identify it in other contexts.","type":"string","minLength":1},"block_reason":{"$ref":"#\/components\/schemas\/CardBlockReasonSetRequest"},"stickers_to_add":{"description":"A list of stickers which will be added to the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardStickerAddRequest"}},"tag_ids_to_add":{"description":"The tag with IDs which will be added to the converted card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_add":{"description":"The milestone IDs which will be added to the converted card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_add":{"description":"The co-owner IDs which will be added to converted card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_add":{"description":"The watcher IDs which will be added to the converted card.","type":"array","items":{"format":"int32","type":"integer"}},"custom_fields_to_add_or_update":{"description":"A list of custom fields will be added or updated for the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardCustomFieldWithIdAddOrUpdateRequest"}},"attachments_to_add":{"description":"A list of attachments which will be added to the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentCreateRequest"}},"attachments_to_update":{"description":"A list of attachments which will be updated for the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithIdUpdateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachments which will be removed from the converted card.","type":"array","items":{"format":"int32","type":"integer"}},"cover_image_link":{"description":"The URL of an internal attachment which will be set as the cover image of the converted card.","type":"string","nullable":true},"subtasks_to_add":{"description":"A list of subtasks which will be added to the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/SubtaskCreateRequest"}},"column_checklist_items_to_check_or_update":{"description":"A list of exit criteria which will be checked or updated for the converted card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardColumnChecklistItemWithIdAddOrUpdateRequest"}},"links_to_existing_cards_to_add_or_update":{"description":"A list of links to existing cards which will be added or updated.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkAddOrUpdateRequest"}},"links_to_new_cards_to_add":{"description":"A list of links to new cards which will be added.","type":"array","items":{"$ref":"#\/components\/schemas\/LinkToNewCardToAddRequest"}},"watch":{"description":"When set to 1 the active user will become a card's watcher.","format":"int32","type":"integer","enum":[0,1],"default":0}}},"SubtaskWithIdConvertIntoCardRequest":{"allOf":[{"type":"object","title":"Subtask to convert","description":"Subtask data.","required":["subtask_id"],"properties":{"subtask_id":{"description":"The ID of the subtask to be converted into card.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/SubtaskConvertIntoCardRequest"}]},"LinkAddOrUpdateRequest":{"title":"Link to existing card","description":"Link data.","type":"object","properties":{"linked_card_id":{"description":"The ID of the existing card to which the link is being added or updated.","format":"int32","type":"integer"},"link_type":{"description":"The type of the link.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"linked_card_position":{"description":"The position of the linked card within the card's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the card within the linked card's list of linked cards.","format":"int32","type":"integer"}}},"LinkRemoveRequest":{"title":"Link to existing card","description":"Link data","type":"object","required":["linked_card_id","link_type"],"properties":{"linked_card_id":{"description":"The card id of the linked card.","format":"int32","type":"integer"},"link_type":{"description":"The link type.","type":"string","enum":["parent","child","relative","predecessor","successor"]}}},"LinkToNewCardToAddRequest":{"title":"Link to new card","description":"Link data.","type":"object","required":["linked_new_card_reference","link_type"],"properties":{"linked_new_card_reference":{"description":"The reference of the new card which is being linked.","type":"string","minLength":1},"link_type":{"description":"The type of the link.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"linked_card_position":{"description":"The position of the linked card within the card's list of linked cards.","format":"int32","type":"integer"},"card_position":{"description":"The position of the card within the linked card's list of linked cards.","format":"int32","type":"integer"}}},"CardColumnChecklistItemAddOrUpdateRequest":{"description":"Card exit criterion data.","type":"object","properties":{"comment":{"description":"A comment left by the user on the exit criterion.","type":"string","maxLength":65000}}},"CardColumnChecklistItemWithIdAddOrUpdateRequest":{"allOf":[{"type":"object","title":"Card exit criterion data","description":"Card exit criterion data.","required":["item_id"],"properties":{"item_id":{"description":"The unique identifier of the exit criterion.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardColumnChecklistItemAddOrUpdateRequest"}]},"Annotation":{"title":"Annotation","description":"Anotation data","type":"object","properties":{"thread_id":{"type":"string","description":"The thread id of the annotation. This is a random string submitted by the user on create of an annotation."},"comment_id":{"type":"string","description":"The comment id of the annotation. This is a random string submitted by the user on create of an annotation."},"author_id":{"format":"int32","type":"integer","description":"The ID of the user who created the annotation."},"content":{"type":"string","minLength":1,"maxLength":128,"description":"The value of the annotation."},"created_at":{"format":"date-time","type":"string","description":"The timestamp indicating when the annotation was created, in `ISO 8601` format."}}},"AnnotationAddOrUpdateRequest":{"title":"Annotation","description":"Annotation data.","type":"object","required":["comment_id","thread_id","content"],"properties":{"comment_id":{"description":"The comment ID of the annotation. This is a random string submitted by the user on create of an annotation.","type":"string","minLength":1,"maxLength":128},"thread_id":{"description":"The thread ID of the annotation. This is a random string submitted by the user on create of an annotation.","type":"string","minLength":1,"maxLength":128},"content":{"description":"The value of the annotation.","type":"string","minLength":1,"maxLength":128}}},"AnnotationRemoveRequest":{"title":"Annotation","description":"Annotation data.","type":"object","required":["comment_id","thread_id"],"properties":{"comment_id":{"description":"The comment id of the annotation.","type":"string","minLength":1,"maxLength":128},"thread_id":{"description":"The thread id of the annotation.","type":"string","minLength":1,"maxLength":128}}},"CardType":{"title":"Card type","description":"Card type data.","type":"object","properties":{"type_id":{"format":"int32","type":"integer","description":"The unique identifier of the card type."},"icon_type":{"description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","default":0,"enum":[0,1]},"icon_id":{"description":"The unique identifier for the icon associated with the card type.","format":"int32","type":"integer","default":0},"name":{"description":"The **unique** name assigned to the card type.","type":"string","minLength":1,"maxLength":250},"description":{"description":"A description of the card type.","type":"string","default":null},"color":{"description":"The color of the card type in hexadecimal format.","type":"string","default":""},"card_color_sync":{"description":"Apply the color of the card type to any card to which it's assigned.","format":"int32","type":"integer","enum":[0,1],"default":0},"all_properties_are_locked":{"description":"Controls whether the icon_type, icon_id, color and card_color_sync properties can be modified per board.","format":"int32","type":"integer","enum":[0,1],"default":0},"availability":{"description":"The availability level of the card type.\n\nA value of `0` represents **On-demand**, meaning the card type can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card type is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card type is automatically added to all boards across all workspaces. Once a card type's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the card type is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1}}},"CardOutcomeAddOrUpdateRequest":{"title":"Card outcome","description":"Card outcome data.","type":"object","required":["outcome_id"],"properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome.","required":true},"position":{"format":"int32","type":"integer","description":"The position of the outcome on the card."}}},"CardTemplates":{"title":"Card template","description":"Card template data.","type":"object","properties":{"template_id":{"format":"int32","type":"integer","description":"The unique identifier of the card template."},"name":{"type":"string","description":"The name of the card template.","minLength":1,"maxLength":250},"description":{"type":"string","description":"The description of the card template.","default":""},"primary_template_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the primary template card."},"availability":{"format":"int32","type":"integer","description":"The availability level of the card template.\n\nA value of `0` represents **On-demand**, meaning the card template can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card template is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card template is automatically added to all boards across all workspaces. Once a card template's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the card template is enabled.","enum":[0,1],"default":1}}},"CardTemplate":{"title":"Card template","description":"Card template data.","type":"object","properties":{"template_id":{"format":"int32","type":"integer","description":"The unique identifier of the card template."},"name":{"type":"string","description":"The name of the card template.","minLength":1,"maxLength":250},"description":{"type":"string","description":"The description of the card template.","default":""},"primary_template_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the primary template card."},"availability":{"format":"int32","type":"integer","description":"The availability level of the card template.\n\nA value of `0` represents **On-demand**, meaning the card template can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the card template is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the card template is automatically added to all boards across all workspaces. Once a card template's availability is set to **Global**, only an Owner can change its availability again.","enum":[0,1,2],"default":0},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the card template is enabled.","enum":[0,1],"default":1},"template_cards":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCard"}}}},"CardTemplateCreateRequest":{"description":"Card template data.","type":"object","required":["name","primary_card"],"properties":{"name":{"description":"The name of the new card template.","type":"string","minLength":1,"maxLength":250},"description":{"description":"The description of the new card template.","type":"string","default":null},"availability":{"description":"When set to 0 the card template has to be added to boards manually. Every workspace manager can add it to the boards they can manage. When set to 1 the card template is added automatically to all new boards but workspace managers can remove it from the boards they can manage. When set to 2 the card template is added automatically to all boards and cannot be removed.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Controls whether this card template is enabled.","format":"int32","type":"integer","enum":[0,1],"default":1},"primary_card":{"$ref":"#\/components\/schemas\/CardTemplatePrimaryCardCreateRequest"},"other_cards":{"description":"A list of additional cards linked to the primary card in the new card template. Each linked card must have its position specified using both a `column_id` and a `link_id`.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardCreateRequest"}}}},"CardTemplateUpdateRequest":{"description":"Card template data.","type":"object","properties":{"name":{"description":"The name of the updated card template.","type":"string","minLength":1,"maxLength":250},"description":{"description":"The description of the updated card template.","type":"string"},"availability":{"description":"When set to 0 the card template has to be added to boards manually. Every workspace manager can add it to the boards they can manage. When set to 1 the card template is added automatically to all new boards but workspace managers can remove it from the boards they can manage. When set to 2 the card template is added automatically to all boards and cannot be removed.","format":"int32","type":"integer","enum":[0,1,2]},"is_enabled":{"description":"Controls whether this card template is enabled.","format":"int32","type":"integer","enum":[0,1]},"cards_to_add":{"description":"A list of cards which will be added to the card template.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardInExistingTemplateCreateRequest"}},"cards_to_update":{"description":"A list of cards which will be updated for the updated card template.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardWithIdUpdateRequest"}},"card_ids_to_remove":{"description":"A list of card ids to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"CardTemplateCard":{"title":"Template Card","description":"Card data for a card template.","type":"object","properties":{"template_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the template card."},"title":{"type":"string","description":"The title of the template card."},"description":{"type":"string","description":"The description of the template card."},"custom_id":{"type":"string","description":"The custom id of the template card. This is a unique identifier that can be used to reference the card.","minLength":1,"nullable":true},"owner_user_id":{"format":"int32","type":"integer","description":"The user ID of the assignee of the template card.","nullable":true},"type_id":{"format":"int32","type":"integer","description":"The type ID of the template card.","nullable":true},"size":{"format":"double","type":"number","description":"The size of the template card. A size of `null` will be counted as `1`.","nullable":true},"priority":{"description":"Determines the card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","format":"int32","type":"integer","default":3,"minimum":1,"maximum":250,"nullable":true},"color":{"type":"string","description":"The color of the template card in hexadecimal format.","default":""},"deadline":{"format":"int32","type":"integer","description":"The deadline for the template card, represented as a positive number of days offset into the future.","nullable":true},"deadline_monday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Monday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_tuesday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Tuesday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_wednesday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Wednesday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_thursday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Thursday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_friday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Friday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_saturday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Saturday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"deadline_sunday_is_working_day":{"format":"int32","type":"integer","description":"Indicates whether **Sunday** is a working day for the template card's deadline.","enum":[0,1],"default":1},"watchers_are_visible":{"format":"int32","type":"integer","enum":[0,1],"default":0,"description":"Controls whether the watchers field is displayed in the card template, even if no users are assigned as watchers."},"card_custom_id_is_visible":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"Controls whether the custom id field is displayed in the card template, even if no value is assigned."},"milestones_are_visible":{"format":"int32","type":"integer","enum":[0,1],"default":0,"description":"Controls whether the milestones field is displayed in the card template, even if no milestones are assigned."},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}},"subtasks":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardSubtask"}},"custom_fields":{"description":"A list of card custom field values.","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataSingleLine"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataMultiLine"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataNumber"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDate"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataLink"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDropdown"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataContributor"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataFile"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataVote"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCardPicker"}]}},"stickers":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCardSticker"}},"tag_ids":{"type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids":{"type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids":{"type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids":{"type":"array","items":{"format":"int32","type":"integer"}},"annotations":{"type":"array","items":{"$ref":"#\/components\/schemas\/Annotation"}},"linked_cards":{"type":"array","items":{"title":"Linked Card","description":"Linked card data.","type":"object","properties":{"template_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the linked card within the card template."},"link_type":{"type":"string","enum":["child","parent","relative","predecessor","successor"],"description":"The type of link between the cards."},"position":{"format":"int32","type":"integer","description":"The position of the linked card within the list of linked cards. `0` represents the top-most position."}}}}}},"CardTemplateCardSubtask":{"title":"Template Card Subtask","description":"Card subtask data for a card template.","type":"object","properties":{"template_subtask_id":{"format":"int32","type":"integer","description":"The unique identifier of the subtask within the card template."},"description":{"type":"string","minLength":1,"description":"The content of the subtask."},"owner_user_id":{"format":"int32","type":"integer","description":"The ID of the user who is assigned to the subtask."},"deadline":{"format":"int32","type":"integer","description":"The deadline for the subtask, represented as the number of days in the future from the current date."},"deadline_monday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline."},"deadline_tuesday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_wednesday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline."},"deadline_thursday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline."},"deadline_friday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline."},"deadline_saturday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1,"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline."},"deadline_sunday_is_working_day":{"format":"int32","type":"integer","enum":[0,1],"default":1},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"CardTemplateCardSubtaskWithPosition":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCardSubtask"},{"type":"object","title":"Subtask with position","description":"Card subtask data with included position value for a card template.","properties":{"position":{"format":"int32","type":"integer","description":"The position of the subtask within the list of subtasks. `0` represents the top-most position."}}}]},"CardTemplateCardSticker":{"title":"Card Sticker","description":"Card sticker data for a card in a card template.","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The ID of the sticker within the card template."},"sticker_id":{"format":"int32","type":"integer","description":"The ID of the sticker."}}},"CardTemplatePrimaryCardCreateRequest":{"description":"Primary card data for a card template.","type":"object","properties":{"title":{"description":"The title of the template card.","type":"string"},"description":{"description":"The description of the template card.","type":"string"},"custom_id":{"description":"The custom ID of the template card.","type":"string","minLength":1,"nullable":true},"owner_user_id":{"description":"A user ID of the assignee of the template card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The type ID of the template card.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size of the template card. A size of `null` will be counted as `1`.","format":"double","type":"number","nullable":true},"priority":{"description":"Determines the template card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","format":"int32","type":"integer","default":3,"minimum":1,"maximum":250,"nullable":true},"color":{"description":"The color of the template card in hexadecimal format.","type":"string"},"deadline":{"description":"The deadline for the template card, represented as a positive number of days offset into the future.","format":"int32","type":"integer","nullable":true},"deadline_monday_is_working_day":{"description":"Indicates whether Monday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_tuesday_is_working_day":{"description":"Indicates whether Tuesday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_wednesday_is_working_day":{"description":"Indicates whether Wednesday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_thursday_is_working_day":{"description":"Indicates whether Thursday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_friday_is_working_day":{"description":"Indicates whether Friday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_saturday_is_working_day":{"description":"Indicates whether Saturday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_sunday_is_working_day":{"description":"Indicates whether Sunday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"watchers_are_visible":{"description":"Controls whether the watchers field is displayed in the card template, even if no users are assigned as watchers.","format":"int32","type":"integer","enum":[0,1],"default":0},"card_custom_id_is_visible":{"description":"Controls whether the custom id field is displayed in the card template, even if no value is assigned.","format":"int32","type":"integer","enum":[0,1],"default":0},"milestones_are_visible":{"description":"Controls whether the milestones field is displayed in the card template, even if no milestones are assigned.","format":"int32","type":"integer","enum":[0,1],"default":0},"reference":{"description":"A reference that can be used to find the specific new card in the response.","type":"string","minLength":1},"stickers_to_add":{"description":"A list of stickers which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateStickerAddRequest"}},"tag_ids_to_add":{"description":"A list of tag ids which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_add":{"description":"A list of milestone ids which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_add":{"description":"A list of doc IDs which will be linked to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_add":{"description":"A list of co-owner ids which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_add":{"description":"A list of watcher ids which will be added to the new card.","type":"array","items":{"format":"int32","type":"integer"}},"custom_fields_to_add_or_update":{"description":"A list of custom fields which will be added or updated for the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldWithIdAddOrUpdateRequest"}},"attachments_to_add":{"description":"A list of attachments which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"}},"subtasks_to_add":{"description":"A list of subtasks which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskCreateRequest"}},"annotations_to_add":{"description":"A list of annotations which will be added to the new card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"links_to_new_template_cards_to_add":{"description":"A list of links to new cards which will be added.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateLinkToNewTemplateCardToAddRequest"}}}},"CardTemplateCardCreateRequest":{"allOf":[{"type":"object","title":"Card Template Card","description":"Card data for a card template.","required":["column_id","lane_id"],"properties":{"column_id":{"description":"The column ID of the new card that will be created from the template.","format":"int32","type":"integer"},"lane_id":{"description":"The lane ID of the new card that will be created from the template.","format":"int32","type":"integer"},"position":{"description":"The position of the new card that will be created from the template. `0` represents the top-most position.","format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardTemplatePrimaryCardCreateRequest"}]},"CardTemplateCardUpdateRequest":{"description":"Card template data.","type":"object","properties":{"column_id":{"description":"The column ID of the card.","format":"int32","type":"integer"},"lane_id":{"description":"The lane ID of the card.","format":"int32","type":"integer"},"position":{"description":"The position of the card. `0` represents the top-most position.","format":"int32","type":"integer"},"title":{"description":"The title of the card.","type":"string"},"description":{"description":"The description of the card.","type":"string"},"custom_id":{"description":"The custom ID of the card.","type":"string","minLength":1,"nullable":true},"owner_user_id":{"description":"The ID of the user who is assigned to the card.","format":"int32","type":"integer","nullable":true},"type_id":{"description":"The ID of the type assigned of the card.","format":"int32","type":"integer","nullable":true},"size":{"description":"The size of the card. A size of `null` will be counted as `1`.","format":"double","type":"number","nullable":true},"priority":{"description":"Determines the card's priority.\n\nA value of `1` corresponds to `Critical` priority.\r\n\r\nA value of `2` corresponds to `High` priority.\r\n\r\nA value of `3` corresponds to `Average` priority.\r\n\r\nA value of `4` corresponds to `Low` priority.\r\n\r\nA `null` value will be considered as `Average` priority and any value above `4` will be considered as `Low` priority.\r\n","format":"int32","type":"integer","default":3,"minimum":1,"maximum":250,"nullable":true},"color":{"description":"The color of the card in hexadecimal format.","type":"string"},"deadline":{"description":"The deadline of the card.","format":"date-time","type":"string","nullable":true},"deadline_monday_is_working_day":{"description":"Indicates whether Monday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_tuesday_is_working_day":{"description":"Indicates whether Tuesday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_wednesday_is_working_day":{"description":"Indicates whether Wednesday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_thursday_is_working_day":{"description":"Indicates whether Thursday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_friday_is_working_day":{"description":"Indicates whether Friday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_saturday_is_working_day":{"description":"Indicates whether Saturday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"deadline_sunday_is_working_day":{"description":"Indicates whether Sunday is considered a working day when calculating the deadline.","format":"int32","type":"integer","enum":[0,1]},"watchers_are_visible":{"description":"Controls whether the watchers field is displayed in the card template, even if no users are assigned as watchers.","format":"int32","type":"integer","enum":[0,1]},"card_custom_id_is_visible":{"description":"Controls whether the custom id field is displayed in the card template, even if no value is assigned.","format":"int32","type":"integer","enum":[0,1]},"milestones_are_visible":{"description":"Controls whether the milestones field is displayed in the card template, even if no milestones are assigned.","format":"int32","type":"integer","enum":[0,1]},"stickers_to_add":{"description":"A list of stickers which will be added to the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateStickerAddRequest"}},"sticker_ids_to_remove":{"description":"A list of sticker IDs which will be removed from the card. These are the values returned by GET|POST \/cardTemplates\/{template_id}\/cards\/{card_id}\/stickers in the 'id' property.","type":"array","items":{"format":"int32","type":"integer"}},"tag_ids_to_add":{"description":"A list of tag IDs which will be added to the card.","type":"array","items":{"format":"int32","type":"integer"}},"tag_ids_to_remove":{"description":"A list of tag IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_add":{"description":"A list of milestone IDs which will be added to the card.","type":"array","items":{"format":"int32","type":"integer"}},"milestone_ids_to_remove":{"description":"A list of milestone IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_add":{"description":"A list of doc IDs which will be linked to the card.","type":"array","items":{"format":"int32","type":"integer"}},"doc_ids_to_remove":{"description":"A list of doc IDs which will be unlinked from the card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_add":{"description":"A list of co-owner IDs which will be added to the card.","type":"array","items":{"format":"int32","type":"integer"}},"co_owner_ids_to_remove":{"description":"A list of co-owner IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_add":{"description":"A list of watcher IDs which will be added to the card.","type":"array","items":{"format":"int32","type":"integer"}},"watcher_ids_to_remove":{"description":"A list of watcher IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"custom_fields_to_add_or_update":{"description":"A list of custom fields which will be added to or updated on the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldWithIdAddOrUpdateRequest"}},"custom_field_ids_to_remove":{"description":"A list of custom field IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"attachments_to_add":{"description":"A list of attachments which will be added to the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"}},"attachments_to_update":{"description":"A list of attachments which will be updated on the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentWithIdUpdateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachment IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"subtasks_to_add":{"description":"A list of subtasks which will be added to the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskCreateRequest"}},"subtasks_to_update":{"description":"A list of subtasks which will be updated on the card.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateSubtaskWithIdUpdateRequest"}},"subtask_ids_to_remove":{"description":"A list of subtask IDs which will be removed from the card.","type":"array","items":{"format":"int32","type":"integer"}},"annotations_to_add":{"description":"A list of annotations which will be added to the card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"annotations_to_update":{"description":"A list of annotations which will be updated on the card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationAddOrUpdateRequest"}},"annotations_to_remove":{"description":"A list of annotations which will be removed from the card.","type":"array","items":{"$ref":"#\/components\/schemas\/AnnotationRemoveRequest"}},"links_to_existing_template_cards_to_add_or_update":{"description":"A list of links to existing cards which will be added or updated.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateLinkAddOrUpdateRequest"}},"links_to_existing_template_cards_to_remove":{"description":"A list of links to existing cards which will be removed.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateLinkRemoveRequest"}},"links_to_new_template_cards_to_add":{"description":"A list of links to new cards which will be added.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateLinkToNewTemplateCardToAddRequest"}}}},"CardTemplateCardInExistingTemplateCreateRequest":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCardCreateRequest"},{"type":"object","title":"Card template link data","description":"Card template link data","properties":{"links_to_existing_template_cards_to_add_or_update":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateLinkAddOrUpdateRequest"}}}}]},"CardTemplateCardWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card template - template_card_id","description":"Card template - template_card_id","required":["template_card_id"],"properties":{"template_card_id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardTemplateCardUpdateRequest"}]},"CreateManualOutcomeOwnValueRequest":{"title":"Create Manual Outcome With Own Value","type":"object","required":["name","operator"],"description":"A list of outcomes to add. If neither `field_id` nor `rule_id` is provided, the outcome will be created as type **Own value**.\n\nIf you want to create an outcome of type **Automatic** using a formula, you can provide all three parameters - `starting_value_formula`, `current_value_formula`, and `target_value_formula`.\n\nAlternatively, if you do not need a custom formula, you can use predefined formulas (such as **SUM** or **AVERAGE**) that automatically calculate values based on referenced outcomes. To use a predefined formula, set the appropriate parameter ( `starting_value_predefined_formula_type`, `current_value_predefined_formula_type`, or `target_value_predefined_formula_type`) to the desired formula type.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome to be added."},"starting_value":{"format":"double","type":"number","description":"The initial value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"current_value":{"format":"double","type":"number","description":"The current value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"target_value":{"format":"double","type":"number","description":"The target value assigned to the outcome.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"operator":{"type":"string","description":"The operator of the outcome. Choose the operator based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_more","or_less"]},"weight":{"format":"int32","type":"integer","description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome.","default":1},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"checkpoints_to_add":{"description":"A list of checkpoints which will be added to the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}}}},"CreateManualOutcomeWithCustomFieldRequest":{"title":"Create Manual Outcome With Custom Field","type":"object","required":["operator"],"description":"A list of outcomes to add. If neither `field_id` nor `rule_id` is provided, the outcome will be created as type **Own value**.\n\nIf you want to create an outcome of type **Automatic** using a formula, you can provide all three parameters - `starting_value_formula`, `current_value_formula`, and `target_value_formula`.\n\nAlternatively, if you do not need a custom formula, you can use predefined formulas (such as **SUM** or **AVERAGE**) that automatically calculate values based on referenced outcomes. To use a predefined formula, set the appropriate parameter ( `starting_value_predefined_formula_type`, `current_value_predefined_formula_type`, or `target_value_predefined_formula_type`) to the desired formula type.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome to be added. You can enter a name for outcomes that use a custom field, but the UI will **always** display the name of the associated **custom field** instead.","nullable":true},"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field which the outcome will use for calculation.","nullable":true},"starting_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The initial value assigned to the outcome.","nullable":true},"current_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The current value assigned to the outcome.","nullable":true},"target_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The target value assigned to the outcome.","nullable":true},"operator":{"type":"string","description":"The operator of the outcome. Choose the operator based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_more","or_less"]},"weight":{"format":"int32","type":"integer","description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome.","default":1},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"checkpoints_to_add":{"description":"A list of checkpoints which will be added to the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}}}},"CreateAutomaticOutcomeWithRuleRequest":{"title":"Create Automatic Outcome With Outcome Rule","type":"object","required":["operator"],"description":"A list of outcomes to add. If neither `field_id` nor `rule_id` is provided, the outcome will be created as type **Own value**.\n\nIf you want to create an outcome of type **Automatic** using a formula, you can provide all three parameters - `starting_value_formula`, `current_value_formula`, and `target_value_formula`.\n\nAlternatively, if you do not need a custom formula, you can use predefined formulas (such as **SUM** or **AVERAGE**) that automatically calculate values based on referenced outcomes. To use a predefined formula, set the appropriate parameter ( `starting_value_predefined_formula_type`, `current_value_predefined_formula_type`, or `target_value_predefined_formula_type`) to the desired formula type.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome to be added. You can enter a name for outcomes that use an outcome rule, but the UI will **always** display the name of the associated **outcome rule** instead.","nullable":true},"rule_id":{"format":"int32","type":"integer","description":"The ID of the outcome rule which the outcome will use for calculation. This should be used **only** if you want to create an outcome of type **Automatic** with an **Outcome rule**.","nullable":true},"starting_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The initial value assigned to the outcome.","nullable":true},"target_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The target value assigned to the outcome.","nullable":true},"operator":{"type":"string","description":"The operator of the outcome. Choose the operator based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_more","or_less"]},"weight":{"format":"int32","type":"integer","description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome.","default":1},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"checkpoints_to_add":{"description":"A list of checkpoints which will be added to the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}}}},"CreateAutomaticOutcomeWithFormulaRequest":{"title":"Create Automatic Outcome With Formula","type":"object","required":["name","operator"],"description":"A list of outcomes to add. If neither `field_id` nor `rule_id` is provided, the outcome will be created as type **Own value**.\n\nIf you want to create an outcome of type **Automatic** using a formula, you can provide all three parameters - `starting_value_formula`, `current_value_formula`, and `target_value_formula`.\n\nAlternatively, if you do not need a custom formula, you can use predefined formulas (such as **SUM** or **AVERAGE**) that automatically calculate values based on referenced outcomes. To use a predefined formula, set the appropriate parameter ( `starting_value_predefined_formula_type`, `current_value_predefined_formula_type`, or `target_value_predefined_formula_type`) to the desired formula type.\n","properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome to be added."},"starting_value_formula":{"type":"string","description":"The formula for calculating the initial value of the outcome.","nullable":true},"target_value_formula":{"type":"string","description":"The formula for calculating the target value of the outcome.","nullable":true},"current_value_formula":{"type":"string","description":"The formula for calculating the current value of the outcome.","nullable":true},"starting_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the initial value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the starting value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"target_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the target value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the target value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"current_value_predefined_formula_type":{"format":"int32","type":"integer","description":"The formula type for calculating the current value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the current value, the value will be set to `null`.\n","nullable":true,"enum":[1,2,3,4]},"operator":{"type":"string","description":"The operator of the outcome. Choose the operator based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_more","or_less"]},"weight":{"format":"int32","type":"integer","description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome.","default":1},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"checkpoints_to_add":{"description":"A list of checkpoints which will be added to the outcome.","type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}}}},"OutcomeLinkToCardAddRequest":{"description":"Link outcome to an existing card.","type":"object","required":["linked_card_id"],"properties":{"linked_card_id":{"format":"int32","type":"integer","minimum":1},"color":{"type":"string","description":"Color in hex format."}}},"OutcomeLinkToNewCardAddRequest":{"description":"Link outcome to a new card by reference.","type":"object","required":["linked_new_card_reference"],"properties":{"linked_new_card_reference":{"type":"string","minLength":1,"description":"The reference of the new card to link to."},"color":{"type":"string","description":"Color in hex format."}}},"OutcomeLinkToOutcomeAddRequest":{"description":"Link outcome to an existing outcome.","type":"object","required":["linked_outcome_id"],"properties":{"linked_outcome_id":{"format":"int32","type":"integer","minimum":1,"description":"The ID of the existing outcome to link to."},"color":{"type":"string","description":"Color in hex format."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the link."},"reference":{"format":"int32","type":"integer","minimum":1000000000,"maximum":1999999999,"description":"The reference of the new outcome to link to."}}},"OutcomeLinkToNewOutcomeAddRequest":{"description":"Link outcome to a new outcome by reference.","type":"object","required":["linked_new_outcome_reference"],"properties":{"linked_new_outcome_reference":{"type":"string","minLength":1,"description":"The reference of the new outcome to link to."},"color":{"type":"string","description":"Color in hex format."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the link."},"reference":{"format":"int32","type":"integer","minimum":1000000000,"maximum":1999999999,"description":"The reference of the new outcome to link to."}}},"OutcomeLinkToCardUpdateRequest":{"description":"Update an outcome-to-card link.","type":"object","properties":{"linked_card_id":{"format":"int32","type":"integer","minimum":1,"description":"The linked card ID."},"color":{"type":"string","description":"Color in hex format.","nullable":true}}},"OutcomeLinkToCardWithIdUpdateRequest":{"description":"Update an outcome-to-card link by link ID.","allOf":[{"type":"object","required":["link_id"],"properties":{"link_id":{"format":"int32","type":"integer","minimum":1,"description":"The link ID to update."}}},{"$ref":"#\/components\/schemas\/OutcomeLinkToCardUpdateRequest"}]},"OutcomeLinkToOutcomeUpdateRequest":{"description":"Update an outcome-to-outcome link.","type":"object","properties":{"linked_outcome_id":{"format":"int32","type":"integer","minimum":1,"description":"The linked outcome ID."},"color":{"type":"string","description":"Color in hex format.","nullable":true},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name for the link."}}},"OutcomeLinkToOutcomeWithIdUpdateRequest":{"description":"Update an outcome-to-outcome link by link ID.","allOf":[{"type":"object","required":["link_id"],"properties":{"link_id":{"format":"int32","type":"integer","minimum":1,"description":"The link ID to update."}}},{"$ref":"#\/components\/schemas\/OutcomeLinkToOutcomeUpdateRequest"}]},"OutcomeCreateRequestBase":{"description":"Common fields for outcome create. Source is one of field_id or rule_id (mutually exclusive). For starting\/target\/current value use exactly one of numeric value, formula string, or predefined formula type per slot.","type":"object","required":["operator","starting_time","target_time"],"properties":{"card_id":{"format":"int32","type":"integer","description":"Card to attach the outcome to."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"Name of the outcome. Required when not using field_id or rule_id."},"operator":{"type":"string","enum":["or_less","or_more"],"description":"Operator for the outcome."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"minimum":1,"description":"Owner user ID."},"prefix":{"type":"string","maxLength":250,"default":""},"suffix":{"type":"string","maxLength":250,"default":""},"starting_time":{"type":"string","format":"date-time","description":"Starting time (required)."},"target_time":{"type":"string","format":"date-time","description":"Target time (required); must be after starting_time."},"starting_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Starting value. Mutually exclusive with starting_value_formula and starting_value_predefined_formula_type."},"target_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Target value. Mutually exclusive with target_value_formula and target_value_predefined_formula_type."},"current_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Current value. Mutually exclusive with current_value_formula and current_value_predefined_formula_type; not used with field_id or rule_id."},"comment":{"type":"string","default":""},"starting_value_formula":{"type":"string","description":"Custom formula for starting value. Mutually exclusive with starting_value and starting_value_predefined_formula_type; not used with field_id or rule_id."},"target_value_formula":{"type":"string","description":"Custom formula for target value. Mutually exclusive with target_value and target_value_predefined_formula_type; not used with field_id or rule_id."},"current_value_formula":{"type":"string","description":"Custom formula for current value. Mutually exclusive with current_value and current_value_predefined_formula_type; not used with field_id or rule_id."},"starting_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for starting value (1=Min, 2=Max, 3=Sum, 4=Average). Mutually exclusive with starting_value and starting_value_formula; not used with field_id or rule_id."},"target_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for target value (1=Min, 2=Max, 3=Sum, 4=Average). Mutually exclusive with target_value and target_value_formula; not used with field_id or rule_id."},"current_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for current value (1=Min, 2=Max, 3=Sum, 4=Average). Mutually exclusive with current_value and current_value_formula; not used with field_id or rule_id."},"weight":{"format":"int32","type":"integer","minimum":1,"default":1,"description":"Weight for progress calculation (positive integer)."},"reference":{"type":"string","minLength":1,"description":"Reference for linking (e.g. when adding to a card). Required when creating linked outcomes."},"tag_ids_to_add":{"type":"array","items":{"format":"int32","type":"integer","minimum":1}},"values_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeValueCreateRequest"}},"checkpoints_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"links_to_existing_cards_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToCardAddRequest"}},"links_to_new_cards_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToNewCardAddRequest"}},"links_to_existing_outcomes_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToOutcomeAddRequest"}},"links_to_new_outcomes_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToNewOutcomeAddRequest"}}}},"OutcomeCreateWithFieldId":{"title":"Create outcome with field id","description":"Create outcome using a custom field. Do not set rule_id.","allOf":[{"type":"object","required":["field_id"],"properties":{"field_id":{"format":"int32","type":"integer","description":"Custom field ID. Mutually exclusive with rule_id."}}},{"$ref":"#\/components\/schemas\/OutcomeCreateRequestBase"}]},"OutcomeCreateWithRuleId":{"title":"Create outcome with rule id","description":"Create outcome using an outcome rule. Do not set field_id.","allOf":[{"type":"object","required":["rule_id"],"properties":{"rule_id":{"format":"int32","type":"integer","description":"Outcome rule ID. Mutually exclusive with field_id."}}},{"$ref":"#\/components\/schemas\/OutcomeCreateRequestBase"}]},"OutcomeCreateOwnValue":{"title":"Create own value outcome","description":"Create outcome with own value (no custom field or rule). Do not set field_id or rule_id.","allOf":[{"type":"object","required":["name"],"properties":{}},{"$ref":"#\/components\/schemas\/OutcomeCreateRequestBase"}]},"OutcomeUpdateRequestBase":{"description":"Common optional fields for outcome update (PATCH \/outcomes\/{id}).\nWhen changing outcome type, send at most one of field_id or rule_id (see oneOf variants).\nFor starting value use at most one of starting_value, starting_value_formula, or starting_value_predefined_formula_type.\nFor target value use at most one of target_value, target_value_formula, or target_value_predefined_formula_type.\nFor current value use at most one of current_value, current_value_formula, or current_value_predefined_formula_type; do not set current_value when using field_id or rule_id.\n","type":"object","properties":{"card_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the card that the outcome belongs to."},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome."},"operator":{"type":"string","enum":["or_less","or_more"],"description":"The operator of the outcome."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"minimum":1,"description":"The ID of the user that owns the outcome."},"prefix":{"type":"string","maxLength":250,"description":"Prefix for display."},"suffix":{"type":"string","maxLength":250,"description":"Suffix for display."},"starting_time":{"type":"string","format":"date-time","description":"The starting time of the outcome."},"target_time":{"type":"string","format":"date-time","description":"The target time of the outcome."},"starting_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Starting value. Do not set together with starting_value_formula or starting_value_predefined_formula_type."},"target_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Target value. Do not set together with target_value_formula or target_value_predefined_formula_type."},"current_value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"Current value. Do not set together with field_id, rule_id, current_value_formula, or current_value_predefined_formula_type."},"comment":{"type":"string","description":"The comment of the outcome."},"starting_value_formula":{"type":"string","description":"Custom formula for starting value. Do not set together with field_id, rule_id, starting_value, or starting_value_predefined_formula_type."},"target_value_formula":{"type":"string","description":"Custom formula for target value. Do not set together with field_id, rule_id, target_value, or target_value_predefined_formula_type."},"current_value_formula":{"type":"string","description":"Custom formula for current value. Do not set together with field_id, rule_id, current_value, or current_value_predefined_formula_type."},"starting_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for starting value (1=Min, 2=Max, 3=Sum, 4=Average). Do not set together with field_id, rule_id, starting_value, or starting_value_formula."},"target_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for target value (1=Min, 2=Max, 3=Sum, 4=Average). Do not set together with field_id, rule_id, target_value, or target_value_formula."},"current_value_predefined_formula_type":{"format":"int32","type":"integer","enum":[1,2,3,4],"description":"Predefined formula for current value (1=Min, 2=Max, 3=Sum, 4=Average). Do not set together with field_id, rule_id, current_value, or current_value_formula."},"weight":{"format":"int32","type":"integer","minimum":1,"description":"The weight of the outcome."},"tag_ids_to_add":{"type":"array","items":{"format":"int32","type":"integer","minimum":1},"description":"The IDs of the tags to add to the outcome."},"tag_ids_to_remove":{"type":"array","items":{"format":"int32","type":"integer","minimum":1},"description":"The IDs of the tags to remove from the outcome."},"values_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeValueCreateRequest"}},"values_to_update":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeValueWithIdUpdateRequest"}},"value_ids_to_remove":{"type":"array","description":"The IDs of the values to remove from the outcome.","items":{"format":"int32","type":"integer","minimum":1}},"checkpoints_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointCreateRequest"}},"checkpoints_to_update":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithIdUpdateRequest"}},"checkpoint_ids_to_remove":{"type":"array","description":"The IDs of the checkpoints to remove from the outcome.","items":{"format":"int32","type":"integer","minimum":1}},"links_to_existing_cards_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToCardAddRequest"}},"links_to_existing_cards_to_update":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToCardWithIdUpdateRequest"}},"link_ids_to_existing_cards_to_remove":{"type":"array","items":{"format":"int32","type":"integer","minimum":1},"description":"The IDs of the links to existing cards to remove from the outcome."},"links_to_new_cards_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToNewCardAddRequest"},"description":"The IDs of the links to new cards to add to the outcome."},"links_to_existing_outcomes_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToOutcomeAddRequest"},"description":"The IDs of the links to existing outcomes to add to the outcome."},"links_to_existing_outcomes_to_update":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToOutcomeWithIdUpdateRequest"},"description":"The IDs of the links to existing outcomes to update in the outcome."},"link_ids_to_existing_outcomes_to_remove":{"type":"array","items":{"format":"int32","type":"integer","minimum":1},"description":"The IDs of the links to existing outcomes to remove from the outcome."},"links_to_new_outcomes_to_add":{"type":"array","items":{"$ref":"#\/components\/schemas\/OutcomeLinkToNewOutcomeAddRequest"},"description":"The IDs of the links to new outcomes to add to the outcome."}}},"OutcomeUpdateWithFieldId":{"title":"Update outcome with field id","description":"Use when linking the outcome to a custom field. Do not set rule_id.","allOf":[{"type":"object","properties":{"field_id":{"format":"int32","type":"integer","nullable":true,"description":"Custom field ID. Do not set together with rule_id."}}},{"$ref":"#\/components\/schemas\/OutcomeUpdateRequestBase"}]},"OutcomeUpdateWithRuleId":{"title":"Update outcome with rule id","description":"Use when linking the outcome to an outcome rule. Do not set field_id.","allOf":[{"type":"object","properties":{"rule_id":{"format":"int32","type":"integer","nullable":true,"description":"Outcome rule ID. Do not set together with field_id."}}},{"$ref":"#\/components\/schemas\/OutcomeUpdateRequestBase"}]},"OutcomeUpdateOwnValue":{"title":"Update outcome (own value)","description":"Use when the outcome is or remains own-value (no custom field or rule). Do not set field_id or rule_id.","allOf":[{"$ref":"#\/components\/schemas\/OutcomeUpdateRequestBase"}]},"CardTemplateStickerAddRequest":{"title":"Sticker","description":"Card template sticker data.","type":"object","required":["sticker_id"],"properties":{"sticker_id":{"description":"The sticker id of the sticker.","format":"int32","type":"integer"}}},"CardTemplateAttachmentCreateRequest":{"title":"Attachment","description":"Card template attachment data.","type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The name of the file that is attached.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link associated with the attachment. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","type":"string","example":"\/files\/abc123xyz"},"position":{"description":"The position of the attachment within the list of attachments on the card. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardTemplateAttachmentUpdateRequest":{"description":"Card template attachment data.","type":"object","required":["file_name","link"],"properties":{"file_name":{"description":"The attachment file name.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The attachment file link.","type":"string"},"position":{"description":"The attachment position.","format":"int32","type":"integer"}}},"CardTemplateSubtaskAttachmentUpdateRequest":{"description":"Card template attachment data.","type":"object","properties":{"file_name":{"description":"The attachment file name.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The attachment file link.","type":"string"},"position":{"description":"The attachment position.","format":"int32","type":"integer"}}},"CardTemplateAttachmentWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card template attachment data","description":"Card template attachment data.","required":["id"],"properties":{"id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardTemplateAttachmentUpdateRequest"}]},"CardTemplateSubtaskCreateRequest":{"title":"Subtask","description":"Card template subtask data.","type":"object","required":["description"],"properties":{"description":{"description":"The content of the subtask.","type":"string","minLength":1},"owner_user_id":{"description":"The ID of the user who is assigned to the subtask.","format":"int32","type":"integer"},"position":{"description":"The position of the subtask within the list of subtasks. `0` represents the top-most position.","format":"int32","type":"integer"},"deadline":{"description":"The deadline for the subtask, represented as the number of days in the future from the current date.","format":"int32","type":"integer"},"deadline_monday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_tuesday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_wednesday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_thursday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_friday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_saturday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_sunday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"attachments_to_add":{"description":"A list of attachments which will be added to the new subtask.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"}}}},"CardTemplateSubtaskUpdateRequest":{"description":"Card template subtask data.","type":"object","properties":{"description":{"description":"The content of the subtask.","type":"string","minLength":1},"owner_user_id":{"description":"The ID of the user who is assigned to the subtask.","format":"int32","type":"integer","nullable":true},"position":{"description":"The position of the subtask within the list of subtasks. `0` represents the top-most position.","format":"int32","type":"integer"},"deadline":{"description":"The deadline of the subtask.","format":"int32","type":"integer","nullable":true},"deadline_monday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_tuesday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_wednesday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_thursday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_friday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_saturday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"deadline_sunday_is_working_day":{"description":"When enabled, this parameter designates the specified weekday as a working day, so it is included when calculating the deadline.","format":"int32","type":"integer","enum":[0,1],"default":1},"attachments_to_add":{"description":"A list of attachments to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateAttachmentCreateRequest"}},"attachments_to_update":{"description":"A list of attachments to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithIdUpdateRequest"}},"attachment_ids_to_remove":{"description":"A list of attachments to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"CardTemplateSubtaskWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Subtask data","description":"Subtask data","required":["template_subtask_id"],"properties":{"template_subtask_id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardTemplateSubtaskUpdateRequest"}]},"CardTemplateLinkToNewTemplateCardToAddRequest":{"title":"New Link","description":"Card template link data.","type":"object","required":["linked_new_template_card_reference","link_type"],"properties":{"linked_new_template_card_reference":{"description":"The new card's reference of the linked card.","type":"string","minLength":1},"link_type":{"description":"The link type.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"linked_template_card_position":{"description":"The position of the linked card within the card's list of linked cards.","format":"int32","type":"integer"},"template_card_position":{"description":"The position of the card within the link card's list of linked cards.","format":"int32","type":"integer"}}},"CardTemplateCustomFieldWithIdAddOrUpdateRequest":{"allOf":[{"type":"object","title":"Card template custom field data","description":"Card template custom field data.","required":["field_id"],"properties":{"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field to be added or updated."}}},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldAddOrUpdateRequest"}]},"CardTemplateCustomFieldAddOrUpdateRequest":{"description":"Card template custom field data.","type":"object","properties":{"value":{"description":"The value of custom field.","type":"string","nullable":true},"selected_values_to_add_or_update":{"description":"A list of selected values to add or update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldSelectedValueAddOrUpdateRequest"}},"selected_value_ids_to_remove":{"description":"A list of selected values to remove.","type":"array","items":{"format":"int32","type":"integer"}},"other_value":{"description":"The other value of the custom field.","type":"string","nullable":true},"contributor_ids_to_add":{"description":"The contributor ids which will be added to card template custom field.","type":"array","items":{"format":"int32","type":"integer"}},"contributor_ids_to_remove":{"description":"The contributor ids which will be removed from card template custom field.","type":"array","items":{"format":"int32","type":"integer"}},"files_to_add":{"description":"A list of files to add.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFileCreateRequest"}},"files_to_update":{"description":"A list of files to update.","type":"array","items":{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFileUpdateRequest"}},"file_ids_to_remove":{"description":"A list of file ids to remove.","type":"array","items":{"format":"int32","type":"integer"}}}},"CardTemplateCustomFieldSelectedValueAddOrUpdateRequest":{"description":"Represents the data to add or update a selected value in a dropdown custom field associated with a card template.","title":"Selected values","type":"object","required":["value_id"],"properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the selected value in the dropdown custom field."},"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of values for the dropdown custom field. `0` represents the top-most position."}}},"CardTemplateCustomFieldFileCreateRequest":{"description":"Card template custom field file data.","title":"Files","type":"object","required":["file_name","link"],"properties":{"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file to be associated with the custom field."},"link":{"type":"string","description":"The URL or path to access the file."},"position":{"format":"int32","type":"integer","description":"The position of the file within the list of files associated with the custom field. `0` represents the top-most position."}}},"CardTemplateCustomFieldFileUpdateRequest":{"description":"The data to update a file associated with a custom field in a card template.","title":"Files","type":"object","required":["id"],"properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the file attachment."},"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file to be updated."},"link":{"type":"string","description":"The URL or path to access the file."},"position":{"format":"int32","type":"integer","description":"The position of the file within the list of files associated with the custom field. `0` represents the top-most position."}}},"CardTemplateCustomFieldFileWithIdUpdateRequest":{"allOf":[{"type":"object","title":"Card template custom field file data","description":"Card template custom field file data.","required":["id"],"properties":{"id":{"format":"int32","type":"integer"}}},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldFileUpdateRequest"}]},"CardTemplateLinkAddOrUpdateRequest":{"title":"Template Card Link","description":"Card template link data","type":"object","required":["linked_template_card_id","link_type"],"properties":{"linked_template_card_id":{"description":"The template card id of the linked card.","format":"int32","type":"integer"},"link_type":{"description":"The link type.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"linked_template_card_position":{"description":"The position of the linked template card within the card's list of linked cards. `0` represents the top-most position.","format":"int32","type":"integer"},"template_card_position":{"description":"The position of the template card within the link card's list of linked cards. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardTemplateLinkRemoveRequest":{"title":"Template Card Link","description":"Card template link data","type":"object","required":["linked_template_card_id","link_type"],"properties":{"linked_template_card_id":{"description":"The card id of the linked template card.","format":"int32","type":"integer"},"link_type":{"description":"The link type.","type":"string","enum":["parent","child","relative","predecessor","successor"]}}},"BoardCardType":{"title":"Board card type","description":"Board card type data","type":"object","properties":{"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the card type.","default":0},"color":{"type":"string","description":"The color of the card type in hexadecimal format.","default":""},"card_color_sync":{"format":"int32","description":"Apply the color of the card type to any card to which it's assigned.","type":"integer","enum":[0,1]}}},"BoardCardTypeCreateOrUpdateRequest":{"description":"Board card type data.","type":"object","properties":{"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the card type.","default":0},"color":{"type":"string","description":"The color of the card type in hexadecimal format.","default":""},"card_color_sync":{"format":"int32","description":"Apply the color of the card type to any card to which it's assigned.","type":"integer","enum":[0,1]}}},"CardTemplateCustomFieldDataCommon":{"title":"Card Template Custom Field","description":"Card template custom field data","type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field."}}},"CardTemplateCustomFieldDataSingleLine":{"title":"Card Template Custom Field - Single-Line Text","description":"Card template custom field data - single-line text","type":"object","properties":{"value":{"type":"string","description":"The value of the single-line text custom field."},"display_value":{"type":"string","description":"The formatted or displayed value of the single-line text custom field."}}},"CardTemplateCustomFieldDataSingleLineWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataSingleLine"}]},"CardTemplateCustomFieldDataMultiLine":{"title":"Card Template Custom Field - Multi-Line Text","description":"Card template custom field data - multi-line text","type":"object","properties":{"value":{"type":"string","description":"The value of the multi-line text custom field."}}},"CardTemplateCustomFieldDataMultiLineWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataMultiLine"}]},"CardTemplateCustomFieldDataNumber":{"title":"Card Template Custom Field - Number","description":"Card template custom field data - number","type":"object","properties":{"value":{"format":"double","type":"number","description":"The value of the number custom field."},"display_value":{"type":"string","description":"The formatted or displayed representation of the numeric value."}}},"CardTemplateCustomFieldDataNumberWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataNumber"}]},"CardTemplateCustomFieldDataDate":{"title":"Card Template Custom Field - Date","description":"Card template custom field data - date","type":"object","properties":{"value":{"format":"int32","type":"integer","description":"The value of the date custom field, which may be either a date or a datetime.","example":"\"2025-07-01\" for date, \n \"2025-07-20T12:00:00Z\" for datetime."}}},"CardTemplateCustomFieldDataDateWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDate"}]},"CardTemplateCustomFieldDataLink":{"title":"Card Template Custom Field - Link","description":"Card template custom field data - link","type":"object","properties":{"value":{"type":"string","description":"The value of the link custom field."}}},"CardTemplateCustomFieldDataLinkWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataLink"}]},"CardTemplateCustomFieldDataDropdown":{"title":"Card Template Custom Field - Dropdown","description":"Card template custom field data - dropdown","type":"object","properties":{"values":{"type":"array","description":"A list of values in the dropdown custom field.","items":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the dropdown value."},"position":{"format":"int32","type":"integer","description":"The position of the value within the dropdown list. `0` represents the top-most position."}}}}}},"CardTemplateCustomFieldDataDropdownWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataDropdown"}]},"CardTemplateCustomFieldDataContributor":{"title":"Card Template Custom Field - Contributor","description":"Card template custom field data - contributor","type":"object","properties":{"contributors":{"type":"array","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The user ID of the contributor."}}}}}},"CardTemplateCustomFieldDataContributorWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataContributor"}]},"CardTemplateCustomFieldDataFile":{"title":"Card Template Custom Field - File","description":"Card template custom field data - file","type":"object","properties":{"files":{"type":"array","items":{"title":"Files","type":"object","description":"A list of file attachments for the custom field.","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the file attachment."},"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file attachment."},"link":{"type":"string","description":"The URL or path to access the file attachment."},"position":{"format":"int32","type":"integer","description":"The position of the file within the list of files. `0` represents the top-most position."}}}}}},"CardTemplateCustomFieldDataFileWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataFile"}]},"CardTemplateCustomFieldDataVote":{"title":"Card Template Custom Field - Vote","description":"Card template custom field data - vote","type":"object"},"CardTemplateCustomFieldDataVoteWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataVote"}]},"CardTemplateCustomFieldDataCardPicker":{"title":"Card Template Custom Field - Card Picker","description":"Card template custom field data - card picker","type":"object"},"CardTemplateCustomFieldDataCardPickerWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCardPicker"}]},"CardTemplateCustomFieldDataCalculatedNumber":{"title":"Card Template Custom Field - Calculated Number","description":"Card template custom field data - calculated number","type":"object"},"CardTemplateCustomFieldDataCalculatedNumberWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedNumber"}]},"CardTemplateCustomFieldDataCalculatedDate":{"title":"Card Template Custom Field - Calculated Date","description":"Card template custom field data - calculated date","type":"object"},"CardTemplateCustomFieldDataCalculatedDateWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardTemplateCustomFieldDataCalculatedDate"}]},"CardTemplateCustomFieldSelectedValue":{"title":"Card template custom field value","description":"Represents the data for a selected value in a dropdown custom field associated with a card template.","type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the selected value in the dropdown custom field."},"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of values for the dropdown custom field. `0` represents the top-most position."}}},"CardTemplateCustomFieldFile":{"title":"Card template Card custom field file","description":"Represents the data for a file associated with a custom field in a card within a card template.","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The ID of the file."},"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file associated with the custom field."},"link":{"type":"string","description":"The URL or path to access the file."},"position":{"format":"int32","type":"integer","description":"The position of the file within the list of files associated with the custom field."}}},"CardTemplateCustomFieldCreateOrUpdateRequestSingleLine":{"type":"object","description":"Card template custom field data - single-line text.","properties":{"value":{"description":"The value of the custom field.","type":"string","minLength":1,"maxLength":250}}},"CardTemplateCustomFieldCreateOrUpdateRequestMultiLine":{"type":"object","description":"Card template custom field data - multi-line text.","properties":{"value":{"description":"The value of the custom field.","type":"string"}}},"CardTemplateCustomFieldCreateOrUpdateRequestNumber":{"type":"object","description":"Card template custom field data - number.","properties":{"value":{"description":"The value of the custom field.","format":"double","type":"number"}}},"CardTemplateCustomFieldCreateOrUpdateRequestDate":{"type":"object","description":"Card template custom field data - date.","properties":{"value":{"description":"The value of the custom field.","format":"int32","type":"integer"}}},"CardTemplateCustomFieldCreateOrUpdateRequestLink":{"type":"object","description":"Card template custom field data - link.","properties":{"value":{"description":"The value of the custom field.","type":"string"}}},"CardTemplateCustomFieldCreateOrUpdateRequestDropdown":{"type":"object","description":"Card template custom field data - dropdrown.","properties":{"values":{"description":"A list of the values of the custom field. The values will be dispayed in the UI in the order in which they were provided.","type":"array","items":{"type":"object","properties":{"value_id":{"description":"The id of an allowed value of the custom field.","format":"int32","type":"integer"}}}}}},"CardTemplateCustomFieldCreateOrUpdateRequestContributor":{"type":"object","description":"Card template custom field data - contributor.","properties":{"contributors":{"description":"A list of the contributors for the custom field.","type":"array","items":{"type":"object","properties":{"user_id":{"description":"The user id of the contributor.","format":"int32","type":"integer"}}}}}},"CardTemplateCustomFieldCreateOrUpdateRequestFile":{"type":"object","description":"Card template custom field data - file.","properties":{"files":{"description":"A list of the files for the custom field.","type":"array","items":{"type":"object","properties":{"file_name":{"description":"The name of the file.","type":"string","minLength":1,"maxLength":250},"link":{"description":"The link to the file.","type":"string"}}}}}},"CardTemplateCustomFieldCreateOrUpdateRequestVote":{"type":"object","description":"Card template custom field data - vote."},"CardTemplateCustomFieldCreateOrUpdateRequestCardPicker":{"type":"object","description":"Card template custom field data - card picker."},"CardBlockReason":{"title":"Card block reason","description":"Represents the block reason data for a card. This can include either a generic block reason or a user-defined block reason.","type":"object","properties":{"block_type":{"format":"int32","type":"integer","enum":[0,1]},"comment":{"type":"string","nullable":true,"description":"An optional comment explaining the block reason."},"reason_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the block reason, if applicable."}}},"CardGenericBlockReason":{"title":"Set a Generic Block Reason","description":"Represents the data required to set a generic block reason for a card. Generic block reasons are predefined and do not require a specific reason ID.","type":"object","required":["comment"],"properties":{"comment":{"type":"string","minLength":1,"maxLength":250,"description":"A required comment explaining the reason for blocking the card. This provides additional context for the block."},"reason_id":{"type":"number","description":"The ID of the block reason. This field is always `null` for generic blockers, as they do not require a specific reason ID.","default":null,"nullable":true}}},"CardUserDefinedBlockReason":{"title":"Set a User-Defined Block Reason","description":"Represents the data required to set a user-defined block reason for a card. User-defined block reasons allow users to specify custom reasons for blocking a card.","type":"object","required":["reason_id"],"properties":{"comment":{"type":"string","minLength":1,"maxLength":250,"nullable":true,"description":"An optional comment explaining the reason for blocking the card. This provides additional context for the block and is useful for tracking purposes."},"reason_id":{"format":"int32","type":"integer","description":"The unique ID of the block reason. This field is required when setting a user-defined block reason to identify the specific reason for the block."}}},"CardComment":{"allOf":[{"$ref":"#\/components\/schemas\/CardCommentID"},{"$ref":"#\/components\/schemas\/CardCommentDataCommon"},{"$ref":"#\/components\/schemas\/CardCommentDataAuthorOrSenderAndRecipient"}]},"CardCommentID":{"title":"Card comment ID","description":"Card comment ID data.","type":"object","properties":{"comment_id":{"format":"int32","type":"integer","description":"The unique identifier of the comment."}}},"CardCommentDataCommon":{"title":"Card comment","description":"Card comment data.","type":"object","properties":{"type":{"type":"string","enum":["plain","sent as email","received as email"],"description":"The type of the comment, indicating how it was created or received:\n- `plain`: A standard comment added directly to the card.\n- `sent as email`: A comment created when an email was sent from the card.\n- `received as email`: A comment created when an email was received on the card.\n"},"text":{"type":"string","description":"The content of the comment, which may include plain text or email content."},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardCommentAttachmentWithId"},"description":"A list of attachments associated with the comment."},"created_at":{"format":"date-time","type":"string","description":"The date and time when the comment was created, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"},"last_modified":{"format":"date-time","type":"string","description":"The date and time when the comment was last modified, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"CardCommentDataAuthorOrSenderAndRecipient":{"oneOf":[{"$ref":"#\/components\/schemas\/CardCommentAuthor"},{"$ref":"#\/components\/schemas\/CardCommentSenderAndRecipients"}]},"CardCommentAuthor":{"title":"Card comment author","description":"Represents the data for comment created internally within the system.\n","type":"object","properties":{"author":{"type":"object","properties":{"type":{"type":"string","description":"The type of the author.","enum":["internal"]},"value":{"description":"The unique identifier of the author.","format":"int32","type":"integer"}},"description":"The author of the comment, including their type and their unique identifier. For internal comments, the type is always `internal`, and the value is the user ID of the author.\n"}}},"CardCommentSenderAndRecipients":{"title":"Card comment sender and recipients","description":"Represents the data for comments sent or received as emails.\n","allOf":[{"$ref":"#\/components\/schemas\/CardCommentSender"},{"$ref":"#\/components\/schemas\/CardCommentRecipients"}]},"CardCommentSender":{"title":"Card comment sender","description":"Represents the data for the sender of a card comment.\nThis is used for comments sent as emails.\n","type":"object","properties":{"sender":{"type":"object","description":"The sender of the comment, including their type (internal or external)\nand their unique identifier.\n","properties":{"type":{"type":"string","enum":["internal","external"],"description":"The type of the sender:\n- `internal`: The sender is an internal user.\n- `external`: The sender is an external user.\n"},"value":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The unique identifier of the sender, which can be an **integer** ID for internal users or a **string** email address for external users."}}}}},"CardCommentRecipients":{"title":"Card comment recipients","description":"Represents the data for the recipients of a card comment.\nThis includes the recipients in the `to`, `cc`, and `bcc` fields.\n","type":"object","properties":{"recipients":{"type":"object","description":"The recipients of the comment, categorized into `to`, `cc`, and `bcc` fields.\nEach recipient includes their type (internal or external) and their unique identifier.\n","properties":{"to":{"type":"array","description":"A list of primary recipients of the comment.","items":{"type":"object","properties":{"type":{"type":"string","enum":["internal","external"],"description":"The type of the recipient:\n- `internal`: The recipient is an internal user.\n- `external`: The recipient is an external user.\n"},"value":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The unique identifier of the sender, which can be an **integer** ID for internal users or a **string** email address for external users."}}}},"cc":{"type":"array","description":"A list of recipients copied on the comment.","items":{"type":"object","properties":{"type":{"type":"string","enum":["internal","external"],"description":"The type of the recipient:\n- `internal`: The recipient is an internal user.\n- `external`: The recipient is an external user.\n"},"value":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The unique identifier of the sender, which can be an **integer** ID for internal users or a **string** email address for external users."}}}},"bcc":{"type":"array","description":"A list of recipients blind copied on the comment.","items":{"type":"object","properties":{"type":{"type":"string","enum":["internal","external"],"description":"The type of the recipient:\n- `internal`: The recipient is an internal user.\n- `external`: The recipient is an external user.\n"},"value":{"oneOf":[{"type":"integer"},{"type":"string"}],"description":"The unique identifier of the sender, which can be an **integer** ID for internal users or a **string** email address for external users."}}}}}}}},"CardCommentCreatedResponse":{"type":"object","properties":{"type":{"type":"string","enum":["plain"],"description":"The type of the comment. Only `plain` type is supported for creating comments through the api."},"text":{"type":"string","minLength":1,"description":"The content of the comment."},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardCommentAttachmentWithId"},"description":"A list of attachments associated with the comment."},"created_at":{"format":"date-time","type":"string","description":"The date and time when the comment was created, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"},"last_modified":{"format":"date-time","type":"string","description":"The date and time when the comment was last modified, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"},"comment_id":{"format":"int32","type":"integer","description":"The unique identifier of the comment."}}},"CardOutcomeListItem":{"title":"Card outcome list item","description":"Outcome linked to a card (outcome_id and position) as returned by GET \/cards\/{card_id}\/cardOutcomes.","type":"object","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."},"position":{"format":"int32","type":"integer","description":"The position of the outcome in the card's outcome list. `0` is the first position."}}},"CardOutcomePositionResponse":{"title":"Card outcome position","description":"Position of an outcome linked to a card, as returned by GET\/PUT \/cards\/{card_id}\/cardOutcomes\/{outcome_id}.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the outcome in the card's outcome list. `0` is the first position."}}},"CardOutcomePositionSetRequest":{"title":"Card outcome position set request","description":"Request body for updating the position of an outcome linked to a card.","type":"object","properties":{"position":{"format":"int32","type":"integer","minimum":0,"description":"The new position (non-negative integer). `0` is the first position."}}},"CardOutcomeWithId":{"allOf":[{"type":"object","title":"Card outcome","description":"Card outcome data.","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome."}}},{"$ref":"#\/components\/schemas\/CardOutcome"}]},"CardOutcome":{"title":"Card outcome","description":"Card outcome data.","type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field which the outcome will use for calculation. This parameter remains `null` unless there's an outcome of type **Manual** with a **Custom field**.","nullable":true},"rule_id":{"format":"int32","type":"integer","description":"The ID of the outcome rule which the outcome will use for calculation. This parameter remains `null` unless there's an outcome of type **Automatic** with an **Outcome Rule**.","nullable":true},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome.\n\nThis field will be set to `null` if the outcome is of type **Automatic** and uses an **Outcome Rule**, or if it is of type **Manual** and uses a **Custom Field**. In those cases, the name will be taken from the Outcome Rule or Custom Field.","nullable":true},"operator":{"type":"string","description":"The operator of the outcome. The operator is based on whether you aim to **increase** or **decrease** the outcome.","enum":["or_less","or_more"]},"starting_value":{"format":"double","type":"number","description":"The initial value assigned to the outcome. If you are using an outcome of type **Automatic** with a **Formula** the starting value will be calculated automatically using the `starting_value_formula`.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"target_value":{"format":"double","type":"number","description":"The target value assigned to the outcome. If you are using an outcome of type **Automatic** with a **Formula** the target value will be calculated automatically using the `target_value_formula`.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"current_value":{"format":"double","type":"number","description":"The current value assigned to the outcome. If you are using an outcome of type **Automatic** with an **Outcome Rule** the current value will be calculated automatically. If you are using an outcome of type **Automatic** with a **Formula** the current value will be calculated automatically using the `current_value_formula`.","minimum":-1000000000000000,"maximum":1000000000000000,"nullable":true},"comment":{"type":"string","description":"A summary of the outcome, explaining why it's important."},"starting_value_formula":{"type":"string","description":"The formula for calculating the initial value of the outcome. This is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.","nullable":true},"target_value_formula":{"type":"string","description":"The formula for calculating the target value of the outcome. This is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.","nullable":true},"current_value_formula":{"type":"string","description":"The formula for calculating the current value of the outcome. This is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.","nullable":true},"starting_value_predefined_formula_type":{"format":"int32","type":"number","description":"The formula type for calculating the initial value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the starting value, the value will be set to `null`.\n\nThis is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.\n","nullable":true,"enum":[1,2,3,4]},"target_value_predefined_formula_type":{"format":"int32","type":"number","description":"The formula type for calculating the target value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the target value, the value will be set to `null`.\n\nThis is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.\n","nullable":true,"enum":[1,2,3,4]},"current_value_predefined_formula_type":{"format":"int32","type":"number","description":"The formula type for calculating the current value of the outcome.\nA value of `1` represents **Min**, `2` represents **Max**, `3` represents **Sum**, and `4` represents **Average**. If a **Custom formula** is used for calculating the current value, the value will be set to `null`.\n\nThis is used **only** for outcomes of type **Automatic** with a **Formula**, otherwise it remains `null`.\n","nullable":true,"enum":[1,2,3,4]},"weight":{"format":"int32","type":"integer","default":1,"description":"Used to calculate overall progress for initiatives with multiple outcomes. This positive numeric value (not a percentage) represents the relative importance of each outcome."},"created_at":{"format":"date-time","type":"string","description":"The date and time when the outcome was created in `ISO 8601` format with timezone offset.","example":"2025-07-01 00:00:00"},"checkpoints":{"type":"array","description":"Contains a list of the checkpoints set as intermediate targets for the outcome.","items":{"$ref":"#\/components\/schemas\/CardOutcomeCheckpointWithId"}},"links_to_cards":{"type":"array","description":"Contains a list of the links to cards associated with the outcome. Each reference to another outcome's value is added as a **separate** link.","items":{"$ref":"#\/components\/schemas\/CardOutcomeLinksToCards"}},"links_to_outcomes":{"type":"array","description":"Contains a list of the links to outcomes associated with the outcome. It allows the values of other outcomes to be used in the formula. Usually the outcomes of **parent** cards have links to their children's outcomes.\n\nEach reference to another outcome's value is added as a **separate** link. This is used **only** for outcomes of type **Automatic** with a **Formula**.","items":{"$ref":"#\/components\/schemas\/CardOutcomeLinksToOutcomes"}},"links_from_outcomes":{"type":"array","description":"Contains a list of the links from outcomes associated with the outcome. It allows the values of this outcome to be used in the formulas of other outcomes. Usually the outcomes of **child** cards have links from their parents' outcomes.\n\nEach reference to another outcome's value is added as a **separate** link. This is used **only** for outcomes of type **Automatic** with a **Formula**.","items":{"$ref":"#\/components\/schemas\/CardOutcomeLinksFromOutcomes"}}}},"CardOutcomeLinksToCards":{"title":"Card outcome link to card","description":"Card outcome link to card data.","type":"object","properties":{"link_id":{"format":"int32","type":"integer","description":"The unique identifier of the link to the card."},"card_id":{"format":"int32","type":"integer","description":"The unique identifier of the card to which the outcome is linked."},"color":{"type":"string","description":"The color of the link in hexadecimal format.","example":800080,"default":null,"nullable":true}}},"CardOutcomeLinksToOutcomes":{"title":"Card outcome link to outcome","description":"Card outcome link to outcome data.","type":"object","properties":{"link_id":{"format":"int32","type":"integer","description":"The unique identifier of the link to the outcome."},"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome to which the outcome is linked."},"color":{"type":"string","description":"The color of the link in hexadecimal format.","example":800080,"default":null,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome to which the outcome is linked."}}},"CardOutcomeLinksFromOutcomes":{"title":"Card outcome link from outcome","description":"Card outcome link from outcome data.","type":"object","properties":{"link_id":{"format":"int32","type":"integer","description":"The unique identifier of the link from the outcome."},"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the outcome from which the outcome is linked."},"color":{"type":"string","description":"The color of the link in hexadecimal format.","example":800080,"default":null,"nullable":true},"name":{"type":"string","minLength":1,"maxLength":255,"description":"The name of the outcome from which the outcome is linked."}}},"CardOutcomeCheckpoint":{"title":"Card outcome checkpoint","description":"Card outcome checkpoint data.","type":"object","properties":{"time":{"format":"date-time","type":"string","description":"The target date and time for achieving the checkpoint value in `ISO 8601` format with timezone offset.","example":"2024-07-20T12:00:00+00:00"},"name":{"type":"string","description":"The name of the checkpoint.","minLength":1,"maxLength":250},"value":{"format":"double","type":"number","description":"The value of the checkpoint.","minimum":-1000000000000000,"maximum":1000000000000000}}},"CardOutcomeCheckpointWithId":{"allOf":[{"type":"object","title":"Card outcome checkpoint","description":"Card outcome checkpoint data.","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the checkpoint."}}},{"$ref":"#\/components\/schemas\/CardOutcomeCheckpoint"}]},"CardOutcomeValue":{"title":"Card outcome value","description":"Card outcome value data","type":"object","properties":{"value":{"format":"double","type":"number","minimum":-1000000000000000,"maximum":1000000000000000,"description":"The numerical value of the card outcome, constrained within the specified range."},"time":{"format":"date-time","type":"string","description":"The timestamp indicating when the card outcome value was recorded."},"note":{"type":"string","description":"Note for the outcome value."},"last_modified_by_user_id":{"format":"int32","type":"integer","description":"The ID of the user who last modified the value."}}},"CardOutcomeValueWithIdAndOutcomeId":{"allOf":[{"type":"object","title":"Card outcome value","description":"Card outcome value data","properties":{"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier for the card outcome."}}},{"$ref":"#\/components\/schemas\/CardOutcomeValueWithId"}]},"CardOutcomeValueWithId":{"allOf":[{"type":"object","title":"Card outcome value","description":"Card outcome value data","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier for the card outcome value."}}},{"$ref":"#\/components\/schemas\/CardOutcomeValue"}]},"CardOutcomeValueForecast":{"title":"Card outcome value forecast","description":"Card outcome value forecast data","type":"object","properties":{"predictions":{"description":"A list of forecasted values for the card outcome, each associated with a specific date.\nThe predictions cover at least the next 30 days or extend to the latest of the card's deadline or planned end date, if they occur after the 30 day period.\n","type":"array","items":{"type":"object","properties":{"date":{"description":"The date for which the forecasted value is provided.","format":"date","type":"string"},"value":{"description":"The forecasted value for the card outcome on the specified date.","format":"int32","type":"integer"}}}},"onDeadline":{"description":"The forecasted value of the card outcome on the card's deadline date.","type":"object","properties":{"date":{"description":"The deadline date for the card outcome, formatted as `YYYY-MM-DD`.","format":"date","type":"string"},"value":{"description":"The forecasted value of the card outcome on the deadline date.","format":"int32","type":"integer"}}},"onPlannedEndDate":{"description":"The forecasted value of the card outcome on the card's planned end date.","type":"object","properties":{"date":{"description":"The planned end date for the card outcome, formatted as `YYYY-MM-DD`.","format":"date","type":"string"},"value":{"description":"The forecasted value of the card outcome on the planned end date.","format":"int32","type":"integer"}}},"onTargetValue":{"description":"The forecasted date when the card outcome is expected to reach or surpass the target value, along with the forecasted value on that date.","type":"object","properties":{"date":{"description":"The date when the card outcome is expected to reach or surpass the target value, formatted as `YYYY-MM-DD`.","format":"date","type":"string"},"value":{"description":"The forecasted value of the card outcome on the target value date.","format":"int32","type":"integer"}}}}},"CardSubtaskWithId":{"allOf":[{"type":"object","title":"Card subtask","description":"Card subtask data","properties":{"subtask_id":{"format":"int32","type":"integer","description":"The unique identifier of the subtask."}}},{"$ref":"#\/components\/schemas\/CardSubtask"}]},"CardSubtask":{"title":"Card subtask","description":"Card subtask data","type":"object","required":["description"],"properties":{"description":{"type":"string","minLength":1,"description":"The contents of the subtask."},"owner_user_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the user who is assigned to the subtask."},"deadline":{"format":"date-time","type":"string","nullable":true,"description":"The deadline for the subtask, represented in `ISO 8601` format with timezone offset."},"finished_at":{"format":"date-time","type":"string","nullable":true,"description":"The date and time when the subtask was marked as finished, in `ISO 8601` format with timezone offset."},"created_at":{"format":"date-time","type":"string","nullable":true,"description":"The date and time when the subtask was created, in `ISO 8601` format with timezone offset."},"position":{"format":"int32","type":"integer","description":"The position of the subtask within the list of subtasks. `0` represents the top-most position."},"attachments":{"type":"array","items":{"$ref":"#\/components\/schemas\/CardAttachmentWithPosition"}}}},"CardAttachment":{"title":"Card attachment","description":"Card attachment data","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the attachment."},"file_name":{"type":"string","description":"The name of the file associated with the attachment.","minLength":1,"maxLength":250},"link":{"type":"string","description":"The link to the attachment file. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","example":"\/files\/abc123xyz"}}},"CoverImage":{"title":"Cover image","description":"Cover image data.","type":"object","properties":{"attachment_id":{"format":"int32","type":"integer","description":"The unique identifier of the card attachment used as the cover image."},"width":{"format":"int32","type":"integer","description":"The width of the cover image in pixels."},"height":{"format":"int32","type":"integer","description":"The height of the cover image in pixels."},"link":{"type":"string","description":"The link to the cover image file. For images uploaded as attachments through the application UI, this link is represented as a path that starts with `\/coverImages\/` followed by the unique string identifier for the attached file.","example":"\/coverImages\/abc123xyz"}}},"CoverImageNullable":{"title":"Cover image","description":"Cover image data","type":"object","nullable":true,"properties":{"attachment_id":{"format":"int32","type":"integer"},"width":{"format":"int32","type":"integer"},"height":{"format":"int32","type":"integer"},"link":{"type":"string"}}},"CardAttachmentWithPosition":{"allOf":[{"$ref":"#\/components\/schemas\/CardAttachment"},{"type":"object","description":"Card attachment with included position value.","properties":{"position":{"format":"int32","type":"integer","description":"The position of the attachment within the list of attachments. `0` represents the top-most position."}}}]},"CardCommentAttachment":{"title":"Card comment attachment","description":"Card comment attachment data","type":"object","properties":{"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file associated with the attachment."},"link":{"type":"string","description":"The link to the attachment file.\nFor files uploaded through the application UI, this is a path starting with `\/files\/` followed by a unique string identifier.\nFor external files, this can be a full URL pointing to the file's location.\n","example":"\/files\/abc123xyz"}}},"CardCommentAttachmentWithId":{"allOf":[{"type":"object","title":"Card comment attachment data","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the card comment attachment."}}},{"$ref":"#\/components\/schemas\/CardCommentAttachment"}]},"CardSticker":{"title":"Card sticker","description":"Card sticker data.","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the sticker added to the card."},"card_id":{"format":"int32","type":"integer","description":"The unique identifier of the card to which the sticker is added."},"sticker_id":{"format":"int32","type":"integer","description":"The unique identifier of the sticker itself."}}},"CardTag":{"title":"Card tag","description":"Card tag data","type":"object","properties":{"tag_id":{"format":"int32","type":"integer","description":"The ID of the tag."}}},"CardCustomFieldDataCommon":{"title":"Card Custom Field","description":"Card custom field data","type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The unique identifier of the custom field."}}},"CardCustomFieldDataSingleLine":{"title":"Single-Line Text","description":"Card custom field data - single-line text","type":"object","properties":{"value":{"type":"string","description":"The value of the single-line text custom field."},"display_value":{"type":"string","description":"The formatted or displayed value of the single-line text custom field."}}},"CardCustomFieldDataSingleLineWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataSingleLine"}]},"CardCustomFieldDataMultiLine":{"title":"Multi-Line Text","description":"Card custom field data - multi-line text","type":"object","properties":{"value":{"type":"string","description":"The value of the multi-line text custom field."}}},"CardCustomFieldDataMultiLineWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataMultiLine"}]},"CardCustomFieldDataNumber":{"title":"Number","description":"Card custom field data - number","type":"object","properties":{"value":{"format":"double","type":"number","description":"The value of the number custom field."},"display_value":{"type":"string","description":"The formatted or displayed representation of the numeric value."}}},"CardCustomFieldDataNumberWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataNumber"}]},"CardCustomFieldDataDate":{"title":"Date","description":"Card custom field data - date","type":"object","properties":{"value":{"type":"string","description":"The value of the date custom field, which may be either a date or a datetime.","example":"\"2025-07-01\" for date, \n \"2025-07-20T12:00:00Z\" for datetime."}}},"CardCustomFieldDataDateWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDate"}]},"CardCustomFieldDataLink":{"title":"Link","description":"Card custom field data - link","type":"object","properties":{"value":{"type":"string","description":"The value of the link custom field."}}},"CardCustomFieldDataLinkWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataLink"}]},"CardCustomFieldDataDropdown":{"title":"Dropdown","description":"Card custom field data - dropdown","type":"object","properties":{"values":{"type":"array","description":"A list of values in the dropdown custom field.","items":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the dropdown value."},"position":{"format":"int32","type":"integer","description":"The position of the dropdown value within the list of values. `0` represents the top-most position."}}}}}},"CardCustomFieldDataDropdownWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataDropdown"}]},"CardCustomFieldDataContributor":{"title":"Contributor","description":"Card custom field data - contributor","type":"object","properties":{"contributors":{"type":"array","description":"A list of contributors for the custom field.","items":{"type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the contributor."}}}}}},"CardCustomFieldDataContributorWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataContributor"}]},"CardCustomFieldDataFile":{"title":"File","description":"Card custom field data - file","type":"object","properties":{"files":{"type":"array","description":"A list of file attachments for the custom field.","items":{"title":"Files","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the file attachment."},"file_name":{"type":"string","minLength":1,"maxLength":250,"description":"The name of the file attachment."},"link":{"type":"string","description":"The URL or path to access the file attachment."},"position":{"format":"int32","type":"integer","description":"The position of the file within the list of attachments. `0` represents the top-most position."}}}}}},"CardCustomFieldDataFileWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataFile"}]},"CardCustomFieldDataVote":{"title":"Vote","description":"Card custom field data - vote","type":"object","properties":{"votes":{"type":"array","description":"A list of votes for the custom field.","items":{"type":"object","properties":{"vote":{"format":"int32","type":"integer","enum":[0,1],"nullable":true,"description":"The vote value, which can be either `0` or `1`. A value of `0` indicates a negative vote, while a value of `1` indicates a positive vote."},"comment":{"type":"string","nullable":true,"description":"An optional comment associated with the vote."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who cast the vote."}}}}}},"CardCustomFieldDataVoteWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataVote"}]},"CardCustomFieldDataCardPicker":{"title":"Card Picker","description":"Card custom field data - card picker","type":"object","properties":{"selected_cards":{"type":"array","description":"A list of cards selected for the card picker custom field.","items":{"type":"object","properties":{"selected_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the selected card."},"position":{"format":"int32","type":"integer","description":"The position of the selected card within the list of selected cards. `0` represents the top-most position."}}}}}},"CardCustomFieldDataCardPickerWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCardPicker"}]},"CardCustomFieldDataCalculatedNumber":{"title":"Calculated Number","description":"Card custom field data - calculated number","type":"object","properties":{"value":{"format":"double","type":"number","description":"The value of the calculated number custom field."},"display_value":{"type":"string","description":"The formatted or displayed representation of the numeric value."}}},"CardCustomFieldDataCalculatedNumberWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedNumber"}]},"CardCustomFieldDataCalculatedDate":{"title":"Calculated Date","description":"Card custom field data - calculated date","type":"object","properties":{"value":{"type":"string","description":"The value of the date custom field."}}},"CardCustomFieldDataCalculatedDateWithFieldId":{"allOf":[{"$ref":"#\/components\/schemas\/CardCustomFieldDataCommon"},{"$ref":"#\/components\/schemas\/CardCustomFieldDataCalculatedDate"}]},"CardCustomFieldSelectedValue":{"title":"Card custom field selected value","description":"Represents the data for a selected value in a `dropdown` custom field associated with a card.","type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The unique identifier of the selected value."},"position":{"format":"int32","type":"integer","description":"The position of the selected value within the list of selected values. `0` represents the top-most position."}}},"CardCustomFieldFile":{"title":"Card custom field file","description":"Card custom field file data","type":"object","properties":{"file_name":{"type":"string","description":"The name of the file associated with the custom field.","minLength":1,"maxLength":250},"link":{"type":"string","description":"The link to the file associated with the custom field. For files uploaded through the application UI, this link is represented as a path that starts with `\/files\/` followed by a unique string identifier for the file.","example":"\/files\/abc123xyz"},"position":{"description":"The position of the file within the list of files. `0` represents the top-most position.","format":"int32","type":"integer"}}},"CardCustomFieldSelectedCard":{"title":"Card custom field selected card","description":"Card custom field selected card data","type":"object","properties":{"selected_card_id":{"format":"int32","type":"integer","description":"The unique identifier of the selected card."},"position":{"format":"int32","type":"integer","description":"The position of the selected card within the list of selected cards. `0` represents the top-most position."}}},"CardColumnChecklistItem":{"title":"Checked card column checklist item","description":"Checked card column checklist item data","type":"object","properties":{"item_id":{"format":"int32","type":"integer","description":"The unique identifier of the checklist item."},"comment":{"type":"string","maxLength":65000,"description":"The comment left by the user when marking the checklist item as checked.","default":""}}},"LoggedTime":{"title":"Logged time","description":"Logged time data","type":"object","properties":{"logged_time_id":{"description":"The unique identifier of the logged time entry.","format":"int32","type":"integer"},"parent_card_id":{"description":"The ID of the parent card associated with the logged time entry.","format":"int32","type":"integer","nullable":true},"card_id":{"description":"The ID of the card associated with the logged time entry.","format":"int32","type":"integer"},"subtask_id":{"description":"The ID of the subtask associated with the logged time entry, if applicable.","format":"int32","type":"integer","nullable":true},"lane_id":{"description":"The ID of the lane associated with the logged time entry.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column associated with the logged time entry.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who created the logged time entry.","format":"int32","type":"integer"},"category_id":{"description":"The ID of the category associated with the logged time entry.","format":"int32","type":"integer","nullable":true},"date":{"description":"The date for which the logged time entry was created, in `YYYY-MM-DD` format.","format":"date","type":"string"},"time":{"description":"The duration of the logged time entry, represented in seconds.","format":"int32","type":"integer"},"comment":{"description":"A comment or description associated with the logged time entry.","type":"string"},"logged_at":{"description":"The date and time when the logged time entry was created, in `YYYY-MM-DD HH:mm:ss` format.","format":"date-time","type":"string"}}},"LoggedTimeHistoryEvent":{"title":"Logged time history event","description":"An event recorded whenever a create, update, or delete action is performed for logged time.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for logged time."},"logged_time_id":{"format":"int32","type":"integer","description":"The unique identifier of logged time."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted","transferred_to_card_after_subtask_deleted","updated_after_subtask_converted_to_card"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the logged time."},"details":{"type":"object","description":"Contains detailed information about the logged time associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `updated_after_subtask_converted_to_card` and `transferred_to_card_after_subtask_deleted`. For events of type `created` and `deleted` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the logged time before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the logged time."}}},"time":{"type":"string","format":"date","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"LoggedTimeCategory":{"title":"Logged time category","description":"Logged time category data","type":"object","properties":{"category_id":{"description":"The unique identifier of the logged time category.","format":"int32","type":"integer"},"icon_type":{"description":"The type of the icon associated with the card type. `0` represents a system icon, while `1` represents a user-defined icon.","format":"int32","type":"integer","default":0},"icon_id":{"description":"The ID of the icon used for the logged time category.","format":"int32","type":"integer","default":0},"label":{"description":"The label or name of the logged time category.","type":"string"},"description":{"description":"A description of the logged time category.","type":"string"},"color":{"description":"The color associated with the logged time category, represented in hexadecimal format.","type":"string"},"availability":{"description":"The availability status of the logged time category.\n\nA value of `0` represents **On-demand**, meaning the category can be manually added to or removed from boards.\n\nA value of `1` represents **Auto**, meaning the category is automatically added to all newly created boards.\n\nA value of `2` represents **Global**, meaning the category is automatically added to all boards across all workspaces. Once a category's availability is set to **Global**, only an Owner can change its availability again.","format":"int32","type":"integer","enum":[0,1,2],"default":0},"is_enabled":{"description":"Indicates whether the logged time category is enabled or disabled. A value of `1` means the category is enabled, while a value of `0` means it is disabled.","format":"int32","type":"integer","enum":[0,1]}}},"LoggedTimeCategoryCreateRequest":{"title":"Logged time category","description":"Logged time category data","type":"object","properties":{"label":{"type":"string"},"icon_type":{"format":"int32","type":"integer"},"icon_id":{"format":"int32","type":"integer"},"description":{"type":"string"},"color":{"type":"string"},"availability":{"format":"int32","type":"integer"},"is_enabled":{"format":"int32","type":"integer"},"category_id":{"format":"int32","type":"integer"}}},"LoggedTimeCategoryHistoryEvent":{"title":"Logged time category history event","description":"An event recorded whenever a create, update, or delete action is performed for a logged time category.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a logged time category."},"category_id":{"format":"int32","type":"integer","description":"The unique identifier of a logged time category."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","disabled","enabled","deleted","added_to_board","removed_from_board"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the logged time category."},"details":{"type":"object","description":"Contains detailed information about the logged time category associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `disabled` and `enabled`. For events of type `created`, `deleted`, `added_to_board` and `removed_from_board` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the logged time category before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the logged time category."}}},"time":{"type":"string","format":"date","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"BoardCardAndInitiativeViewSettings":{"title":"Board card and initiative view settings","description":"Board card and initiative view settings data.","type":"object","properties":{"card_card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["tiny","small","normal","big","auto"]},"card_attachments":{"description":"Controls how card attachments are displayed.","type":"string","enum":["icon","row","off"]},"card_id":{"description":"Controls how card id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"card_co_owners":{"description":"Controls how card co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"card_color_entire_surface":{"description":"Controls if card color cover the entire surface.","type":"string","enum":["on","off"]},"card_comments":{"description":"Controls if the card comments are displayed.","type":"string","enum":["on","off"]},"card_cover":{"description":"Controls if the card cover is displayed.","type":"string","enum":["on","off"]},"card_created_at":{"description":"Controls if the card's creation date is displayed.","type":"string","enum":["on","off"]},"card_custom_fields":{"description":"Controls how card custom fields are displayed.","type":"string","enum":["icon","row","off"]},"card_custom_fields_to_show":{"description":"Controls which card custom fields are displayed.","type":"string","enum":["all","custom"]},"card_custom_fields_ids":{"description":"Controls which card custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"card_custom_fields_only_filled":{"description":"Controls if only filled card custom fields are displayed.","type":"string","enum":["on","off"]},"card_cycle_time":{"description":"Controls how the card cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_deadline":{"description":"Controls how the card deadline is displayed.","type":"string","enum":["icon","row","off"]},"card_exit_criteria":{"description":"Controls how the card exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"card_last_modified":{"description":"Controls if the card's last modified date is displayed.","type":"string","enum":["on","off"]},"card_last_moved":{"description":"Controls if the card's last moved date is displayed.","type":"string","enum":["on","off"]},"card_links":{"description":"Controls how card links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row_bar","row","off"]},"card_include_parents":{"description":"Controls if parent cards are displayed.","type":"string","enum":["on","off"]},"card_include_children":{"description":"Controls if child cards are displayed.","type":"string","enum":["on","off"]},"card_include_relatives":{"description":"Controls if relative cards are displayed.","type":"string","enum":["on","off"]},"card_include_predecessors":{"description":"Controls if predecessor cards are displayed.","type":"string","enum":["on","off"]},"card_include_successors":{"description":"Controls if successor cards are displayed.","type":"string","enum":["on","off"]},"card_links_in_backlog":{"description":"Controls if card links in Backlog are displayed.","type":"string","enum":["on","off"]},"card_links_in_requested":{"description":"Controls if card links in Requested are displayed.","type":"string","enum":["on","off"]},"card_links_in_progress":{"description":"Controls if card links in In Progress are displayed.","type":"string","enum":["on","off"]},"card_links_in_done":{"description":"Controls if card links in Done are displayed.","type":"string","enum":["on","off"]},"card_links_in_archive":{"description":"Controls if card links in Archive are displayed.","type":"string","enum":["on","off"]},"card_link_order":{"description":"Controls the order of the card links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"card_link_group_by":{"description":"Controls how the card links are grouped.","type":"string","enum":["section","link_type","off"]},"card_link_type_group_order":{"description":"Controls the order of the card link types.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"card_local_cycle_time":{"description":"Controls how the card local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time":{"description":"Controls how the card logged time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time_with_subtasks":{"description":"Controls if the card logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"card_logged_time_with_children":{"description":"Controls if the card logged time with children is displayed.","type":"string","enum":["on","off"]},"card_owner":{"description":"Controls how the card owner is displayed.","type":"string","enum":["avatar_and_username","avatar_only","username_only","row","off"]},"card_priority":{"description":"Controls how the card priority is displayed.","type":"string","enum":["icon","row","off"]},"card_reporter":{"description":"Controls if the card reporter is displayed.","type":"string","enum":["on","off"]},"card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["icon","row","off"]},"card_stickers":{"description":"Controls how card stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"card_subtasks":{"description":"Controls how card subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"card_tags":{"description":"Controls how card tags are displayed.","type":"string","enum":["icon","row","off"]},"card_title":{"description":"Controls how the card title is displayed.","type":"string","enum":["short","medium","full"]},"card_type":{"description":"Controls how the card type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_width":{"description":"Controls the width of the initiative.","type":"string","enum":["small","normal","auto"]},"initiative_height":{"description":"Controls the height of the initiative.","type":"string","enum":["very_low","low","medium","high"]},"initiative_attachments":{"description":"Controls how initiative attachments are displayed.","type":"string","enum":["icon","row","off"]},"initiative_id":{"description":"Controls how initiative id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"initiative_co_owners":{"description":"Controls how initiative co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"initiative_color_entire_surface":{"description":"Controls if initiative color cover the entire surface.","type":"string","enum":["on","off"]},"initiative_comments":{"description":"Controls if the initiative comments are displayed.","type":"string","enum":["on","off"]},"initiative_cover":{"description":"Controls if the initiative cover is displayed.","type":"string","enum":["on","off"]},"initiative_created_at":{"description":"Controls if the initiative's creation date is displayed.","type":"string","enum":["on","off"]},"initiative_custom_fields":{"description":"Controls how initiative custom fields are displayed.","type":"string","enum":["icon","row","off"]},"initiative_custom_fields_to_show":{"description":"Controls which initiative custom fields are displayed.","type":"string","enum":["all","custom"]},"initiative_custom_fields_ids":{"description":"Controls which initiative custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"initiative_custom_fields_only_filled":{"description":"Controls if only filled initiative custom fields are displayed.","type":"string","enum":["on","off"]},"initiative_cycle_time":{"description":"Controls how the initiative cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_deadline":{"description":"Controls how the initiative deadline is displayed.","type":"string","enum":["icon","row","off"]},"initiative_exit_criteria":{"description":"Controls how the initiative exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"initiative_last_modified":{"description":"Controls if the initiative's last modified date is displayed.","type":"string","enum":["on","off"]},"initiative_last_moved":{"description":"Controls if the initiative's last moved date is displayed.","type":"string","enum":["on","off"]},"initiative_links":{"description":"Controls how initiative links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row","off"]},"initiative_include_parents":{"description":"Controls if parent initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_children":{"description":"Controls if child initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_relatives":{"description":"Controls if relative initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_predecessors":{"description":"Controls if predecessor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_successors":{"description":"Controls if successor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_backlog":{"description":"Controls if initiative links in Backlog are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_requested":{"description":"Controls if initiative links in Requested are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_progress":{"description":"Controls if initiative links in In Progress are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_done":{"description":"Controls if initiative links in Done are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_archive":{"description":"Controls if initiative links in Archive are displayed.","type":"string","enum":["on","off"]},"initiative_link_order":{"description":"Controls the order of the initiative links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"initiative_link_group_by":{"description":"Controls how the initiative links are grouped.","type":"string","enum":["section","link_type","off"]},"initiative_link_type_group_order":{"description":"Controls the order of the initiative link types.","type":"string","enum":["parent","child","relative","predecessor","successor"]},"initiative_local_cycle_time":{"description":"Controls how the initiative local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time":{"description":"Controls how the initiative logged time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time_with_subtasks":{"description":"Controls if the initiative logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"initiative_logged_time_with_children":{"description":"Controls if the initiative logged time with children is displayed.","type":"string","enum":["on","off"]},"initiative_outcomes":{"description":"Controls how initiative outcomes are displayed.","type":"string","enum":["icon","row","off"]},"initiative_owner":{"description":"Controls how the initiative owner is displayed.","type":"string","enum":["avatar_only","row","off"]},"initiative_priority":{"description":"Controls how the initiative priority is displayed.","type":"string","enum":["icon","row","off"]},"initiative_reporter":{"description":"Controls if the initiative reporter is displayed.","type":"string","enum":["on","off"]},"initiative_size":{"description":"Controls how the initiative size is displayed.","type":"string","enum":["icon","row","off"]},"initiative_stickers":{"description":"Controls how initiative stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"initiative_subtasks":{"description":"Controls how initiative subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"initiative_tags":{"description":"Controls how initiative tags are displayed.","type":"string","enum":["icon","row","off"]},"initiative_title":{"description":"Controls how the initiative title is displayed.","type":"string","enum":["short","medium","long","full"]},"initiative_type":{"description":"Controls how the initiative type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_start_date":{"description":"Controls how the initiative planned start date is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_end_date":{"description":"Controls how the initiative planned start end is displayed.","type":"string","enum":["icon","row","off"]},"initiative_progress":{"description":"Controls if the initiative work progress (completion percentage) is displayed.","type":"string","enum":["on","off"]}}},"BoardCardAndInitiativeViewSettingsUpdateRequest":{"title":"Board card and initiative view settings update request","description":"Board card and initiative view settings update request data.","type":"object","properties":{"card_card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["tiny","small","normal","big","auto"]},"card_attachments":{"description":"Controls how card attachments are displayed.","type":"string","enum":["icon","row","off"]},"card_id":{"description":"Controls how card id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"card_co_owners":{"description":"Controls how card co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"card_color_entire_surface":{"description":"Controls if card color cover the entire surface.","type":"string","enum":["on","off"]},"card_comments":{"description":"Controls if the card comments are displayed.","type":"string","enum":["on","off"]},"card_cover":{"description":"Controls if the card cover is displayed.","type":"string","enum":["on","off"]},"card_created_at":{"description":"Controls if the card's creation date is displayed.","type":"string","enum":["on","off"]},"card_custom_fields":{"description":"Controls how card custom fields are displayed.","type":"string","enum":["icon","row","off"]},"card_custom_fields_to_show":{"description":"Controls which card custom fields are displayed.","type":"string","enum":["all","custom"]},"card_custom_fields_ids":{"description":"Controls which card custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"card_custom_fields_only_filled":{"description":"Controls if only filled card custom fields are displayed.","type":"string","enum":["on","off"]},"card_cycle_time":{"description":"Controls how the card cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_deadline":{"description":"Controls how the card deadline is displayed.","type":"string","enum":["icon","row","off"]},"card_exit_criteria":{"description":"Controls how the card exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"card_last_modified":{"description":"Controls if the card's last modified date is displayed.","type":"string","enum":["on","off"]},"card_last_moved":{"description":"Controls if the card's last moved date is displayed.","type":"string","enum":["on","off"]},"card_links":{"description":"Controls how card links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row_bar","row","off"]},"card_include_parents":{"description":"Controls if parent cards are displayed.","type":"string","enum":["on","off"]},"card_include_children":{"description":"Controls if child cards are displayed.","type":"string","enum":["on","off"]},"card_include_relatives":{"description":"Controls if relative cards are displayed.","type":"string","enum":["on","off"]},"card_include_predecessors":{"description":"Controls if predecessor cards are displayed.","type":"string","enum":["on","off"]},"card_include_successors":{"description":"Controls if successor cards are displayed.","type":"string","enum":["on","off"]},"card_links_in_backlog":{"description":"Controls if card links in Backlog are displayed.","type":"string","enum":["on","off"]},"card_links_in_requested":{"description":"Controls if card links in Requested are displayed.","type":"string","enum":["on","off"]},"card_links_in_progress":{"description":"Controls if card links in In Progress are displayed.","type":"string","enum":["on","off"]},"card_links_in_done":{"description":"Controls if card links in Done are displayed.","type":"string","enum":["on","off"]},"card_links_in_archive":{"description":"Controls if card links in Archive are displayed.","type":"string","enum":["on","off"]},"card_link_order":{"description":"Controls the order of the card links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"card_link_group_by":{"description":"Controls how the card links are grouped.","type":"string","enum":["section","link_type","off"]},"card_link_type_group_order":{"description":"Controls the order of the card link types.","type":"array","items":{"type":"string","enum":["parent","child","relative","predecessor","successor"]}},"card_local_cycle_time":{"description":"Controls how the card local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time":{"description":"Controls how the card logged time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time_with_subtasks":{"description":"Controls if the card logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"card_logged_time_with_children":{"description":"Controls if the card logged time with children is displayed.","type":"string","enum":["on","off"]},"card_owner":{"description":"Controls how the card owner is displayed.","type":"string","enum":["avatar_and_username","avatar_only","username_only","row","off"]},"card_priority":{"description":"Controls how the card priority is displayed.","type":"string","enum":["icon","row","off"]},"card_reporter":{"description":"Controls if the card reporter is displayed.","type":"string","enum":["on","off"]},"card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["icon","row","off"]},"card_stickers":{"description":"Controls how card stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"card_subtasks":{"description":"Controls how card subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"card_tags":{"description":"Controls how card tags are displayed.","type":"string","enum":["icon","row","off"]},"card_title":{"description":"Controls how the card title is displayed.","type":"string","enum":["short","medium","full"]},"card_type":{"description":"Controls how the card type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_width":{"description":"Controls the width of the initiative.","type":"string","enum":["small","normal","auto"]},"initiative_height":{"description":"Controls the height of the initiative.","type":"string","enum":["very_low","low","medium","high"]},"initiative_attachments":{"description":"Controls how initiative attachments are displayed.","type":"string","enum":["icon","row","off"]},"initiative_id":{"description":"Controls how initiative id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"initiative_co_owners":{"description":"Controls how initiative co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"initiative_color_entire_surface":{"description":"Controls if initiative color cover the entire surface.","type":"string","enum":["on","off"]},"initiative_comments":{"description":"Controls if the initiative comments are displayed.","type":"string","enum":["on","off"]},"initiative_cover":{"description":"Controls if the initiative cover is displayed.","type":"string","enum":["on","off"]},"initiative_created_at":{"description":"Controls if the initiative's creation date is displayed.","type":"string","enum":["on","off"]},"initiative_custom_fields":{"description":"Controls how initiative custom fields are displayed.","type":"string","enum":["icon","row","off"]},"initiative_custom_fields_to_show":{"description":"Controls which initiative custom fields are displayed.","type":"string","enum":["all","custom"]},"initiative_custom_fields_ids":{"description":"Controls which initiative custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"initiative_custom_fields_only_filled":{"description":"Controls if only filled initiative custom fields are displayed.","type":"string","enum":["on","off"]},"initiative_cycle_time":{"description":"Controls how the initiative cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_deadline":{"description":"Controls how the initiative deadline is displayed.","type":"string","enum":["icon","row","off"]},"initiative_exit_criteria":{"description":"Controls how the initiative exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"initiative_last_modified":{"description":"Controls if the initiative's last modified date is displayed.","type":"string","enum":["on","off"]},"initiative_last_moved":{"description":"Controls if the initiative's last moved date is displayed.","type":"string","enum":["on","off"]},"initiative_links":{"description":"Controls how initiative links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row","off"]},"initiative_include_parents":{"description":"Controls if parent initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_children":{"description":"Controls if child initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_relatives":{"description":"Controls if relative initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_predecessors":{"description":"Controls if predecessor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_successors":{"description":"Controls if successor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_backlog":{"description":"Controls if initiative links in Backlog are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_requested":{"description":"Controls if initiative links in Requested are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_progress":{"description":"Controls if initiative links in In Progress are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_done":{"description":"Controls if initiative links in Done are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_archive":{"description":"Controls if initiative links in Archive are displayed.","type":"string","enum":["on","off"]},"initiative_link_order":{"description":"Controls the order of the initiative links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"initiative_link_group_by":{"description":"Controls how the initiative links are grouped.","type":"string","enum":["section","link_type","off"]},"initiative_link_type_group_order":{"description":"Controls the order of the initiative link types.","type":"array","items":{"type":"string","enum":["parent","child","relative","predecessor","successor"]}},"initiative_local_cycle_time":{"description":"Controls how the initiative local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time":{"description":"Controls how the initiative logged time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time_with_subtasks":{"description":"Controls if the initiative logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"initiative_logged_time_with_children":{"description":"Controls if the initiative logged time with children is displayed.","type":"string","enum":["on","off"]},"initiative_outcomes":{"description":"Controls how initiative outcomes are displayed.","type":"string","enum":["icon","row","off"]},"initiative_owner":{"description":"Controls how the initiative owner is displayed.","type":"string","enum":["avatar_only","row","off"]},"initiative_priority":{"description":"Controls how the initiative priority is displayed.","type":"string","enum":["icon","row","off"]},"initiative_reporter":{"description":"Controls if the initiative reporter is displayed.","type":"string","enum":["on","off"]},"initiative_size":{"description":"Controls how the initiative size is displayed.","type":"string","enum":["icon","row","off"]},"initiative_stickers":{"description":"Controls how initiative stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"initiative_subtasks":{"description":"Controls how initiative subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"initiative_tags":{"description":"Controls how initiative tags are displayed.","type":"string","enum":["icon","row","off"]},"initiative_title":{"description":"Controls how the initiative title is displayed.","type":"string","enum":["short","medium","long","full"]},"initiative_type":{"description":"Controls how the initiative type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_start_date":{"description":"Controls how the initiative planned start date is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_end_date":{"description":"Controls how the initiative planned start end is displayed.","type":"string","enum":["icon","row","off"]},"initiative_progress":{"description":"Controls if the initiative work progress (completion percentage) is displayed.","type":"string","enum":["on","off"]}}},"BoardCardAndInitiativeViewRequiredSettingsUpdateRequest":{"title":"Board card and initiative view settings update request","description":"Board card and initiative view settings update request data.","type":"object","required":["card_card_size","card_attachments","card_id","card_co_owners","card_color_entire_surface","card_comments","card_cover","card_created_at","card_custom_fields","card_custom_fields_to_show","card_custom_fields_ids","card_custom_fields_only_filled","card_cycle_time","card_deadline","card_exit_criteria","card_last_modified","card_last_moved","card_links","card_include_parents","card_include_children","card_include_relatives","card_include_predecessors","card_include_successors","card_links_in_backlog","card_links_in_requested","card_links_in_progress","card_links_in_done","card_links_in_archive","card_link_order","card_link_group_by","card_link_type_group_order","card_local_cycle_time","card_logged_time","card_logged_time_with_subtasks","card_logged_time_with_children","card_owner","card_priority","card_reporter","card_size","card_stickers","card_subtasks","card_tags","card_title","card_type","initiative_width","initiative_height","initiative_attachments","initiative_id","initiative_co_owners","initiative_color_entire_surface","initiative_comments","initiative_cover","initiative_created_at","initiative_custom_fields","initiative_custom_fields_to_show","initiative_custom_fields_ids","initiative_custom_fields_only_filled","initiative_cycle_time","initiative_deadline","initiative_exit_criteria","initiative_last_modified","initiative_last_moved","initiative_links","initiative_include_parents","initiative_include_children","initiative_include_relatives","initiative_include_predecessors","initiative_include_successors","initiative_links_in_backlog","initiative_links_in_requested","initiative_links_in_progress","initiative_links_in_done","initiative_links_in_archive","initiative_link_order","initiative_link_group_by","initiative_link_type_group_order","initiative_local_cycle_time","initiative_logged_time","initiative_logged_time_with_subtasks","initiative_logged_time_with_children","initiative_outcomes","initiative_owner","initiative_priority","initiative_reporter","initiative_size","initiative_stickers","initiative_subtasks","initiative_tags","initiative_title","initiative_type","initiative_planned_start_date","initiative_planned_end_date","initiative_progress"],"properties":{"card_card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["tiny","small","normal","big","auto"]},"card_attachments":{"description":"Controls how card attachments are displayed.","type":"string","enum":["icon","row","off"]},"card_id":{"description":"Controls how card id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"card_co_owners":{"description":"Controls how card co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"card_color_entire_surface":{"description":"Controls if card color cover the entire surface.","type":"string","enum":["on","off"]},"card_comments":{"description":"Controls if the card comments are displayed.","type":"string","enum":["on","off"]},"card_cover":{"description":"Controls if the card cover is displayed.","type":"string","enum":["on","off"]},"card_created_at":{"description":"Controls if the card's creation date is displayed.","type":"string","enum":["on","off"]},"card_custom_fields":{"description":"Controls how card custom fields are displayed.","type":"string","enum":["icon","row","off"]},"card_custom_fields_to_show":{"description":"Controls which card custom fields are displayed.","type":"string","enum":["all","custom"]},"card_custom_fields_ids":{"description":"Controls which card custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"card_custom_fields_only_filled":{"description":"Controls if only filled card custom fields are displayed.","type":"string","enum":["on","off"]},"card_cycle_time":{"description":"Controls how the card cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_deadline":{"description":"Controls how the card deadline is displayed.","type":"string","enum":["icon","row","off"]},"card_exit_criteria":{"description":"Controls how the card exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"card_last_modified":{"description":"Controls if the card's last modified date is displayed.","type":"string","enum":["on","off"]},"card_last_moved":{"description":"Controls if the card's last moved date is displayed.","type":"string","enum":["on","off"]},"card_links":{"description":"Controls how card links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row_bar","row","off"]},"card_include_parents":{"description":"Controls if parent cards are displayed.","type":"string","enum":["on","off"]},"card_include_children":{"description":"Controls if child cards are displayed.","type":"string","enum":["on","off"]},"card_include_relatives":{"description":"Controls if relative cards are displayed.","type":"string","enum":["on","off"]},"card_include_predecessors":{"description":"Controls if predecessor cards are displayed.","type":"string","enum":["on","off"]},"card_include_successors":{"description":"Controls if successor cards are displayed.","type":"string","enum":["on","off"]},"card_links_in_backlog":{"description":"Controls if card links in Backlog are displayed.","type":"string","enum":["on","off"]},"card_links_in_requested":{"description":"Controls if card links in Requested are displayed.","type":"string","enum":["on","off"]},"card_links_in_progress":{"description":"Controls if card links in In Progress are displayed.","type":"string","enum":["on","off"]},"card_links_in_done":{"description":"Controls if card links in Done are displayed.","type":"string","enum":["on","off"]},"card_links_in_archive":{"description":"Controls if card links in Archive are displayed.","type":"string","enum":["on","off"]},"card_link_order":{"description":"Controls the order of the card links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"card_link_group_by":{"description":"Controls how the card links are grouped.","type":"string","enum":["section","link_type","off"]},"card_link_type_group_order":{"description":"Controls the order of the card link types.","type":"array","items":{"type":"string","enum":["parent","child","relative","predecessor","successor"]}},"card_local_cycle_time":{"description":"Controls how the card local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time":{"description":"Controls how the card logged time is displayed.","type":"string","enum":["icon","row","off"]},"card_logged_time_with_subtasks":{"description":"Controls if the card logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"card_logged_time_with_children":{"description":"Controls if the card logged time with children is displayed.","type":"string","enum":["on","off"]},"card_owner":{"description":"Controls how the card owner is displayed.","type":"string","enum":["avatar_and_username","avatar_only","username_only","row","off"]},"card_priority":{"description":"Controls how the card priority is displayed.","type":"string","enum":["icon","row","off"]},"card_reporter":{"description":"Controls if the card reporter is displayed.","type":"string","enum":["on","off"]},"card_size":{"description":"Controls how the card size is displayed.","type":"string","enum":["icon","row","off"]},"card_stickers":{"description":"Controls how card stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"card_subtasks":{"description":"Controls how card subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"card_tags":{"description":"Controls how card tags are displayed.","type":"string","enum":["icon","row","off"]},"card_title":{"description":"Controls how the card title is displayed.","type":"string","enum":["short","medium","full"]},"card_type":{"description":"Controls how the card type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_width":{"description":"Controls the width of the initiative.","type":"string","enum":["small","normal","auto"]},"initiative_height":{"description":"Controls the height of the initiative.","type":"string","enum":["very_low","low","medium","high"]},"initiative_attachments":{"description":"Controls how initiative attachments are displayed.","type":"string","enum":["icon","row","off"]},"initiative_id":{"description":"Controls how initiative id is displayed.","type":"string","enum":["effective_id","custom_id","internal_id","off"]},"initiative_co_owners":{"description":"Controls how initiative co-owners are displayed.","type":"string","enum":["icon","row_avatars_and_usernames","row_avatars_only","row_usernames_only","off"]},"initiative_color_entire_surface":{"description":"Controls if initiative color cover the entire surface.","type":"string","enum":["on","off"]},"initiative_comments":{"description":"Controls if the initiative comments are displayed.","type":"string","enum":["on","off"]},"initiative_cover":{"description":"Controls if the initiative cover is displayed.","type":"string","enum":["on","off"]},"initiative_created_at":{"description":"Controls if the initiative's creation date is displayed.","type":"string","enum":["on","off"]},"initiative_custom_fields":{"description":"Controls how initiative custom fields are displayed.","type":"string","enum":["icon","row","off"]},"initiative_custom_fields_to_show":{"description":"Controls which initiative custom fields are displayed.","type":"string","enum":["all","custom"]},"initiative_custom_fields_ids":{"description":"Controls which initiative custom fields are displayed.","type":"array","items":{"format":"int32","type":"integer"}},"initiative_custom_fields_only_filled":{"description":"Controls if only filled initiative custom fields are displayed.","type":"string","enum":["on","off"]},"initiative_cycle_time":{"description":"Controls how the initiative cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_deadline":{"description":"Controls how the initiative deadline is displayed.","type":"string","enum":["icon","row","off"]},"initiative_exit_criteria":{"description":"Controls how the initiative exit criteria is displayed.","type":"string","enum":["icon","row_all","row_unchecked_only","off"]},"initiative_last_modified":{"description":"Controls if the initiative's last modified date is displayed.","type":"string","enum":["on","off"]},"initiative_last_moved":{"description":"Controls if the initiative's last moved date is displayed.","type":"string","enum":["on","off"]},"initiative_links":{"description":"Controls how initiative links are displayed.","type":"string","enum":["icon","row_compact","row_solid","row","off"]},"initiative_include_parents":{"description":"Controls if parent initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_children":{"description":"Controls if child initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_relatives":{"description":"Controls if relative initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_predecessors":{"description":"Controls if predecessor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_include_successors":{"description":"Controls if successor initiatives are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_backlog":{"description":"Controls if initiative links in Backlog are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_requested":{"description":"Controls if initiative links in Requested are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_progress":{"description":"Controls if initiative links in In Progress are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_done":{"description":"Controls if initiative links in Done are displayed.","type":"string","enum":["on","off"]},"initiative_links_in_archive":{"description":"Controls if initiative links in Archive are displayed.","type":"string","enum":["on","off"]},"initiative_link_order":{"description":"Controls the order of the initiative links.","type":"string","enum":["effective_id_asc","custom_id_asc","internal_id_asc","effective_id_desc","custom_id_desc","internal_id_desc","off"]},"initiative_link_group_by":{"description":"Controls how the initiative links are grouped.","type":"string","enum":["section","link_type","off"]},"initiative_link_type_group_order":{"description":"Controls the order of the initiative link types.","type":"array","items":{"type":"string","enum":["parent","child","relative","predecessor","successor"]}},"initiative_local_cycle_time":{"description":"Controls how the initiative local cycle time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time":{"description":"Controls how the initiative logged time is displayed.","type":"string","enum":["icon","row","off"]},"initiative_logged_time_with_subtasks":{"description":"Controls if the initiative logged time with subtasks is displayed.","type":"string","enum":["on","off"]},"initiative_logged_time_with_children":{"description":"Controls if the initiative logged time with children is displayed.","type":"string","enum":["on","off"]},"initiative_outcomes":{"description":"Controls how initiative outcomes are displayed.","type":"string","enum":["icon","row","off"]},"initiative_owner":{"description":"Controls how the initiative owner is displayed.","type":"string","enum":["avatar_only","row","off"]},"initiative_priority":{"description":"Controls how the initiative priority is displayed.","type":"string","enum":["icon","row","off"]},"initiative_reporter":{"description":"Controls if the initiative reporter is displayed.","type":"string","enum":["on","off"]},"initiative_size":{"description":"Controls how the initiative size is displayed.","type":"string","enum":["icon","row","off"]},"initiative_stickers":{"description":"Controls how initiative stickers are displayed.","type":"string","enum":["icon","row_icons_and_labels","row_icons_only","row_labels_only","off"]},"initiative_subtasks":{"description":"Controls how initiative subtasks are displayed.","type":"string","enum":["icon","row_all","row_unfinished_only","off"]},"initiative_tags":{"description":"Controls how initiative tags are displayed.","type":"string","enum":["icon","row","off"]},"initiative_title":{"description":"Controls how the initiative title is displayed.","type":"string","enum":["short","medium","long","full"]},"initiative_type":{"description":"Controls how the initiative type is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_start_date":{"description":"Controls how the initiative planned start date is displayed.","type":"string","enum":["icon","row","off"]},"initiative_planned_end_date":{"description":"Controls how the initiative planned start end is displayed.","type":"string","enum":["icon","row","off"]},"initiative_progress":{"description":"Controls if the initiative work progress (completion percentage) is displayed.","type":"string","enum":["on","off"]}}},"LinkedCard":{"title":"Linked card","description":"Linked card data.","type":"object","properties":{"position":{"format":"int32","type":"integer","description":"The position of the linked card in the list of links. `0` represents the first position."}}},"LinkedCardWithType":{"title":"Linked card with type","description":"Linked card data with type","type":"object","properties":{"card_id":{"format":"int32","type":"integer","description":"The ID of the linked card."},"link_type":{"type":"string","enum":["child","parent","relative","predecessor","successor"],"description":"The type of the link between the cards."},"position":{"format":"int32","type":"integer","description":"The position of the linked card in the list of links. `0` represents the first position."}}},"ParentChildLink":{"title":"Parent-Child link in a graph","description":"Parent-Child link data.","type":"object","properties":{"parent_id":{"format":"int32","type":"integer","description":"The unique identifier of the parent card in the link."},"child_id":{"format":"int32","type":"integer","description":"The unique identifier of the child card in the link."},"depth":{"format":"int32","type":"integer","description":"The hierarchical level of the child card relative to the specified parent card. A direct child has a depth of `1`, its child has a depth of `2`, and so on."}}},"PredecessorSuccessorLink":{"title":"Predecessor-Successor Link in a Graph","description":"Represents the relationship between a predecessor card and a successor card in a hierarchical graph. Includes details about the depth of the link in the graph.","type":"object","properties":{"successor_id":{"format":"int32","type":"integer","description":"The ID of the successor card."},"predecessor_id":{"format":"int32","type":"integer","description":"The ID of the predecessor card."},"depth":{"format":"int32","type":"integer","description":"The depth of the link in the graph, indicating the hierarchical level of the relationship."}}},"SuccessorPredecessorLink":{"title":"Successor-Predecessor Link in a Graph","description":"Represents the relationship between a successor card and a predecessor card in a hierarchical graph. Includes details about the depth of the link in the graph.","type":"object","properties":{"predecessor_id":{"format":"int32","type":"integer","description":"The ID of the predecessor card."},"successor_id":{"format":"int32","type":"integer","description":"The ID of the successor card."},"depth":{"format":"int32","type":"integer","description":"The depth of the link in the graph, indicating the hierarchical level of the relationship."}}},"Webhook":{"title":"Webhook","description":"Represents a webhook configuration for a board.\n","type":"object","properties":{"url":{"type":"string","minLength":1,"maxLength":65000,"description":"The endpoint URL that will receive webhook notifications. Must be a valid HTTP or HTTPS address."},"is_enabled":{"format":"int32","type":"integer","enum":[0,1],"description":"Indicates whether the webhook is enabled (`1`) or disabled (`0`). Disabled webhooks do not send notifications."},"board_id":{"format":"int32","type":"integer","description":"The ID of the board to which the webhook is attached."}}},"WebhookHistoryEvent":{"title":"Webhook history event","description":"An event recorded whenever a create, update, or delete action is performed for a webhook.","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a webhook."},"webhook_id":{"format":"int32","type":"integer","description":"The unique identifier of the webhook."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the webhook."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted"]},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"},"details":{"type":"object","description":"Contains detailed information about the webhook associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`. For events of type `created` and `deleted` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the webhook before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the webhook."}}}}},"StickerHistoryEvent":{"title":"Sticker history event","description":"Represents a single event in the sticker audit log, such as creation, update, enable\/disable, deletion, or board assignment changes.\n","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The ID of the sticker history event."},"sticker_id":{"format":"int32","type":"integer","description":"The ID of the sticker affected by the event."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action."},"event_type":{"type":"string","description":"The type of the event that occurred. Possible values include:\n- `created`: Sticker was created.\n- `updated`: Sticker was updated.\n- `enabled`: Sticker was enabled.\n- `disabled`: Sticker was disabled.\n- `deleted`: Sticker was deleted.\n- `added_to_board`: Sticker was added to a board.\n- `removed_from_board`: Sticker was removed from a board.\n- `updated_for_board`: Sticker properties were updated for a board.\n"},"details":{"type":"object","description":"Contains additional information about the event. The structure varies depending on the eventType.","oneOf":[{"title":"Created Event Details","description":"Details for `created` event. Contains the new sticker properties (except stickerId).","properties":{"icon_id":{"type":"integer","format":"int32","description":"The ID of the icon used for the sticker."},"label":{"type":"string","description":"The name of the created sticker."},"color":{"type":"string","description":"The color of the created sticker."},"availability":{"type":"integer","format":"int32","description":"The availability status of the sticker.\n- `0`: On-demand.\n- `1`: Auto.\n- `2`: Global.\n"},"icon_type":{"type":"integer","format":"int32","description":"The type of the icon used for the sticker.\n"},"is_enabled":{"type":"integer","format":"int32","description":"The enabled status of the sticker.\n- `0`: Disabled.\n- `1`: Enabled.\n"}}},{"title":"Updated Event Details","description":"Details for `updated` event. Contains previous state and changes.","properties":{"previousState":{"type":"object","description":"The previous state of the sticker before the update.","properties":{"icon_id":{"type":"integer","format":"int32","description":"The ID of the icon used for the sticker."},"label":{"type":"string","description":"The name of the sticker before the update."},"color":{"type":"string","description":"The color of the sticker before the update."},"availability":{"type":"integer","format":"int32","description":"The availability status of the sticker before the update."},"icon_type":{"type":"integer","format":"int32","description":"The type of the icon used for the sticker before the update."},"is_enabled":{"type":"integer","format":"int32","description":"The enabled status of the sticker before the update.\n- `0`: Disabled.\n- `1`: Enabled.\n"}}},"changes":{"type":"object","description":"The changes applied to the sticker.","anyOf":[{"title":"Icon ID","type":"object","properties":{"icon_id":{"type":"integer","format":"int32","description":"The new ID of the icon used for the sticker."}}},{"title":"Label","type":"object","properties":{"label":{"type":"string","description":"The new name of the sticker."}}},{"title":"Color","type":"object","properties":{"color":{"type":"string","description":"The new color of the sticker."}}},{"title":"Availability","type":"object","properties":{"availability":{"type":"integer","format":"int32","description":"The new availability status of the sticker.\n- `0`: On-demand.\n- `1`: Auto.\n- `2`: Global.\n"}}},{"title":"Icon Type","type":"object","properties":{"icon_type":{"type":"integer","format":"int32","description":"The new type of the icon used for the sticker.\n"}}}]}}},{"title":"Enabled Event Details","description":"Details for `enabled` event. Contains previous state and changes.","properties":{"previousState":{"type":"object","description":"The previous state of the sticker before the update.","properties":{"icon_id":{"type":"integer","format":"int32","description":"The ID of the icon used for the sticker."},"label":{"type":"string","description":"The name of the sticker before the update."},"color":{"type":"string","description":"The color of the sticker before the update."},"availability":{"type":"integer","format":"int32","description":"The availability status of the sticker before the update.\n- `0`: On-demand.\n- `1`: Auto.\n- `2`: Global.\n"},"icon_type":{"type":"integer","format":"int32","description":"The type of the icon used for the sticker before the update."},"is_enabled":{"type":"integer","format":"int32","description":"The enabled status of the sticker before the update.\n- `0`: Disabled.\n- `1`: Enabled.\n"}}},"changes":{"type":"object","description":"The changes applied to the sticker.","properties":{"is_enabled":{"type":"integer","format":"int32","description":"The new enabled status of the sticker.\n- `1`: Enabled.\n"}}}}},{"title":"Disabled Event Details","description":"Details `disabled` event. Contains previous state and changes.","properties":{"previousState":{"type":"object","description":"The previous state of the sticker before the update.","properties":{"icon_id":{"type":"integer","format":"int32","description":"The ID of the icon used for the sticker."},"label":{"type":"string","description":"The name of the sticker before the update."},"color":{"type":"string","description":"The color of the sticker before the update."},"availability":{"type":"integer","format":"int32","description":"The availability status of the sticker before the update.\n- `0`: On-demand.\n- `1`: Auto.\n- `2`: Global.\n"},"icon_type":{"type":"integer","format":"int32","description":"The type of the icon used for the sticker before the update."},"is_enabled":{"type":"integer","format":"int32","description":"The enabled status of the sticker before the update.\n- `0`: Disabled.\n- `1`: Enabled.\n"}}},"changes":{"type":"object","description":"The changes applied to the sticker.","properties":{"is_enabled":{"type":"integer","format":"int32","description":"The new disabled status of the sticker.\n- `0`: Disabled.\n"}}}}},{"title":"Deleted Event Details","description":"Details for `deleted` event. Contains the previous state of the deleted sticker (except stickerId).","properties":{"icon_id":{"type":"integer","format":"int32","description":"The ID of the icon used for the sticker."},"label":{"type":"string","description":"The name of the created sticker."},"color":{"type":"string","description":"The color of the created sticker."},"availability":{"type":"integer","format":"int32","description":"The availability status of the sticker.\n- `0`: On-demand.\n- `1`: Auto.\n- `2`: Global.\n"},"icon_type":{"type":"integer","format":"int32","description":"The type of the icon used for the sticker.\n"},"is_enabled":{"type":"integer","format":"int32","description":"The enabled status of the sticker.\n- `0`: Disabled.\n- `1`: Enabled.\n"}}},{"title":"Board Assignment Event Details","description":"Details for `added_to_board` event. Contains board assignment details.","properties":{"board_id":{"type":"integer","format":"int32","description":"The ID of the board the sticker was added to."}}},{"title":"Removed From Board Event Details","description":"Details for `removed_from_board` event. Contains board assignment details.","properties":{"board_id":{"type":"integer","format":"int32","description":"The ID of the board the sticker was removed from."}}},{"title":"Updated For Board Event Details","description":"Details for `updated_for_board` event. Contains previous board state and changes.","properties":{"previousState":{"type":"object","description":"The previous sticker assignment state for the board.","properties":{"board_id":{"type":"integer","format":"int32","description":"The ID of the board the sticker was assigned to."},"limit_per_board":{"type":"integer","format":"int32","description":"The previous limit of the sticker per board."},"limit_per_card":{"type":"integer","format":"int32","description":"The previous limit of the sticker per card."}}},"changes":{"type":"object","description":"The changes applied to the sticker assignment for the board.","anyOf":[{"title":"Limit Per Board","type":"object","properties":{"limit_per_board":{"type":"integer","format":"int32","description":"The new limit of the sticker per board."}}},{"title":"Limit Per Card","type":"object","properties":{"limit_per_card":{"type":"integer","format":"int32","description":"The new limit of the sticker per card."}}}]}}}]},"time":{"type":"string","format":"date","description":"The date and time when the event occurred, in ISO 8601 format."}}},"TagHistoryEvent":{"title":"Tag history event","description":"An event recorded whenever a create, update, or delete action is performed for a tag.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a tag."},"tag_id":{"format":"int32","type":"integer","description":"The unique identifier of the tag."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the tag."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","disabled","enabled","deleted","added_to_board","removed_from_board"]},"details":{"type":"object","description":"Contains detailed information about the tag associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `disabled` and `enabled`. For events of type `created`, `deleted`, `added_to_board` and `removed_from_board` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the tag before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the tag."},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}}}},"MilestoneHistoryEvent":{"title":"Milestone history event","description":"An event recorded whenever a create, update, or delete action is performed for a milestone.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a milestone."},"milestone_id":{"format":"int32","type":"integer","description":"The unique identifier of a milestone."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the milestone."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","disabled","enabled","deleted","added_to_board","removed_from_board"]},"details":{"type":"object","description":"Contains detailed information about the milestone associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `disabled` and `enabled`. For events of type `created`, `deleted`, `added_to_board` and `removed_from_board` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the milestone before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the milestone."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"CardTemplateHistoryEvent":{"title":"Card template history event","description":"Represents an event recorded when a create, update, or delete action is performed on a card template resource. This includes details about the action, the user who performed it, and the time it occurred.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The ID of the history event."},"template_id":{"format":"int32","type":"integer","description":"The ID of the card template associated with the event."},"event_type":{"type":"string","description":"The type of the event performed on the card template (e.g., created, updated, deleted)."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action."},"details":{"type":"object","nullable":true,"description":"Additional details about the event, such as changes made."},"time":{"type":"string","format":"date-time","description":"The date and time when the event occured, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"CardTypeHistoryEvent":{"title":"Card type history event","description":"An event recorded when an update, delete or create action is executed on a card type resource.","type":"object","properties":{"history_id":{"description":"The unique identifier of the history event.","format":"int32","type":"integer"},"type_id":{"description":"The ID of the card type associated with the event.","format":"int32","type":"integer"},"user_id":{"description":"The ID of the user who performed the action associated with the event.","format":"int32","type":"integer"},"event_type":{"description":"The type of the event performed on the card type (e.g., created, updated, deleted).","type":"string","enum":["created","updated","disabled","enabled","deleted","added_to_board","updated_for_board","type_removed_from_board"]},"details":{"type":"object"},"time":{"description":"The date and time when the event occurred, in `ISO 8601` format with timezone offset.","type":"string","format":"date","example":"2025-06-10T00:00:00+00:00"}}},"CardOutcomeHistoryEvent":{"title":"Card outcome History Event","description":"Represents the data for a historical event associated with a card outcome, including details about changes made to the outcome over time.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of the history event."},"outcome_id":{"format":"int32","type":"integer","description":"The unique identifier of the card outcome associated with the event."},"event_type":{"format":"int32","type":"integer","description":"The type of the event. Possible values are: \n - `1`: Outcome created \n - `2`: Outcome updated \n - `3`: Outcome deleted \n - `11`: Outcome value added \n - `12`: Outcome value updated \n - `13`: Outcome value deleted \n - `21`: Checkpoint added \n - `22`: Checkpoint updated \n - `23`: Checkpoint deleted "},"event_guid":{"type":"string","description":"A globally unique identifier for the event."},"user_id":{"format":"int32","type":"integer","description":"The unique identifier of the user who performed the action associated with the event."},"old_value":{"type":"string","nullable":true,"description":"The state of the outcome before the event occurred, if applicable."},"changes":{"type":"string","description":"The changes made during the event."},"time":{"type":"string","format":"date","description":"The date when the event occurred."}}},"ArrivalRuleHistoryEvent":{"title":"Arrival rule history event","description":"An event recorded whenever a create, update, delete, rule enabled, rule disabled action is performed for an arrival rule.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for an arrival rule."},"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of an arrival rule."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted","disabled","enabled"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the arrival rule."},"details":{"type":"object","description":"Contains detailed information about the arrival rule associated with the event.","properties":{"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of an arrival rule."},"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1]},"workflow_id":{"description":"The ID of the workflow to which the rule applies.","format":"int32","type":"integer"},"lane_id":{"description":"The ID of the lane to which the rule applies.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column to which the rule applies. **Cannot** be used in combination with `area_id`.","format":"int32","type":"integer"},"area_id":{"description":"The ID of the merged area to which the rule applies. **Cannot** be used in combination with `column_id`.","format":"int32","type":"integer"},"conditions":{"type":"array","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleFromBoardCondition"},{"$ref":"#\/components\/schemas\/RuleFromWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleFromColumnCondition"},{"$ref":"#\/components\/schemas\/RuleFromLaneCondition"},{"$ref":"#\/components\/schemas\/RuleFromSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"BaiPromptHistoryEvent":{"title":"BAI prompt history event","description":"An event recorded whenever a create, update, or delete action is performed for a BAI prompt.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a BAI prompt."},"prompt_id":{"format":"int32","type":"integer","description":"The unique identifier of a BAI prompt."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the BAI prompt."},"details":{"type":"object","description":"Contains detailed information about the BAI prompt associated with the event.","properties":{"type":{"format":"int32","type":"integer","description":"The type of the BAI prompt. **Comments and Emails**, **Subtasks** and **Summaries** prompts correspond respectively to the values `1`, `2` and `3`.","enum":[1,2,3]},"color":{"type":"string","description":"The color of the BAI prompt in hexadecimal format.","default":""},"icon_id":{"format":"int32","type":"integer","description":"The unique identifier for the icon associated with the BAI prompt.","default":0},"name":{"type":"string","description":"The **unique** name assigned to the BAI prompt.","minLength":1,"maxLength":250},"context":{"type":"string","description":"Describes the general situation in which the AI assistant will operate.","minLength":1,"maxLength":65000},"topics":{"type":"string","description":"Contains a list of additional important topics to include in the generated content. This is available **only** for **Comments and Emails** and **Subtasks** BAI prompts.","maxLength":65000},"fields_instructions":{"type":"string","description":"Instructions for the AI model on how to use the selected fields."},"suggest_missing_topics":{"format":"int32","type":"integer","description":"Indicates whether the AI model can suggesttopics that may be missing from the generated content.","enum":[0,1]},"fields":{"type":"array","description":"An array of objects that specifies the **card properties** (e.g, Title, Description, Subtasks) to be sent to the AI model for analysis.\n\nThe **order** of the objects reflects the **priority**, with the most important properties listed first.\n\nEach object defines a specific field type and name.","items":{"type":"object","properties":{"field_type":{"type":"string","description":"Determines the type of field being sent for analysis to the AI model. Default fields like **Title**, **Description**, etc., are of type `plain`, while custom fields are marked as `custom`.","enum":["plain","custom"]},"field_name":{"type":"string","description":"For fields of type `plain`, the name is stated explicitly (e.g., **Title**, **Description**). For fields of type `custom`, the field is represented by the [ID of the custom field](#\/operations\/getCustomFields#Request)."}}}},"icon_type":{"format":"int32","type":"integer","description":"The type of the icon associated with the BAI prompt. `0` represents a system icon, while `1` represents a user-defined icon.","default":0,"enum":[0,1]},"board_id":{"format":"int32","type":"integer","description":"The unique identifier of the board where the BAI prompt is used."},"author_user_id":{"format":"int32","type":"integer","description":"The ID of the user who created the BAI prompt."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"BlockReasonHistoryEvent":{"title":"Block reason history event","description":"An event recorded whenever a create, update, or delete action is performed for a block reason.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a block reason."},"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of a block reason."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the block reason."},"event_type":{"type":"string","description":"The type of the history event.","enum":["reason_created","reason_updated","reason_disabled","reason_enabled","reason_deleted","reason_added_to_board","reason_removed_from_board"]},"details":{"type":"object","description":"Contains detailed information about the block reason associated with the event.\n\nThe `previous_state` and `changes` objects are included only for the following event types: `reason_updated`, `reason_added_to_board`, and `reason_removed_from_board`.","properties":{"previous_state":{"type":"object","description":"Contains the state of the block reason before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the block reason."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"DepartureRuleHistoryEvent":{"title":"Departure rule history event","description":"An event recorded whenever a create, update, delete, rule enabled, rule disabled action is performed for a departure rule.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a departure rule."},"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of a departure rule."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted","disabled","enabled"]},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the departure rule."},"details":{"type":"object","description":"Contains detailed information about the departure rule associated with the event.","properties":{"rule_id":{"format":"int32","type":"integer","description":"The unique identifier of a departure rule."},"name":{"type":"string","description":"The name of the rule. Multiple rules **can** have the **same** name."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the rule is enabled.","enum":[0,1]},"workflow_id":{"description":"The ID of the workflow to which the rule applies.","format":"int32","type":"integer"},"lane_id":{"description":"The ID of the lane to which the rule applies.","format":"int32","type":"integer"},"column_id":{"description":"The ID of the column to which the rule applies. **Cannot** be used in combination with `area_id`.","format":"int32","type":"integer"},"area_id":{"description":"The ID of the merged area to which the rule applies. **Cannot** be used in combination with `column_id`.","format":"int32","type":"integer"},"conditions":{"type":"array","items":{"type":"object","oneOf":[{"$ref":"#\/components\/schemas\/RuleAttachmentCondition"},{"$ref":"#\/components\/schemas\/RuleEffectiveIdCondition"},{"$ref":"#\/components\/schemas\/RuleCustomIdCondition"},{"$ref":"#\/components\/schemas\/RuleChildCardsCondition"},{"$ref":"#\/components\/schemas\/RuleParentCardsCondition"},{"$ref":"#\/components\/schemas\/RuleRelativeCardsCondition"},{"$ref":"#\/components\/schemas\/RuleCoOwnersCondition"},{"$ref":"#\/components\/schemas\/RuleColorCondition"},{"$ref":"#\/components\/schemas\/RuleCommentsCondition"},{"$ref":"#\/components\/schemas\/RuleDeadlineCondition"},{"$ref":"#\/components\/schemas\/RuleDescriptionCondition"},{"$ref":"#\/components\/schemas\/RuleOwnerCondition"},{"$ref":"#\/components\/schemas\/RulePriorityCondition"},{"$ref":"#\/components\/schemas\/RuleReporterCondition"},{"$ref":"#\/components\/schemas\/RuleSizeCondition"},{"$ref":"#\/components\/schemas\/RuleStickersCondition"},{"$ref":"#\/components\/schemas\/RuleSubtaskProgressCondition"},{"$ref":"#\/components\/schemas\/RuleTagsCondition"},{"$ref":"#\/components\/schemas\/RuleTitleCondition"},{"$ref":"#\/components\/schemas\/RuleTypeCondition"},{"$ref":"#\/components\/schemas\/RuleBlockTimeCondition"},{"$ref":"#\/components\/schemas\/RuleCycleTimeCondition"},{"$ref":"#\/components\/schemas\/RuleLoggedTimeCondition"},{"$ref":"#\/components\/schemas\/RuleToBoardCondition"},{"$ref":"#\/components\/schemas\/RuleToWorkflowCondition"},{"$ref":"#\/components\/schemas\/RuleToColumnCondition"},{"$ref":"#\/components\/schemas\/RuleToLaneCondition"},{"$ref":"#\/components\/schemas\/RuleToSectionCondition"},{"$ref":"#\/components\/schemas\/RuleAuthorCondition"},{"$ref":"#\/components\/schemas\/RulePlannedEndDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldSingleLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldMultiLineTextCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDateCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldLinkCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldDropdownCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldContributorCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldFileCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldVoteCondition"},{"$ref":"#\/components\/schemas\/RuleCustomFieldCardPickerCondition"}]}}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"DiscardReasonHistoryEvent":{"title":"Discard reason history event","description":"An event recorded whenever a create, update, or delete action is performed for a discard reason.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for a discard reason."},"reason_id":{"format":"int32","type":"integer","description":"The unique identifier of a discard reason."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the discard reason."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","disabled","enabled","deleted","added_to_board","removed_from_board"]},"details":{"type":"object","description":"Contains detailed information about the discard reason associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`, `disabled` and `enabled`. For events of type `created`, `deleted`, `added_to_board` and `removed_from_board` only the `details` object is included.","properties":{"previous_state":{"type":"object","description":"Contains the state of the discard reason before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the discard reason."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"InternalAnnouncement":{"title":"Internal announcement","description":"Internal announcement data.","type":"object","properties":{"announcement_id":{"description":"The unique identifier of the internal announcement.","format":"int32","type":"integer"},"title":{"description":"The title of the internal announcement.","type":"string"},"description":{"description":"The content of the internal announcement.","type":"string"},"cover_image_link":{"description":"The URL of the cover image for the internal announcement. If not set, a default cover image should be used.","type":"string","nullable":true},"for_everyone":{"description":"Indicates whether the internal announcement is visible to all users.","format":"int32","type":"integer"},"for_owners":{"description":"Indicates whether the internal announcement is visible only to owners.","format":"int32","type":"integer"},"for_workspace_managers":{"description":"Indicates whether the internal announcement is visible only to workspace managers.","format":"int32","type":"integer"},"for_role_ids":{"description":"A list of role IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"for_team_ids":{"description":"A list of team IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"is_popover":{"description":"Indicates whether the internal announcement should be displayed as a popover.","format":"int32","type":"integer"},"start_time":{"description":"The date and time when the internal announcement becomes active.","type":"string","format":"date-time"},"end_time":{"description":"The date and time when the internal announcement expires. If not set, the announcement remains active indefinitely.","type":"string","format":"date-time"},"is_active":{"description":"Indicates whether the internal announcement is currently active.","format":"int32","type":"integer"},"recurring_definition":{"description":"Specifies the recurring schedule for the internal announcement, if applicable.","type":"object","nullable":true,"properties":{"type":{"type":"string","description":"The type of recurrence.\n- `cron`: A cron expression for advanced scheduling.\n- `every_day`: Recurs every day at a specific time.\n- `every_month`: Recurs every month on a specific date.\n- `every_week`: Recurs every week on a specific day.\n- `every_workday`: Recurs every workday (Monday to Friday).\n- `predefined_interval`: Recurs at a predefined interval, starting from a specific date.\n"},"execute_at_hour":{"format":"int32","type":"integer","description":"The hour at which the internal announcement should recur."}},"oneOf":[{"type":"object","title":"Advanced Schedule - Cron","properties":{"expression":{"type":"string","description":"A cron expression for advanced scheduling.","minLength":1,"maxLength":500,"example":"? * WED *"}}},{"type":"object","title":"Every day"},{"type":"object","title":"Every month","properties":{"at_dates":{"type":"array","items":{"format":"int32","type":"integer"},"description":"A list of dates in the month when the internal announcement should recur.","minItems":1,"maxItems":31},"at_last_day":{"type":"boolean","description":"Indicates whether the internal announcement should recur on the last day of the month.","enum":[true,false]}}},{"type":"object","title":"Every week","properties":{"weekdays":{"type":"array","items":{"type":"string","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"]},"description":"A list of weekdays when the internal announcement should recur."}}},{"type":"object","title":"Every workday"},{"type":"object","title":"Predefined interval","properties":{"start_date":{"type":"string","format":"date","description":"The date from which the internal announcement should start recurring, in `YYYY-MM-DD` format.","example":"2025-06-10"},"days":{"type":"integer","format":"int32","description":"The number of days between each recurrence of the internal announcement.","maximum":1000}}}]}}},"MyAnnouncement":{"title":"My announcement","description":"My announcement data","type":"object","properties":{"announcement_id":{"description":"The unique identifier of the announcement.","format":"int32","type":"integer"},"title":{"description":"The title of the announcement.","type":"string"},"description":{"description":"The content of the announcement.","type":"string"},"cover_image_link":{"description":"The URL of the cover image for the announcement. If not set, a default cover image should be used.","type":"string","nullable":true},"is_popover":{"description":"Indicates whether the announcement should be displayed as a popover.","format":"int32","type":"integer","enum":[0,1]},"start_time":{"description":"The date and time when the announcement becomes active, in ISO 8601 format including a time zone designator.","type":"string","format":"date-time","example":"2025-08-20T12:00:00+00:00"},"end_time":{"description":"The date and time when the announcement expires, in ISO 8601 format including a time zone designator. If not set, the announcement remains active indefinitely.","type":"string","format":"date-time","nullable":true,"example":"2025-08-25T12:00:00+00:00"},"is_active":{"description":"Indicates whether the announcement is currently active.","format":"int32","type":"integer","enum":[0,1]},"is_seen":{"description":"Indicates whether the announcement has been seen by the active user.","format":"int32","type":"integer","enum":[0,1]}}},"InternalAnnouncementHistoryEvent":{"title":"Internal announcement history event","description":"An event recorded whenever a create, update, or delete action is performed for an internal announcement.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The unique identifier of a history event for an internal announcement."},"announcement_id":{"format":"int32","type":"integer","description":"The unique identifier of an internal announcement."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action on the internal announcement."},"event_type":{"type":"string","description":"The type of the history event.","enum":["created","updated","deleted","for_role_added","for_role_removed","for_team_added","for_team_removed"]},"details":{"type":"object","description":"Contains detailed information about the internal announcement associated with the event.\n\nBoth the `previous_state` and `changes` objects are included for the events of type `updated`. Only the `details` object is included for **all** other event types.","properties":{"previous_state":{"type":"object","description":"Contains the state of the internal announcement before the event, capturing its properties prior to the change."},"changes":{"type":"object","description":"Contains the updated parameters reflecting changes made to the internal announcement."}}},"time":{"type":"string","format":"date-time","description":"The timestamp indicating when the history event occurred, in `ISO 8601` format with timezone offset.","example":"2025-06-10T00:00:00+00:00"}}},"InternalAnnouncementCreateRequest":{"description":"Internal announcement create request","required":["title","start_time","recurring_definition"],"type":"object","properties":{"title":{"description":"The title of the internal announcement.","type":"string","minLength":1,"maxLength":65000},"description":{"description":"The content of the internal announcement.","type":"string"},"cover_image_link":{"description":"Cover image link. If set to null, default cover image should be set.","type":"string","nullable":true},"for_everyone":{"description":"Indicates whether the internal announcement is visible to all users.","format":"int32","type":"integer","enum":[0,1],"default":0},"for_owners":{"description":"Indicates whether the internal announcement is visible only to owners.","format":"int32","type":"integer","enum":[0,1],"default":0},"for_workspace_managers":{"description":"Indicates whether the internal announcement is visible only to workspace managers.","format":"int32","type":"integer","enum":[0,1],"default":0},"for_role_ids":{"description":"A list of role IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"for_team_ids":{"description":"A list of team IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"start_time":{"description":"The date and time when the internal announcement becomes active, in ISO 8601 format including a time zone designator. Cannot be set together with `recurring_definition`.","type":"string","format":"date-time"},"end_time":{"description":"The date and time when the internal announcement expires, in ISO 8601 format including a time zone designator. If not set, the announcement remains active indefinitely.","type":"string","format":"date-time","nullable":true},"is_popover":{"description":"Indicates whether the internal announcement should be displayed as a popover.","format":"int32","type":"integer","enum":[0,1],"default":1},"recurring_definition":{"type":"object","description":"Specifies the recurring schedule for the internal announcement. Cannot be set together with `start_time`.","nullable":true,"properties":{"type":{"type":"string","description":"The type of recurrence.\n- `cron`: A cron expression for advanced scheduling.\n- `every_day`: Recurs every day at a specific time.\n- `every_month`: Recurs every month on a specific date.\n- `every_week`: Recurs every week on a specific day.\n- `every_workday`: Recurs every workday (Monday to Friday).\n- `predefined_interval`: Recurs at a predefined interval, starting from a specific date.\n"},"execute_at_hour":{"format":"int32","type":"integer","description":"The hour at which the internal announcement should recur.","maximum":23}},"oneOf":[{"type":"object","title":"Advanced Schedule - Cron","properties":{"expression":{"type":"string","description":"A cron expression for advanced scheduling.","minLength":1,"maxLength":500,"example":"? * WED *"}}},{"type":"object","title":"Every day"},{"type":"object","title":"Every month","properties":{"at_dates":{"type":"array","items":{"format":"int32","type":"integer"},"description":"A list of dates in the month when the internal announcement should recur.","minItems":1,"maxItems":31},"at_last_day":{"type":"boolean","description":"Indicates whether the internal announcement should recur on the last day of the month.","enum":[true,false]}}},{"type":"object","title":"Every week","properties":{"weekdays":{"type":"array","items":{"type":"string","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"]},"description":"A list of weekdays when the internal announcement should recur."}}},{"type":"object","title":"Every workday"},{"type":"object","title":"Predefined interval","properties":{"start_date":{"type":"string","format":"date","description":"The date from which the internal announcement should start recurring, in `YYYY-MM-DD` format.","example":"2025-06-10"},"days":{"type":"integer","format":"int32","description":"The number of days between each recurrence of the internal announcement.","maximum":1000}}}]}}},"InternalAnnouncementUpdateRequest":{"description":"Internal announcement update request","type":"object","properties":{"title":{"description":"The title of the internal announcement.","type":"string","minLength":1,"maxLength":65000},"description":{"description":"The content of the internal announcement.","type":"string"},"cover_image_link":{"description":"Cover image link. If set to null, default cover image should be set.","type":"string","nullable":true},"should_delete_existing_views":{"description":"If set to 1, all existing views for this announcement will be deleted, making it appear as unseen or as a popup for users who have already seen it. If set to 0, existing views will remain unchanged.","format":"int32","type":"integer","enum":[0,1]},"for_everyone":{"description":"Indicates whether the internal announcement is visible to all users.","format":"int32","type":"integer","enum":[0,1]},"for_owners":{"description":"Indicates whether the internal announcement is visible only to owners.","format":"int32","type":"integer","enum":[0,1]},"for_workspace_managers":{"description":"Indicates whether the internal announcement is visible only to workspace managers.","format":"int32","type":"integer","enum":[0,1]},"for_role_ids_to_add":{"description":"A list of role IDs to add that the internal announcement will be visible to.","type":"array","items":{"format":"int32","type":"integer"}},"for_role_ids_to_remove":{"description":"A list of role IDs to remove that the internal announcement will unavailable to.","type":"array","items":{"format":"int32","type":"integer"}},"for_team_ids_to_add":{"description":"A list of team IDs to add that the internal announcement will be visible to.","type":"array","items":{"format":"int32","type":"integer"}},"for_team_ids_to_remove":{"description":"A list of team IDs to remove that the internal announcement will unavailable to.","type":"array","items":{"format":"int32","type":"integer"}},"start_time":{"description":"The date and time when the internal announcement becomes active, in ISO 8601 format including a time zone designator.","type":"string","format":"date-time"},"end_time":{"description":"The date and time when the internal announcement expires, in ISO 8601 format including a time zone designator. If not set, the announcement remains active indefinitely.","type":"string","format":"date-time","nullable":true},"is_popover":{"description":"Indicates whether the internal announcement should be displayed as a popover.","format":"int32","type":"integer","enum":[0,1]},"recurring_definition":{"type":"object","description":"Specifies the recurring schedule for the internal announcement. Cannot be set together with `start_time`.","nullable":true,"properties":{"type":{"type":"string","description":"The type of recurrence.\n- `cron`: A cron expression for advanced scheduling.\n- `every_day`: Recurs every day at a specific time.\n- `every_month`: Recurs every month on a specific date.\n- `every_week`: Recurs every week on a specific day.\n- `every_workday`: Recurs every workday (Monday to Friday).\n- `predefined_interval`: Recurs at a predefined interval, starting from a specific date.\n"},"execute_at_hour":{"format":"int32","type":"integer","description":"The hour at which the internal announcement should recur.","maximum":23}},"oneOf":[{"type":"object","title":"Advanced Schedule - Cron","properties":{"expression":{"type":"string","description":"A cron expression for advanced scheduling.","minLength":1,"maxLength":500,"example":"? * WED *"}}},{"type":"object","title":"Every day"},{"type":"object","title":"Every month","properties":{"at_dates":{"type":"array","items":{"format":"int32","type":"integer"},"description":"A list of dates in the month when the internal announcement should recur.","minItems":1,"maxItems":31},"at_last_day":{"type":"boolean","description":"Indicates whether the internal announcement should recur on the last day of the month.","enum":[true,false]}}},{"type":"object","title":"Every week","properties":{"weekdays":{"type":"array","items":{"type":"string","enum":["MON","TUE","WED","THU","FRI","SAT","SUN"]},"description":"A list of weekdays when the internal announcement should recur."}}},{"type":"object","title":"Every workday"},{"type":"object","title":"Predefined interval","properties":{"start_date":{"type":"string","format":"date","description":"The date from which the internal announcement should start recurring, in `YYYY-MM-DD` format.","example":"2025-06-10"},"days":{"type":"integer","format":"int32","description":"The number of days between each recurrence of the internal announcement.","maximum":1000}}}]}}},"InternalAnnouncementCreateAndUpdateData":{"title":"Internal announcement create and update data","description":"Internal announcement create and update data","type":"object","properties":{"announcement_id":{"description":"The unique identifier of the internal announcement.","format":"int32","type":"integer"},"title":{"description":"The title of the internal announcement.","type":"string"},"description":{"description":"The content of the internal announcement.","type":"string"},"cover_image_link":{"description":"The URL of the cover image for the internal announcement. If not set, a default cover image should be used.","type":"string","nullable":true},"for_everyone":{"description":"Indicates whether the internal announcement is visible to all users.","format":"int32","type":"integer"},"for_owners":{"description":"Indicates whether the internal announcement is visible only to owners.","format":"int32","type":"integer"},"for_workspace_managers":{"description":"Indicates whether the internal announcement is visible only to workspace managers.","format":"int32","type":"integer"},"for_role_ids":{"description":"A list of role IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"for_team_ids":{"description":"A list of team IDs that the internal announcement is visible to.","type":"array","items":{"format":"int32","type":"integer"}},"start_time":{"description":"The date and time when the internal announcement becomes active, in ISO 8601 format including a time zone designator.","type":"string","format":"date-time"},"end_time":{"description":"The date and time when the internal announcement expires, in ISO 8601 format including a time zone designator. If not set, the announcement remains active indefinitely.","type":"string","format":"date-time"},"is_popover":{"description":"Indicates whether the internal announcement should be displayed as a popover.","format":"int32","type":"integer"},"recurring_definition":{"type":"object","description":"Specifies the recurring schedule for the internal announcement, if applicable.","nullable":true}}},"Setting":{"title":"Setting","description":"Setting data.","type":"object","properties":{"name":{"type":"string","description":"The name of the setting."},"type":{"type":"string","description":"The data type of the setting.","enum":["int","string","url","color"]},"restrictions":{"type":"object","description":"The restrictions applied to the setting. Restrictions can either define a **minimum** and **maximum** allowed value (`min`\/`max`) or a list of **allowed values** (`allowed_values`)."},"multiple_values":{"description":"Indicates whether the setting can have multiple values.","type":"boolean"},"default_value":{"description":"The default value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}],"nullable":true},"value":{"description":"The current value of the setting.","oneOf":[{"type":"integer"},{"type":"string"}],"nullable":true}}},"Permission":{"title":"Permission","description":"Permission data.","type":"object","properties":{"name":{"type":"string","description":"The name of the permission."},"available":{"type":"boolean","description":"Indicates whether the permission is available for the specified role.","default":0}}},"Privilege":{"title":"Privilege","description":"Privilege data.","type":"object","properties":{"name":{"type":"string","description":"The name of the privilege.","enum":["owner","create_team_workspaces","make_payments","manage_business_rules","manage_integrations","invite_users","manage_teams","manage_user_wip_limits","manage_roles","manage_card_elements","manage_security_settings","manage_dashboards","manage_logged_time","manage_worklog_configurations","access_audit_logs","enable_and_disable_users","delete_users","manage_outcome_rules","manage_data_fields"]},"available":{"type":"boolean","description":"Indicates whether the privilege is available for the specified user."}}},"BusinessRulesExecutionHistoryEvent":{"title":"Business rules history event","description":"An event recorded for each business rules execution.","type":"object","properties":{"id":{"format":"int32","type":"integer","description":"The unique identifier of the recorded business rule execution history event."},"business_rule_id":{"format":"int32","type":"integer","description":"The ID of the business rule that was executed."},"business_rule_name":{"type":"string","description":"The name of the business rule that was executed."},"executed_on_card_id":{"format":"int32","type":"integer","description":"The ID of the target card on which the business rule was executed."},"executed_at":{"type":"string","format":"date-time","description":"The date and time when the business rule was executed, in `ISO 8601` format with timezone offset.","example":"2025-06-10T08:08:51+00:00"}}},"CalculatedOutcomeValueRulesExecutionHistoryEvent":{"title":"Calculated outcome value rules history event","description":"An event recorded for each calculated outcome value rules execution","type":"object","properties":{"rule_id":{"format":"int32","type":"integer","description":"The ID of the calculated outcome value rule that was executed."},"card_id":{"format":"int32","type":"integer","description":"The ID of the card on which the calculated outcome value rule was executed."},"start_time":{"type":"string","format":"date-time","description":"The date and time when the calculated outcome value rule execution started, in `ISO 8601` format with timezone offset.","example":"2025-06-27T01:00:00+00:00"},"end_time":{"type":"string","format":"date-time","description":"The date and time when the calculated outcome value rule execution ended, in `ISO 8601` format with timezone offset.","example":"2025-06-27T01:10:00+00:00"},"request_status":{"type":"string","description":"The status of the request for the calculated outcome value rule execution.","enum":["ok","rule_missing_or_disabled","invalid_configuration","missing_card","archived_card","discarded_card","empty_url","invalid_url","request_timed_out","network_error","response_code_not_200","response_not_json","response_too_long","received_redirect","client_error","server_error"]},"limit_exceeded":{"format":"int32","type":"integer","description":"Indicates whether the execution of the calculated outcome value rule exceeded the limit."},"processing_result":{"type":"string","description":"A status message describing the result of the calculated outcome value rule execution.","enum":["ok","formula_produced_null_value","card_update_failed","invalid_formula","formula_evaluation_failed"]},"is_requested_by_user":{"format":"int32","type":"integer","description":"Indicates whether the calculated outcome value rule execution was triggered by a user or occurred automatically."}}},"EmailIntegrationError":{"title":"Email Integration Error","description":"The details about an error which occurred while an email was being processed","type":"object","properties":{"sender":{"description":"The email address of the sender.","format":"email","type":"string"},"receivers":{"description":"The email addresses of the receivers.","type":"array","items":{"format":"email","type":"string"}},"subject":{"description":"The subject of the email.","type":"string"},"error_message":{"description":"The error message describing the issue that occurred while processing the email.","type":"string"},"received_at":{"description":"The date and time when the email was received, in `ISO 8601` format with timezone offset.","type":"string","format":"date","example":"2025-08-06T09:15:25+00:00"}}},"EmailIntegrationHistoryEvent":{"title":"Email integration history event","description":"An event recorded when an email is send through email integration","type":"object","properties":{"sender":{"description":"The email address of the sender.","format":"email","type":"string"},"receivers":{"description":"The email addresses of the receivers.","format":"email","type":"string"},"subject":{"description":"The subject of the email.","type":"string"},"received_at":{"description":"The date and time when the email was received, in `ISO 8601` format with timezone offset.","type":"string","format":"date","example":"2025-08-06T09:15:25+00:00"},"status":{"description":"The status of the email sent through the email integration.","type":"string","enum":["success","failure"]}}},"CustomFieldHistoryEvent":{"title":"Custom Field History Event","description":"Represents an event recorded when a user performs a management action on custom fields.","type":"object","properties":{"history_id":{"format":"int32","type":"integer","description":"The ID of the history event."},"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field associated with the event."},"event_type":{"type":"string","description":"The type of action performed on the custom field."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user who performed the action."},"details":{"type":"object","description":"Additional details about the event, such as changes made.","oneOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldCreatedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldUpdatedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDisabledDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldEnabledDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDeletedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldAddedToBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldUpdatedForBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldRemovedFromBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueCreatedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueUpdatedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueDeletedDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueDisabledDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEnabledDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueAddedToBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueUpdatedForBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueRemovedFromBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventContributorAddedToBoardDetails"},{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventContributorRemovedFromBoardDetails"}]},"time":{"type":"string","format":"date","description":"The date and time when the event occurred, in `ISO 8601` format with timezone offset.","example":"2025-08-06T09:15:25+00:00"}}},"CustomFieldHistoryEventFieldDetails":{"type":"object","properties":{"category_id":{"format":"int32","type":"integer","nullable":true,"description":"The ID of the category to which the custom field belongs."},"name":{"type":"string","description":"The name of the custom field."},"description":{"type":"string","description":"A description of the custom field."},"color":{"type":"string","description":"The color associated with the custom field."},"type":{"type":"string","description":"The type of the custom field."},"is_always_present":{"format":"int32","type":"integer","description":"Indicates whether the custom field is always present."},"is_immutable":{"format":"int32","type":"integer","description":"Indicates whether the custom field is immutable."},"availability":{"format":"int32","type":"integer","description":"The availability level of the custom field."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the custom field is enabled."},"all_properties_are_locked":{"format":"int32","type":"integer","description":"Indicates whether all properties of the custom field are locked."},"allowed_values_are_locked":{"format":"int32","type":"integer","description":"Indicates whether the allowed values of the custom field are locked."},"prefix":{"type":"string","nullable":true,"description":"The prefix for the custom field values."},"suffix":{"type":"string","nullable":true,"description":"The suffix for the custom field values."},"decimal_places":{"format":"int32","type":"integer","nullable":true,"description":"The number of decimal places allowed for the custom field values."},"display_width":{"format":"int32","type":"integer","description":"The display width of the custom field."},"uniqueness_of_values":{"type":"string","nullable":true,"description":"Indicates the uniqueness constraint for the custom field values."},"min_number_of_values":{"format":"int32","type":"integer","description":"The minimum number of values allowed for the custom field."},"max_number_of_values":{"format":"int32","type":"integer","description":"The maximum number of values allowed for the custom field."},"min_value":{"type":"number","nullable":true,"description":"The minimum value allowed for the custom field."},"max_value":{"type":"number","nullable":true,"description":"The maximum value allowed for the custom field."},"value_with_time":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field value includes a time component.","enum":[0,1]},"value_is_rich_text":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field value supports rich text.","enum":[0,1]},"value_is_required":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field value is required.","enum":[0,1]},"formula":{"type":"string","nullable":true,"description":"The formula associated with the custom field."},"search":{"type":"string","nullable":true,"description":"The search configuration for the custom field."},"default_value":{"type":"string","nullable":true,"description":"The default value for the custom field."},"allow_other_value":{"format":"int32","type":"integer","description":"Indicates whether other values are allowed for the custom field."},"comment_is_required":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether a comment is required for the custom field.","enum":[0,1]},"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field."}}},"CustomFieldHistoryEventFieldCreatedDetails":{"title":"Field Created History Event Details","description":"Details about the creation of a custom field.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDetails"}]},"CustomFieldHistoryEventFieldUpdatedDetails":{"title":"Field Updated History Event Details","description":"Details about the update of a custom field.","type":"object","properties":{"previous_state":{"type":"object","description":"The state of the custom field before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDetails"}]},"changes":{"description":"The changes made to the custom field.","anyOf":[{"type":"object","title":"Name","properties":{"name":{"type":"string","description":"The name of the custom field.","maxLength":250}}},{"type":"object","title":"Description","properties":{"description":{"type":"string","description":"The description of the custom field.","maxLength":65535}}},{"type":"object","title":"Color","properties":{"color":{"type":"string","description":"The color associated with the custom field."}}},{"type":"object","title":"Immutable","properties":{"is_immutable":{"format":"int32","type":"integer","description":"Indicates whether the custom field is immutable.","enum":[0,1]}}},{"type":"object","title":"Is Always Present","properties":{"is_always_present":{"format":"int32","type":"integer","description":"Indicates whether the custom field is always present.","enum":[0,1]}}},{"type":"object","title":"All Properties Locked","properties":{"all_properties_are_locked":{"format":"int32","type":"integer","description":"Indicates whether all properties of the custom field are locked.","enum":[0,1]}}},{"type":"object","title":"Availability","properties":{"availability":{"format":"int32","type":"integer","description":"The availability level of the custom field.","enum":[0,1,2]}}},{"type":"object","title":"Category ID","properties":{"category_id":{"format":"int32","type":"integer","description":"The ID of the category associated with the custom field.","nullable":true}}}]}}},"CustomFieldHistoryEventFieldDisabledDetails":{"title":"Field Disabled History Event Details","description":"Details about the update of a custom field.","type":"object","properties":{"previous_state":{"type":"object","description":"The state of the custom field before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDetails"}]},"changes":{"description":"The changes made to the custom field. Always contains a single change indicating that the custom field was disabled.","type":"object","title":"Is Enabled","properties":{"is_enabled":{"format":"int32","type":"integer","description":"Indicates that the custom field was disabled. It will always be set to `0` in this case.","enum":[0]}}}}},"CustomFieldHistoryEventFieldEnabledDetails":{"title":"Field Enabled History Event Details","description":"Details about the update of a custom field.","type":"object","properties":{"previous_state":{"type":"object","description":"The state of the custom field before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDetails"}]},"changes":{"description":"The changes made to the custom field. Always contains a single change indicating that the custom field was enabled.","type":"object","title":"Is Enabled","properties":{"is_enabled":{"format":"int32","type":"integer","description":"Indicates that the custom field was enabled. It will always be set to `1` in this case.","enum":[1]}}}}},"CustomFieldHistoryEventFieldDeletedDetails":{"title":"Field Deleted History Event Details","description":"Details about the deletion of a custom field.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventFieldDetails"}]},"CustomFieldHistoryEventBoardDetails":{"type":"object","properties":{"board_id":{"type":"integer","description":"The ID of the board associated with the event."},"position":{"type":"integer","description":"The position of the custom field on the board."},"color":{"type":"string","description":"The color associated with the custom field."},"is_always_present":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field is always present on the board.","enum":[0,1]},"prefix":{"type":"string","nullable":true,"description":"The prefix for the custom field values."},"suffix":{"type":"string","nullable":true,"description":"The suffix for the custom field values."},"decimal_places":{"type":"integer","nullable":true,"description":"The number of decimal places allowed for the custom field values."},"display_width":{"type":"integer","nullable":true,"description":"The display width of the custom field."},"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]},"min_number_of_values":{"type":"integer","nullable":true,"description":"The minimum number of values allowed for the custom field."},"max_number_of_values":{"type":"integer","nullable":true,"description":"The maximum number of values allowed for the custom field."},"min_value":{"type":"number","nullable":true,"description":"The minimum value allowed for the custom field."},"max_value":{"type":"number","nullable":true,"description":"The maximum value allowed for the custom field."},"value_is_required":{"type":"boolean","nullable":true,"description":"Indicates whether the custom field value is required."},"formula":{"type":"string","nullable":true,"description":"The formula associated with the custom field."},"search":{"type":"string","nullable":true,"description":"The search configuration for the custom field."},"default_value":{"type":"string","nullable":true,"description":"The default value for the custom field."},"inherit_default_values":{"format":"int32","type":"integer","description":"Indicates whether the custom field inherits default values.","enum":[0,1]},"allow_other_value":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether other values are allowed for the custom field.","enum":[0,1]},"comment_is_required":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether a comment is required for the custom field.","enum":[0,1]}}},"CustomFieldHistoryEventFieldAddedToBoardDetails":{"title":"Field Added To Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventBoardDetails"}]},"CustomFieldHistoryEventFieldUpdatedForBoardDetails":{"title":"Field Updated For Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","properties":{"previous_board_state":{"type":"object","description":"The state of the custom field before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventBoardDetails"}]},"changes":{"type":"object","description":"The changes made to the custom field on the board.","anyOf":[{"type":"object","title":"Position","properties":{"position":{"type":"integer","description":"The new position of the custom field on the board."}}},{"type":"object","title":"Color","properties":{"color":{"type":"string","description":"The new color associated with the custom field."}}},{"type":"object","title":"Is Always Present","properties":{"is_always_present":{"format":"int32","type":"integer","description":"Indicates whether the custom field is always present on the board.","enum":[0,1]}}},{"type":"object","title":"Prefix","properties":{"prefix":{"type":"string","nullable":true,"description":"The new prefix for the custom field values."}}},{"type":"object","title":"Suffix","properties":{"suffix":{"type":"string","nullable":true,"description":"The new suffix for the custom field values."}}},{"type":"object","title":"Decimal Places","properties":{"decimal_places":{"type":"integer","nullable":true,"description":"The new number of decimal places allowed for the custom field values."}}},{"type":"object","title":"Display Width","properties":{"display_width":{"type":"integer","nullable":true,"description":"The new display width of the custom field."}}},{"type":"object","title":"Unique Values","properties":{"unique_values":{"format":"int32","type":"integer","description":"Controls whether the custom field must have a unique value on a board level.","default":0,"enum":[0,1]}}},{"type":"object","title":"Min Number of Values","properties":{"min_number_of_values":{"type":"integer","nullable":true,"description":"The new minimum number of values allowed for the custom field."}}},{"type":"object","title":"Max Number of Values","properties":{"max_number_of_values":{"type":"integer","nullable":true,"description":"The new maximum number of values allowed for the custom field."}}},{"type":"object","title":"Min Value","properties":{"min_value":{"type":"number","nullable":true,"description":"The new minimum value allowed for the custom field."}}},{"type":"object","title":"Max Value","properties":{"max_value":{"type":"number","nullable":true,"description":"The new maximum value allowed for the custom field."}}},{"type":"object","title":"Value Is Required","properties":{"value_is_required":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field value is required.","enum":[0,1]}}},{"type":"object","title":"Formula","properties":{"formula":{"type":"string","nullable":true,"description":"The new formula associated with the custom field."}}},{"type":"object","title":"Search","properties":{"search":{"type":"string","nullable":true,"description":"The new search configuration for the custom field."}}},{"type":"object","title":"Default Value","properties":{"default_value":{"type":"string","nullable":true,"description":"The new default value for the custom field."}}},{"type":"object","title":"Inherit Default Values","properties":{"inherit_default_values":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether the custom field inherits default values.","enum":[0,1]}}},{"type":"object","title":"Allow Other Value","properties":{"allow_other_value":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether other values are allowed for the custom field.","enum":[0,1]}}},{"type":"object","title":"Comment Is Required","properties":{"comment_is_required":{"format":"int32","type":"integer","nullable":true,"description":"Indicates whether a comment is required for the custom field.","enum":[0,1]}}}]}}},"CustomFieldHistoryEventFieldRemovedFromBoardDetails":{"title":"Field Removed From Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventBoardDetails"}]},"CustomFieldHistoryEventAllowedValueEventDetails":{"type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field associated with the allowed value event."},"position":{"type":"integer","description":"The position of the allowed value in the list of allowed values."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is enabled.","enum":[0,1]},"is_deafult":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is set as default.","enum":[0,1]},"value":{"type":"string","description":"The value of the allowed value."}}},"CustomFieldHistoryEventAllowedValueCreatedDetails":{"title":"Allowed Value Created History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEventDetails"},{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value that was created."}}}]},"CustomFieldHistoryEventAllowedValueUpdatedDetails":{"title":"Allowed Value Updated History Event Details","type":"object","description":"Additional details about the event, such as changes made.","properties":{"previous_allowed_value_data":{"type":"object","description":"The state of the allowed value before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEventDetails"}]},"changes":{"type":"object","description":"The changes made to the allowed value.","allOf":[{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value that was created."}}},{"anyOf":[{"type":"object","title":"Position","properties":{"position":{"type":"integer","description":"The new position of the allowed value in the list of allowed values."}}},{"type":"object","title":"Is Default","properties":{"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is set as default.","enum":[0,1]}}},{"type":"object","title":"Value","properties":{"value":{"type":"string","description":"The new value of the allowed value."}}}]}]}}},"CustomFieldHistoryEventAllowedValueDeletedDetails":{"title":"Allowed Value Deleted History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEventDetails"}]},"CustomFieldHistoryEventAllowedValueDisabledDetails":{"title":"Allowed Value Disabled History Event Details","type":"object","description":"Additional details about the event, such as changes made.","properties":{"previous_allowed_value_data":{"type":"object","description":"The state of the allowed value before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEventDetails"}]},"changes":{"type":"object","description":"The changes made to the allowed value.","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value that was created."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates that the allowed value was disabled. It will always be set to `0` in this case.","enum":[0]}}}}},"CustomFieldHistoryEventAllowedValueEnabledDetails":{"title":"Allowed Value Enabled History Event Details","type":"object","description":"Additional details about the event, such as changes made.","properties":{"previous_allowed_value_data":{"type":"object","description":"The state of the allowed value before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueEventDetails"}]},"changes":{"type":"object","description":"The changes made to the allowed value.","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value that was created."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates that the allowed value was enabled. It will always be set to `1` in this case.","enum":[1]}}}}},"CustomFieldHistoryEventAllowedValueBoardDetailes":{"type":"object","properties":{"value_id":{"format":"int32","type":"integer","description":"The ID of the allowed value associated with the event."},"board_id":{"type":"integer","description":"The ID of the board associated with the event."},"position":{"type":"integer","description":"The position of the allowed value on the board."},"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is enabled on the board.","enum":[0,1]},"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is set as default on the board.","enum":[0,1]}}},"CustomFieldHistoryEventAllowedValueAddedToBoardDetails":{"title":"Allowed Value Added To Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueBoardDetailes"}]},"CustomFieldHistoryEventAllowedValueUpdatedForBoardDetails":{"title":"Allowed Value Updated For Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","properties":{"previous_board_state":{"type":"object","description":"The state of the allowed value on the board before the update.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueBoardDetailes"}]},"changes":{"type":"object","description":"The changes made to the allowed value on the board.","anyOf":[{"type":"object","title":"Position","properties":{"position":{"type":"integer","description":"The new position of the allowed value on the board."}}},{"type":"object","title":"Is Default","properties":{"is_default":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is set as default on the board.","enum":[0,1]}}},{"type":"object","title":"Is Enabled","properties":{"is_enabled":{"format":"int32","type":"integer","description":"Indicates whether the allowed value is enabled on the board.","enum":[0,1]}}}]}}},"CustomFieldHistoryEventAllowedValueRemovedFromBoardDetails":{"title":"Allowed Value Removed From Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventAllowedValueBoardDetailes"}]},"CustomFieldHistoryEventContributorBoardDetails":{"type":"object","properties":{"field_id":{"format":"int32","type":"integer","description":"The ID of the custom field associated with the contributor event."},"board_id":{"type":"integer","description":"The ID of the board associated with the contributor event."},"user_id":{"format":"int32","type":"integer","description":"The ID of the user associated with the contributor event."}}},"CustomFieldHistoryEventContributorAddedToBoardDetails":{"title":"Contributor Added To Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventContributorBoardDetails"}]},"CustomFieldHistoryEventContributorRemovedFromBoardDetails":{"title":"Contributor Removed From Board History Event Details","type":"object","description":"Additional details about the event, such as changes made.","allOf":[{"$ref":"#\/components\/schemas\/CustomFieldHistoryEventContributorBoardDetails"}]},"ApiRequestHistoryEvent":{"title":"API request history event","description":"An event log capturing the details of a single request made to the API.","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of the user who made the request."},"resource":{"type":"string","description":"The resource that was accessed in the request.","example":"api\/v*\/cards\/*"},"method":{"type":"string","description":"The HTTP method used in the request.","enum":["get","patch","put","post","delete"]},"status_code":{"format":"int32","type":"integer","description":"The HTTP status code returned by the API.","enum":[200,"204",400,401,403,404,405,429,500,503]},"support_reference":{"format":"string","description":"A reference that you can use if you need to contact customer support about the error."},"time":{"type":"string","format":"date-time","description":"The exact date and time when the API request was executed, in `ISO 8601` format with timezone offset.","example":"2025-06-10T08:08:51+00:00"}}},"OldApiRequestHistoryEvent":{"title":"Old API request history event","description":"An event recorded for each request execution torwards the old API","type":"object","properties":{"user_id":{"description":"The ID of the user who made the request.","format":"int32","type":"integer"},"resource":{"description":"The resource that was accessed in the request.","type":"string"},"time":{"description":"The exact date and time when the API request was executed, in `ISO 8601` format with timezone offset.","type":"string","format":"date"}}},"ApiRequestHistoryAggregated":{"title":"An aggregated API request history event","description":"An event recorded for each request execution torwards the API aggregated by parameters","type":"object","properties":{"user_id":{"format":"int32","type":"integer","description":"The ID of the user who made the request."},"request_count":{"format":"int32","type":"integer","description":"The number of requests made by the user in the specified aggregation period."},"time":{"type":"string","format":"date-time","description":"The start of the aggregation period when the API request was executed, in `ISO 8601` format with timezone offset.\n\nIf the aggregation period specified in the query is `day`, all requests made by a user within that day will be grouped under a single timestamp, e.g. `2025-01-01T00:00:00+00:00`.\n\nIf the aggregation period is `hour`, requests are grouped by each hour, with timestamps indicating the start of the hour block, e.g. `2025-01-01T01:00:00+00:00`.","example":"2025-06-10T00:00:00+00:00"}}},"OldApiRequestHistoryAggregated":{"title":"An aggregated old API request history event","description":"An event recorded for each request execution torwards the old API aggregated by parameters","type":"object","properties":{"user_id":{"description":"The ID of the user who made the request.","format":"int32","type":"integer"},"aggregation_period":{"type":"string"},"time":{"description":"The exact date and time when the API request was executed, in `ISO 8601` format with timezone offset.","type":"string","format":"date","example":"2025-06-10T00:00:00+00:00"}}},"ApiLimit":{"title":"API request limit","description":"The hourly and minutely API request limits.","type":"object","properties":{"type":{"type":"string","description":"The type of the API limit.","enum":["hourly","minutely"]},"limit":{"description":"The allowed number of requests for each limit type, either `hourly` or `minutely`. By default, the hourly limit is `600`, and the minutely limit is `30`.","format":"int32","type":"integer"}}},"OldApiLimit":{"title":"Old API request limit","description":"A time-based request limit for the old API.","type":"object","properties":{"function":{"description":"The function for which the limit is applied.","type":"string"},"type":{"description":"The type of the API limit.","type":"string","enum":["hourly","minutely"]},"limit":{"description":"The allowed number of requests for each limit type, either `hourly` or `minutely`.","format":"int32","type":"integer"}}},"Pagination":{"title":"Pagination","description":"Contains pagination details.","type":"object","properties":{"pagination":{"type":"object","description":"Pagination metadata for the current result set.","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The current page number being returned.","type":"integer"},"results_per_page":{"description":"The number of results included on each page.","type":"integer"}}}}},"JsonExportWorkspaces":{"title":"Json export","description":"Contains the exported workspace management history data in JSON format.","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"Contains the exported data.","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Workspace name\", \"Author\", \"Details\", or \"Time\".\n","type":"array","items":{"type":"string"}},"items":{"description":"The exported items.","type":"array","items":{"type":"array","description":"Each item in the array corresponds to a row in the exported data, with values matching the titles.\nThe order of items in each row should match the order of titles.\n","items":{"type":"string","description":" The value of the field in the exported data. For example, if the title is \"Event Type\", the item might be fro example \"Created\" or \"Archived\".\nEvent types and description are:\n - `Created`: \"The workspace has been created.\"\n - `Updated`: \"The workspace name has been changed from ... to ... .\" or \"The workspace has been reordered within the dashboard ... .\"\n - `Archived`: \"The workspace has been archived.\"\n - `Unarchived`: \"The workspace has been unarchived.\"\n - `Board Created`: \"A board ... has been created.\"\n - `Board renamed`: \"The board name has been changed from ... to ... .\"\n - `Board deleted`: \"The board ... has been deleted.\"\n - `Board archived`: \"The board ... has been archived.\"\n - `Board unarchived`: \"The board ... has been unarchived.\"\n - `Board moved from workspace`: \"The board ... has been moved to another workspace.\"\n - `Board moved to workspace`: \"The board ... has been moved to this workspace.\"\n - `Workspace manager added`: \"The user ... has been added as a workspace manager.\"\n - `Workspace manager removed`: \"The user ... has been removed as a workspace manager.\"\n - `Added to dashboard`: \"The workspace has been added to the dashboard ... .\"\n - `Removed from dashboard`: \"The workspace has been removed from the dashboard ... .\" "}}}}}}}]},"JsonExportBoards":{"title":"Json export","description":"Contains the exported board management history data in JSON format.","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported board management history data.","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Board Name\", \"Author\", \"Details\", or \"Time\".\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a board management event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"The value for the corresponding column in the exported data.\nFor example, if the title is \"Event Type\", the value might be \"Board Created\" or \"Board Archived\".\n\n**Event types and their descriptions:**\n- `Board created`: The board has been created.\n- `Board updated`: The board settings have been changed (e.g., name, description, card size type, limits, default sender\/receiver, etc.).\n- `Board archived`: The board has been archived.\n- `Board unarchived`: The board has been unarchived.\n- `Board moved`: The board has been moved from one workspace to another.\n- `Workflow created`: A workflow (card, initiative, or timeline) has been created on the board.\n- `Workflow updated`: The workflow name or position has been changed.\n- `Workflow deleted`: The workflow has been deleted from the board.\n- `Workflow disabled`: The workflow has been disabled.\n- `Workflow enabled`: The workflow has been enabled.\n- `Lane created`: A lane has been created on the board.\n- `Lane renamed`: The lane name has been changed.\n- `Lane deleted`: The lane has been deleted from the board.\n- `Lane moved`: The lane position has been changed.\n- `Column created`: A column has been created on the board.\n- `Column renamed`: The column name has been changed.\n- `Column deleted`: The column has been deleted from the board.\n- `Column moved`: The column has been moved, reordered, or changed between main\/subcolumn or workflow sections.\n- `Cell limits updated`: The cell limits have been updated.\n- `Lane section limits updated`: The lane section limits have been updated.\n- `Merged areas updated`: The merged areas have been updated.\n- `Related boards updated`: Related boards have been added or removed.\n- `User added to board`: A user has been added to the board with a specific board role.\n- `User removed from board`: A user has been removed from the board.\n- `User board role changed`: The board role of a user has been changed.\n- `Discard reason added to board`: A discard reason has been added to the board.\n- `Discard reason removed from board`: A discard reason has been removed from the board.\n- `Block reason added to board`: A block reason has been added to the board.\n- `Block reason removed from board`: A block reason has been removed from the board.\n- `Sticker added to board`: A sticker has been added to the board.\n- `Sticker removed from board`: A sticker has been removed from the board.\n- `Card type added to board`: A card type has been added to the board.\n- `Card type removed from board`: A card type has been removed from the board.\n- `Tag added to board`: A tag has been added to the board.\n- `Tag removed from board`: A tag has been removed from the board.\n- `Card template added to board`: A card template has been added to the board.\n- `Card template removed from board`: A card template has been removed from the board.\n- `Custom field added to board`: A custom field has been added to the board.\n- `Custom field removed from board`: A custom field has been removed from the board.\n- `Team added to board`: A team has been added to the board with a specific board role.\n- `Team role changed for board`: The board role of a team has been changed.\n- `Team removed from board`: A team has been removed from the board.\n- `Cell card orderings updated`: The cell card ordering has been updated.\n- `Default board card and initiative view settings updated`: The default board card and initiative view settings have been updated.\n- `Logged time category added to board`: A logged time category has been added to the board.\n- `Logged time category removed from board`: A logged time category has been removed from the board.\n- `Cycle time columns added to board`: Columns have been added to the board cycle time configuration.\n- `Cycle time columns removed from board`: Columns have been removed from the board cycle time configuration.\n\nThe value for each event type may include additional details, such as the previous and new values for changed settings, names of users, teams, columns, or other entities involved in the event.\n"}}}}}}}]},"JsonExportUsers":{"title":"Json export","description":"Contains the exported user management history data in JSON format.","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported user management history data.","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as:\n- \"Event Type\"\n- \"Author\"\n- \"Author Email\"\n- \"Affected User\"\n- \"Affected User Email\"\n- \"Details\"\n- \"Time (timezone)\"\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a user management event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"The value for the corresponding column in the exported data.\nFor example, if the title is \"Event Type\", the value might be \"User confirmed\", \"Email changed\", \"Added to team\", etc.\n\n**Event types and their descriptions:**\n- `User confirmed`: The user has accepted an invitation or was created via SSO.\n- `User invited`: The user was invited to join the account.\n- `User re-invited`: The user was re-invited to join the account.\n- `User deleted`: The user account was deleted.\n- `Email changed`: The user's email address was changed.\n- `Username changed`: The user's username was changed.\n- `Realname changed`: The user's real name was changed.\n- `Avatar changed`: The user's avatar was changed.\n- `Email signature changed`: The user's email signature was changed.\n- `TFA changed`: The user's two-factor authentication settings were modified.\n- `TFA enabled`: Two-factor authentication was enabled.\n- `TFA disabled`: Two-factor authentication was disabled.\n- `TFA key changed`: The user's TFA key was changed.\n- `TFA key reset`: The user's TFA key was reset.\n- `Api key changed`: The user's API key was changed.\n- `Timezone changed`: The user's timezone was changed.\n- `Language changed`: The user's language preference was changed.\n- `Password changed`: The user's password was changed.\n- `User disabled`: The user account was disabled.\n- `User enabled`: The user account was enabled.\n- `WIP limits changed`: The user's work-in-progress limits were changed.\n- `Global privilege added`: A global privilege was granted to the user.\n- `Global privilege removed`: A global privilege was revoked from the user.\n- `Assigned as Workspace Manager`: The user was assigned as a workspace manager.\n- `Unassigned as Workspace Manager`: The user was unassigned as a workspace manager.\n- `Assigned to board`: The user was assigned to a board with a specific role.\n- `Unassigned from board`: The user was unassigned from a board.\n- `Board role changed`: The user's board role was changed.\n- `Added to team`: The user was added to a team.\n- `Removed from team`: The user was removed from a team.\n- `Added to team managers`: The user was added as a team manager.\n- `Removed from team managers`: The user was removed as a team manager.\n- `Added to dashboard page`: The user was added to a dashboard page.\n- `Change permissions for dashboard page`: The user's dashboard page permissions were changed.\n- `Removed from dashboard page`: The user was removed from a dashboard page.\n- `User attribute added`: A user attribute was added.\n- `User attribute updated`: A user attribute was updated.\n- `User attribute removed`: A user attribute was removed.\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, emails, board names, team names, role names, attribute names, and any relevant value changes.\nIf a referenced entity (user, board, team, etc.) has been deleted, its value will be shown as \"**Deleted [entity]**\".\n"}}}}}}}]},"JsonExportBusinessRules":{"title":"Json export","description":"Contains the exported business rule execution history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported business rule execution history data.\nIncludes column titles and the corresponding event data for each row.\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as:\n- \"Business rule name\"\n- \"Business rule ID\"\n- \"Executed on card ID\"\n- \"Executed at (timezone)\"\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a business rule execution event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported business rule execution event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"The value for the corresponding column in the exported data.\nFor example:\n- If the title is \"Business rule name\", the value is the name of the business rule.\n- If the title is \"Business rule ID\", the value is the unique identifier of the business rule.\n- If the title is \"Executed on card ID\", the value is the unique identifier of the card on which the rule was executed.\n- If the title is \"Executed at (timezone)\", the value is the date and time of execution, formatted according to the user's timezone.\n\nThe \"Details\" column (if present) provides a human-readable description of the execution, including rule names, card IDs, and execution timestamps.\n"}}}}}}}]},"JsonExportEmailIntegration":{"title":"Json export","description":"Contains the exported email integration history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported email integration history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are dynamically selected based on the requested fields, and may include:\n- \"Sender\"\n- \"Receivers\"\n- \"Subject\"\n- \"Status\"\n- \"Received at (timezone)\"\n- \"Card id\"\n- \"Event type\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Sender\", \"Receivers\", \"Subject\", \"Status\", \"Received at (timezone)\", \"Card id\", or \"Event type\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an email integration event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported email integration event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"The value for the corresponding column in the exported data.\nFor example:\n- If the title is \"Sender\", the value is the sender's email address.\n- If the title is \"Receivers\", the value is a semicolon-separated list of receiver email addresses.\n- If the title is \"Subject\", the value is the subject of the email.\n- If the title is \"Status\", the value is either \"Processed Successfully\" or \"Processed Unsuccessfully\" (based on the status).\n- If the title is \"Received at (timezone)\", the value is the date and time the email was received, formatted according to the user's timezone.\n- If the title is \"Card id\", the value is the ID of the card associated with the email event.\n- If the title is \"Event type\", the value is either \"Card Created\" or \"Card Updated\".\n\nThe value for each field may include additional details, such as formatted dates, status descriptions, and event type names.\n"}}}}}}}]},"JsonExportCalculatedOutcomeValueRules":{"title":"Json export","description":"Contains the exported calculated outcome value rule execution history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported calculated outcome value rule execution history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Rule name\"\n- \"Rule ID\"\n- \"Card ID\"\n- \"Started at (timezone)\"\n- \"Finished at (timezone)\"\n- \"Request status\"\n- \"Exceeded the result limit\"\n- \"Processing result\"\n- \"Requested by user\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Rule name\", \"Rule ID\", \"Card ID\", \"Started at (timezone)\", \"Finished at (timezone)\", \"Request status\", \"Exceeded the result limit\", \"Processing result\", or \"Requested by user\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a calculated outcome value rule execution event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported calculated outcome value rule execution event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"The value for the corresponding column in the exported data.\n\n**Examples for each column:**\n- \"Rule name\": \"Total Cost Calculation\", \"Deleted rule\"\n- \"Rule ID\": \"123\", \"456\"\n- \"Card ID\": \"789\", \"1011\"\n- \"Started at (timezone)\": \"2025-07-01 09:00:00\", \"2025-07-02 14:30:00\"\n- \"Finished at (timezone)\": \"2025-07-01 09:00:05\", \"2025-07-02 14:30:10\"\n- \"Request status\":\n - \"Successfully received data\"\n - \"The rule is missing or disabled\"\n - \"The configuration of the rule is invalid\"\n - \"The card has been deleted\"\n - \"The card has been archived\"\n - \"The card has been discarded\"\n - \"After processing the URL it was empty\"\n - \"After processing the URL it was invalid\"\n - \"The request timed out\"\n - \"The request failed due to a network error\"\n - \"The request succeeded but returned a code different from 200 OK\"\n - \"The request succeeded but the response was not a valid json\"\n - \"The request succeeded but the length of the response exceeds the allowed limit\"\n - \"Received a redirect\"\n - \"The request failed due to a client error\"\n - \"The request failed due to a server error\"\n- \"Exceeded the result limit\": \"yes\", \"no\"\n- \"Processing result\":\n - \"Successfully updated the card\"\n - \"The formula produced an empty value\"\n - \"Failed to update the card\"\n - \"The formula is invalid\"\n - \"There was an error while evaluating the formula\"\n- \"Requested by user\": \"yes\", \"no\"\n\nThe value for each field may include additional details, such as formatted dates, status descriptions, and result codes.\n"}}}}}}}]},"JsonExportEmailIntegrationErrors":{"title":"Json export","description":"Contains the exported email integration error log data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported email integration error log data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are dynamically selected based on the requested fields, and may include:\n- \"Sender\"\n- \"Receivers\"\n- \"Subject\"\n- \"Details\" (error message)\n- \"Received at (timezone)\"\n- \"Card id\"\n- \"Event type\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Sender\", \"Receivers\", \"Subject\", \"Details\", \"Received at (timezone)\", \"Card id\", or \"Event type\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an email integration error event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported email integration error event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an email integration error event.\n\n**Possible values for each column:**\n- \"Sender\": The email address of the sender (e.g. {senderEmail}).\n- \"Receivers\": A semicolon-separated list of receiver email addresses (e.g. {receiverEmail1}; {receiverEmail2}).\n- \"Subject\": The subject of the email (e.g. {subject}).\n- \"Details\": The error message describing the issue that occurred while processing the email. Possible values include:\n - \"Failed to process email due to invalid format\"\n - \"Attachment missing\"\n - \"Timeout while processing\"\n - \"No card found for this email\"\n - \"Failed to create card\"\n - \"Failed to update card\"\n - \"Invalid event type\"\n - \"Invalid receiver address\"\n - \"Invalid sender address\"\n - \"Invalid integration email\"\n - \"Invalid subject\"\n - \"Invalid attachment\"\n - \"Invalid card data\"\n - \"Invalid board ID\"\n - \"Invalid workflow ID\"\n - \"Invalid API key\"\n - \"Request timed out\"\n - \"Network error\"\n - \"Server error\"\n - \"Client error\"\n - \"Unknown error\"\n - \"Processed Unsuccessfully\"\n - \"Processed Successfully\"\n - If the error message is an API error, only the parsed error string will be shown, such as:\n - \"Card not found\"\n - \"Invalid card ID\"\n - \"Permission denied\"\n - \"Board is archived\"\n - \"Malformed request\"\n - \"Unknown error\"\n- \"Received at (timezone)\": The date and time when the email was received, formatted according to the user's timezone (e.g. {YYYY-MM-DD HH:mm:ss}).\n- \"Card id\": The unique identifier of the card associated with the error (e.g. {cardId}), or null if not applicable.\n- \"Event type\": The type of event related to the error. Possible values:\n - \"Card Created\"\n - \"Card Updated\"\n - null\n\nThe value for each field may include additional details, such as formatted dates, parsed API error messages, and event type names. User-defined information such as email addresses, subjects, and card IDs will appear in the corresponding fields.\n"}}}}}}}]},"JsonExportWebhooks":{"title":"Json export","description":"Contains the exported webhook history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported webhook history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a webhook history event.\n","type":"array","items":{"type":"array","description":"Each item in the array represents a single exported webhook history event.\nThe order of values matches the order of the `titles` array.\n","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a webhook history event.\n\n**Possible values for each column:**\n- \"Event Type\": \"Created\", \"Updated\", \"Deleted\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\":\n - For \"Created\": \"{Username} has created a webhook URL {Webhook URL} on {Board name} board.\"\n - For \"Updated\" (URL change): \"{Username} has changed a webhook URL from {Old webhook URL} to {New webhook URL} on {Board name} board.\"\n - For \"Updated\" (enabled): \"{Username} has enabled a webhook URL {Webhook URL} on {Board name} board.\"\n - For \"Updated\" (disabled): \"{Username} has disabled a webhook URL {Webhook URL} on {Board name} board.\"\n - For \"Deleted\": \"{Username} has deleted a webhook URL {Webhook URL} on {Board name} board.\"\n - If the board or user is deleted: \"**Deleted User** has deleted a webhook URL {Webhook URL} on **Deleted Board** board.\"\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, webhook URLs, board names, and the type of change. If a referenced entity (user or board) has been deleted, its value will be shown as \"**Deleted User**\" or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportOldApi":{"title":"Json export","description":"Contains the exported API v1 request history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported API v1 request history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Resource\"\n- \"Username\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Resource\", \"Username\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"Each item in the array represents a single exported API v1 history event.\nThe order of values matches the order of the `titles` array.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an API v1 request history event.\n\n**Possible values for each column:**\n- \"Resource\": The API resource path accessed (e.g. {resourcePath}), such as \"api\/v1\/cards\/{cardId}\", \"api\/v1\/boards\/{boardId}\", etc.\n- \"Username\": The username of the user who made the request, or \"**Deleted User**\" if the user no longer exists.\n- \"Time (timezone)\": The date and time of the request, formatted according to the user's timezone (e.g. {YYYY-MM-DD HH:mm:ss}).\n\nThe \"Resource\" column provides the endpoint or resource accessed. The \"Username\" column shows the user who performed the request. If a referenced user has been deleted, its value will be shown as \"**Deleted User**\".\n"}}}}}}}]},"JsonExportApiRequestHistory":{"title":"Json export","description":"Contains the exported API v2 request history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported API v2 request history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Status code\"\n- \"Method\"\n- \"Resource\"\n- \"Username\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Status code\", \"Method\", \"Resource\", \"Username\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an API v2 request history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an API v2 request history event.\n\n**Possible values for each column:**\n- \"Status code\": The HTTP response status code. Possible values include:\n - 200 (OK)\n - '204' (No Content)\n - 400 (Bad Request)\n - 401 (Unauthorized)\n - 403 (Forbidden)\n - 404 (Not Found)\n - 405 (Method Not Allowed)\n - 409 (Conflict)\n - 429 (Too Many Requests)\n - 500 (Internal Server Error)\n - 503 (Service Unavailable)\n- \"Method\": The HTTP method used for the request. Possible values:\n - \"GET\"\n - \"POST\"\n - \"PUT\"\n - \"PATCH\"\n - \"DELETE\"\n- \"Resource\": The API resource path accessed (e.g. \/api\/v2\/cards\/{cardId}, \/api\/v2\/boards\/{boardId}, etc.).\n- \"Username\": The username of the user who made the request, or \"**Deleted User**\" if the user no longer exists.\n- \"Time (timezone)\": The date and time of the request, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Resource\" column provides the endpoint or resource accessed. The \"Username\" column shows the user who performed the request. If a referenced user has been deleted, its value will be shown as \"**Deleted User**\".\n"}}}}}}}]},"JsonExportUsersLastActivity":{"title":"Json export","description":"Contains the exported users last activity data in JSON format.\n","allOf":[{"type":"object","properties":{"data":{"description":"The exported users last activity data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Username\"\n- \"Real name\"\n- \"Email\"\n- \"Last Activity (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Username\", \"Real name\", \"Email\", or \"Last Activity (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a user last activity event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a user's last activity.\n\n**Possible values for each column:**\n- \"Username\": The username of the user.\n- \"Real name\": The real name of the user.\n- \"Email\": The email address of the user.\n- \"Last Activity (timezone)\": The date and time of the user's last activity, formatted according to your timezone (e.g. {YYYY-MM-DD HH:mm:ss}), or \"No activity\" if the user has never logged in.\n\nThe \"Last Activity (timezone)\" column shows the last login date and time for each user, or \"No activity\" if the user has never logged in.\n"}}}}}}}]},"JsonExportCustomFields":{"title":"Json export","description":"Contains the exported custom field management history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported custom field management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Custom field name\"\n- \"Event type\"\n- \"Author\"\n- \"Details\"\n- \"Executed at (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Custom field name\", \"Event type\", \"Author\", \"Details\", or \"Executed at (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a custom field management history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a custom field management history event.\n\n**Possible values for each column:**\n- \"Custom field name\": The name of the custom field, or \"**Deleted Custom Field**\" if it no longer exists.\n- \"Event type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Updated for board\"\n - \"Removed from board\"\n - \"Allowed value added\"\n - \"Allowed value updated\"\n - \"Allowed value removed\"\n - \"Allowed value disabled\"\n - \"Allowed value enabled\"\n - \"Allowed value added to board\"\n - \"Allowed value updated for board\"\n - \"Allowed value removed from board\"\n - \"Default contributor added to board\"\n - \"Default contributor removed from board\"\n- \"Author\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including field names, allowed values, board names, and changes. For example:\n - \"{username} created the custom field {customFieldName} of type {customFieldType}.\"\n - \"{username} changed the name of the custom field {oldName} to {newName}.\"\n - \"{username} enabled\/disabled\/deleted the custom field {customFieldName}.\"\n - \"{username} added\/removed\/updated the custom field {customFieldName} for the board {boardName}.\"\n - \"{username} added\/updated\/removed\/enabled\/disabled the allowed value {allowedValueName} of the custom field {customFieldName}.\"\n - \"{username} added\/removed a default contributor for the custom field {customFieldName} for the board {boardName}.\"\n - If a referenced entity (user, custom field, allowed value, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Custom Field**\", \"**Deleted Allowed Value**\", or \"**Deleted Board**\".\n- \"Executed at (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, custom field names, allowed values, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Custom Field**\", \"**Deleted Allowed Value**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportStickers":{"title":"Json export","description":"Contains the exported stickers management history data in JSON format.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported stickers management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a stickers management history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a stickers management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Removed from board\"\n - \"Updated for board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including sticker label, board name, availability level, color, icon, and changes. For example:\n - \"{username} has created a sticker {label} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {label} sticker. The icon\/color\/label\/availability level has been changed.\"\n - \"{username} has enabled\/disabled the sticker {label}.\"\n - \"{username} has deleted the sticker {label}.\"\n - \"{username} has added\/removed the sticker {label} to\/from {boardName} board.\"\n - \"{username} has updated the sticker {label}. The limit per board\/card has been changed from {oldValue} to {newValue}.\"\n - If a referenced entity (user, sticker, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Sticker**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, sticker labels, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Sticker**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportTags":{"title":"Json export","description":"Contains the exported tags management history data in JSON format.\nThe export includes a list of tags management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported tags management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a tags management history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a tags management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Removed from board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including tag label, board name, availability level, color, and changes. For example:\n - \"{username} has created a tag {label} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {label} tag. The color\/label\/availability level has been changed.\"\n - \"{username} has enabled\/disabled the tag {label}.\"\n - \"{username} has deleted the tag {label}.\"\n - \"{username} has added\/removed the tag {label} to\/from {boardName} board.\"\n - If a referenced entity (user, tag, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Tag**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, tag labels, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Tag**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportMilestones":{"title":"Json export","description":"Contains the exported milestones management history data in JSON format.\nThe export includes a list of milestones management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported milestones management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a milestones management history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a milestones management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Removed from board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including milestone label, board name, availability level, color, and changes. For example:\n - \"{username} has created a milestone {label} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {label} milestone. The color has been changed. The label has been changed from {oldLabel} to {newLabel}. The availability level has been changed to {availabilityLevel}.\"\n - \"{username} has enabled\/disabled the milestone {label}.\"\n - \"{username} has deleted the milestone {label}.\"\n - \"{username} has added\/removed the milestone {label} to\/from {boardName} board.\"\n - If a referenced entity (user, milestone, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Milestone**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, milestone labels, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Milestone**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportTeams":{"title":"Json export","description":"Contains the exported teams management history data in JSON format.\nThe export includes a list of teams management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported teams management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a teams management history event.\n","type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a teams management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Role changed for board\"\n - \"Removed from board\"\n - \"User added to team\"\n - \"User removed from team\"\n - \"User added as manager to team\"\n - \"User removed as manager from team\"\n - \"Added to dashboard page\"\n - \"Changed permissions for dashboard page\"\n - \"Removed from dashboard page\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including team name, board name, role name, dashboard page name, and changes. For example:\n - \"{username} has created a team {teamName}.\"\n - \"{username} has updated the {teamName} team. The name\/description has been changed.\"\n - \"{username} has deleted the team {teamName}.\"\n - \"{username} has added\/removed the team {teamName} to\/from {boardName} board.\"\n - \"{username} has changed the role {roleName} of team {teamName} for {boardName} board.\"\n - \"{username} has added\/removed the user {userName} to\/from {teamName} team.\"\n - \"{username} has added\/removed as manager the user {userName} to\/from {teamName} team.\"\n - \"{username} has added\/removed {teamName} to\/from {dashboardPageName} dashboard page.\"\n - \"{username} has changed their dashboard page permissions of {teamName} from {oldPermission} to {newPermission} on {dashboardPageName} dashboard.\"\n - If a referenced entity (user, team, board, role, or dashboard page) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Team**\", \"**Deleted Board**\", \"**Deleted Role**\", or \"**Deleted Dashboard page**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, team names, board names, role names, dashboard page names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Team**\", \"**Deleted Board**\", \"**Deleted Role**\", or \"**Deleted Dashboard page**\".\n"}}}}}}}]},"JsonExportLoggedTimes":{"title":"Json export","description":"Contains the exported logged times management history data in JSON format.\nThe export includes a list of logged time management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported logged times management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a logged time management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Deleted\"\n - \"Transferred to card after subtask deleted\"\n - \"Updated after subtask converted to card\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including comment, logged time, and context of the change. For example:\n - \"{username} has created a logged time with comment: '{comment}' and logged time {duration}.\"\n - \"{username} has updated the logged time with comment: '{comment}' and logged time: {duration}.\"\n - \"{username} has deleted the logged time with comment: '{comment}' and logged time {duration}.\"\n - \"{username} has transferred logged time({duration}) with comment '{comment}' to task after subtask deleted.\"\n - \"{username} has updated logged time({duration}) with comment '{comment}' after subtask converted to card.\"\n - If a referenced user has been deleted, its value will be shown as \"**Deleted User**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, comments, logged time durations, and the type of change. If a referenced user has been deleted, its value will be shown as \"**Deleted User**\".\n"}}}}}}}]},"JsonExportLoggedTimeCategories":{"title":"Json export","description":"Contains the exported logged time categories management history data in JSON format.\nThe export includes a list of logged time category management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported logged time categories management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a logged time category management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Removed from board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including category label, board name, availability level, color, and changes. For example:\n - \"{username} has created a logged time category {label} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {label} logged time category. The color\/label\/availability level has been changed.\"\n - \"{username} has enabled\/disabled the logged time category {label}.\"\n - \"{username} has deleted the logged time category {label}.\"\n - \"{username} has added\/removed the logged time category {label} to\/from {boardName} board.\"\n - If a referenced entity (user, category, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Logged Time Category**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, category labels, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Logged Time Category**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportBlockReasons":{"title":"Json export","description":"Contains the exported block reasons management history data in JSON format.\nThe export includes a list of block reason management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported block reasons management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a block reason management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Removed from board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including block reason label, board name, availability level, color, icon, and changes. For example:\n - \"{username} has created a block reason {label} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {label} block reason. The icon\/color\/label\/availability level has been changed.\"\n - \"{username} has enabled\/disabled the block reason {label}.\"\n - \"{username} has deleted the block reason {label}.\"\n - \"{username} has added\/removed the block reason {label} to\/from {boardName} board.\"\n - If a referenced entity (user, block reason, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Block Reason**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, block reason labels, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Block Reason**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportCardTemplates":{"title":"Json export","description":"Contains the exported card templates management history data in JSON format.\nThe export includes a list of card template management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported card templates management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a card template management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Updated for board\"\n - \"Removed from board\"\n - \"Structure updated\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including template name, board name, availability level, color, icon, and changes. For example:\n - \"{username} has created a card template {name} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {name} card template. The icon\/color\/name\/availability level has been changed.\"\n - \"{username} has enabled\/disabled the card template {name}.\"\n - \"{username} has deleted the card template {name}.\"\n - \"{username} has added\/removed\/updated the card template {name} to\/from {boardName} board.\"\n - \"{username} has updated the structure of the card template {name}.\"\n - If a referenced entity (user, card template, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Card Template**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, template names, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Card Template**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportCardTypes":{"title":"Json export","description":"Contains the exported card types management history data in JSON format.\nThe export includes a list of card type management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported card types management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a card type management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Disabled\"\n - \"Enabled\"\n - \"Deleted\"\n - \"Added to board\"\n - \"Updated for board\"\n - \"Removed from board\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including card type name, board name, availability level, color, icon, and changes. For example:\n - \"{username} has created a card type {name} with availability level {availabilityLevel}.\"\n - \"{username} has updated the {name} card type. The icon\/color\/name\/availability level\/override card color setting has been changed.\"\n - \"{username} has enabled\/disabled the card type {name}.\"\n - \"{username} has deleted the card type {name}.\"\n - \"{username} has added\/removed\/updated the card type {name} to\/from {boardName} board.\"\n - If a referenced entity (user, card type, or board) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Card Type**\", or \"**Deleted Board**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, card type names, board names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Card Type**\", or \"**Deleted Board**\".\n"}}}}}}}]},"JsonExportInternalAnnouncements":{"title":"Json export","description":"Contains the exported internal announcements management history data in JSON format.\nThe export includes a list of internal announcement management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported internal announcements management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for an internal announcement management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Deleted\"\n - \"A role was added\"\n - \"A role was removed\"\n - \"A team was added\"\n - \"A team was removed\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including announcement title, role name, team name, and changes. For example:\n - \"{username} has created an internal announcement {title}.\"\n - \"{username} has updated the {title} internal announcement. The title has been changed from {oldTitle} to {newTitle}.\"\n - \"{username} has deleted the announcement {title}.\"\n - \"{username} has added a role {roleName} to {title} internal announcement.\"\n - \"{username} has removed the managing role {roleName} from {title} internal announcement.\"\n - \"{username} has added a team {teamName} to {title} internal announcement.\"\n - \"{username} has removed the team {teamName} from {title} internal announcement.\"\n - If a referenced entity (user, role, team, or announcement) has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Role**\", \"**Deleted Team**\", or \"**Deleted Announcement**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, announcement titles, role names, team names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\", \"**Deleted Role**\", \"**Deleted Team**\", or \"**Deleted Announcement**\".\n"}}}}}}}]},"JsonExportBAIPrompts":{"title":"Json export","description":"Contains the exported BAI prompts management history data in JSON format.\nThe export includes a list of BAI prompt management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported BAI prompts management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a BAI prompt management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Updated\"\n - \"Deleted\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including prompt name and changes. For example:\n - \"{username} has created a BAI prompt {name}.\"\n - \"{username} has updated the {name} BAI prompt. The name has been changed from {oldName} to {newName}.\"\n - \"{username} has deleted the BAI prompt {name}.\"\n - If a referenced entity (user or prompt) has been deleted, its value will be shown as \"**Deleted User**\" or \"**Deleted Prompt**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, prompt names, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\" or \"**Deleted Prompt**\".\n"}}}}}}}]},"JsonExportRoles":{"title":"Json export","description":"Contains the exported roles management history data in JSON format.\nThe export includes a list of roles management events, with each row representing a single event and its details.\nPagination information is included in the response.\n","allOf":[{"$ref":"#\/components\/schemas\/Pagination"},{"type":"object","properties":{"data":{"description":"The exported roles management history data.\nIncludes column titles and the corresponding event data for each row.\nThe columns are:\n- \"Event Type\"\n- \"Username\"\n- \"Details\"\n- \"Time (timezone)\"\n","type":"object","properties":{"titles":{"description":"An array of column titles for the exported data.\nEach title represents a field included in the export, such as \"Event Type\", \"Username\", \"Details\", or \"Time (timezone)\".\nThe order of titles matches the order of values in each exported row.\n","type":"array","items":{"type":"string"}},"items":{"type":"array","items":{"type":"array","items":{"type":"string","description":"An array of exported rows.\nEach row is an array of values, where the order of values matches the order of the `titles` array.\nEach value corresponds to a specific field for a roles management history event.\n\n**Possible values for each column:**\n- \"Event Type\": The type of event, such as:\n - \"Created\"\n - \"Renamed\"\n - \"Deleted\"\n - \"Permissions Changed\"\n- \"Username\": The username of the user who performed the action, or \"**Deleted User**\" if the user no longer exists.\n- \"Details\": Human-readable description of the event, including role name, previous name, permission changes, and other changes. For example:\n - \"{username} has created a role {name}.\"\n - \"{username} has renamed the role {oldName} to {newName}.\"\n - \"{username} has deleted the role {name}.\"\n - \"{username} has added Card details and Delete card permissions for role {name}.\"\n - If a referenced entity (user or role) has been deleted, its value will be shown as \"**Deleted User**\" or \"**Deleted Role**\".\n- \"Time (timezone)\": The date and time of the event, formatted according to the user's timezone (e.g. \"2025-08-06 09:15:25\").\n\nThe \"Details\" column provides a human-readable description of the event, including usernames, role names, permission changes, and the type of change. If a referenced entity has been deleted, its value will be shown as \"**Deleted User**\" or \"**Deleted Role**\".\n"}}}}}}}]},"JsonExport":{"title":"Json export","description":"Json export data","type":"object","properties":{"pagination":{"type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"data":{"type":"object","properties":{"titles":{"description":"The titles of the exported data.","type":"array","items":{"type":"string"}},"items":{"description":"The exported items.","type":"array","items":{"type":"string"}}}}}}},"securitySchemes":{"apikey":{"type":"apiKey","name":"apikey","in":"header"}},"requestExamples":{"BlockReasonBatchBoardOperationsExample":{"board_ids_to_add":[1],"board_ids_to_remove":[2]},"BoardAccessRequestsProcessManyExample":{"requests_to_approve":[{"board_id":1,"user_id":2,"role_id":1}],"requests_to_deny":[{"board_id":2,"user_id":3,"reason":"Lorem ipsum dolor sit amet."}]},"BoardArrivalRuleCreateRequestExample":{"name":"arrivalRule","conditions":[{"field_type":"plain","operator":"!=","field_name":"author","values":[2]},{"field_type":"custom","operator":"contains","field_id":"1","values":["av:1"],"ignore_if_not_present":0}],"column_id":1,"lane_id":2},"BoardArrivalRuleUpdateRequestExample":{"name":"arrivalRule - updated","is_enabled":0,"conditions":[{"field_type":"plain","field_name":"attachments","operator":"are_present"}]},"BoardBaiPromptCreateRequestExample":{"board_id":1,"type":1,"color":"7333bd","icon_id":1059,"name":"promptName","context":"generalSituation","topics":"listOfImportantTopics","fields_instructions":"instructions","suggest_missing_topics":0,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"comments"}]},"BoardBaiPromptUpdateRequestExample":{"color":"E6186A","icon_id":1001,"name":"promptName - updated","context":"generalSituation - updated","fields_instructions":"instructions - updated","suggest_missing_topics":1,"type":1,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"comments"},{"field_type":"plain","field_name":"is_blocked"}],"topics":"additionalTopics - updated"},"BoardUserRoleSetRequestExample":{"role_id":1},"BoardUserRolesBatchOperationsExample":{"users_to_add_or_update":[{"user_id":3,"role_id":1}],"user_ids_to_remove":["4'"]},"CardTemplateCreateRequestExample":{"name":"New Template","description":"This is a new card template.","availability":0,"is_enabled":1,"primary_card":{"title":"Primary Template Card","description":"Primary card description.","custom_id":"PrimaryCard01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"reference":"primaryAbc123xyz","stickers_to_add":[{"sticker_id":1}],"tag_ids_to_add":[1],"milestone_ids_to_add":[1],"doc_ids_to_add":[5],"co_owner_ids_to_add":[3],"watcher_ids_to_add":[4],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Custom Field Value"}],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"position":0,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"abc123xyz","link_type":"child","linked_new_template_card_position":0,"template_card_position":0}],"other_cards":[{"column_id":4129,"lane_id":1026,"position":0,"title":"Other Template Card","description":"Other card description.","custom_id":"OtherCard01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"33ff57","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"reference":"otherAbc123xyz","stickers_to_add":[{"sticker_id":2}],"tag_ids_to_add":[2],"milestone_ids_to_add":[2],"doc_ids_to_add":[5],"co_owner_ids_to_add":[4],"watcher_ids_to_add":[5],"custom_fields_to_add_or_update":[{"field_id":2,"value":"Another Custom Field Value"}],"attachments_to_add":[{"file_name":"other_attachment.jpg","link":"\/files\/other_attachment1234567890","position":0}],"subtasks_to_add":[{"description":"Other Subtask 1","owner_user_id":3,"position":0,"deadline":5,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"other_subtask_attachment.jpg","link":"\/files\/other_subtask_attachment1234567890","position":0}]}],"annotations_to_add":[{"comment_id":2331,"thread_id":"def456uvw","content":"Other annotation text"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"def456uvw","link_type":"relative","linked_new_template_card_position":0,"template_card_position":0}]}]}},"CardTemplateUpdateRequestExample":{"name":"Updated Template","description":"This is an updated card template.","availability":1,"is_enabled":0,"cards_to_add":[{"links_to_existing_template_cards_to_add_or_update":[{"linked_template_card_id":51,"link_type":"child","linked_template_card_position":0,"template_card_position":0}],"column_id":4129,"lane_id":1026,"position":0,"title":"Added Template Card","description":"Added card description.","custom_id":"AddedCard01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"3357ff","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"reference":"addedAbc123xyz","stickers_to_add":[{"sticker_id":3}],"tag_ids_to_add":[3],"milestone_ids_to_add":[3],"doc_ids_to_add":[5],"co_owner_ids_to_add":[5],"watcher_ids_to_add":[6],"custom_fields_to_add_or_update":[{"field_id":3,"value":"Added Custom Field Value"}],"attachments_to_add":[{"file_name":"added_attachment.jpg","link":"\/files\/added_attachment1234567890","position":0}],"subtasks_to_add":[{"description":"Added Subtask 1","owner_user_id":4,"position":0,"deadline":6,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"added_subtask_attachment.jpg","link":"\/files\/added_subtask_attachment1234567890","position":0}]}],"annotations_to_add":[{"comment_id":2332,"thread_id":"ghi789rst","content":"Added annotation text"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"ghi789rst","link_type":"relative","linked_new_template_card_position":0,"template_card_position":0}]}],"cards_to_update":[{"template_card_id":52,"column_id":4129,"lane_id":1026,"position":0,"title":"Updated Template Card","description":"Updated card description.","custom_id":"UpdatedCard01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff33a1","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"stickers_to_add":[{"sticker_id":4}],"sticker_ids_to_remove":[5],"tag_ids_to_add":[4],"tag_ids_to_remove":[5],"milestone_ids_to_add":[4],"milestone_ids_to_remove":[5],"doc_ids_to_add":[5],"doc_ids_to_remove":[6],"co_owner_ids_to_add":[6],"co_owner_ids_to_remove":[7],"watcher_ids_to_add":[7],"watcher_ids_to_remove":[8],"custom_fields_to_add_or_update":[{"field_id":4,"value":"Updated Custom Field Value"}],"custom_field_ids_to_remove":[5],"attachments_to_add":[{"file_name":"updated_attachment.jpg","link":"\/files\/updated_attachment1234567890","position":0}],"attachments_to_update":[{"attachment_id":124,"file_name":"updated_attachment_v2.jpg","link":"\/files\/updated_attachment_v21234567890","position":1}],"attachment_ids_to_remove":[457],"subtasks_to_add":[{"description":"New Subtask 1","owner_user_id":3,"position":0,"deadline":5,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"updated_subtask_attachment.jpg","link":"\/files\/updated_subtask_attachment1234567890","position":0}]}],"subtasks_to_update":[{"subtask_id":21,"description":"Updated Subtask","owner_user_id":4,"position":1,"deadline":6,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"updated_subtask_attachment_v2.jpg","link":"\/files\/updated_subtask_attachment_v21234567890","position":0}],"attachments_to_update":[{"attachment_id":125,"file_name":"updated_subtask_attachment_v3.jpg","link":"\/files\/updated_subtask_attachment_v31234567890","position":1}],"attachment_ids_to_remove":[458]}],"subtask_ids_to_remove":[22],"annotations_to_add":[{"comment_id":2333,"thread_id":"jkl012mno","content":"Updated annotation text"}],"annotations_to_update":[{"annotation_id":3456,"content":"Annotation text updated"}],"annotation_ids_to_remove":[3457],"links_to_existing_template_cards_to_add_or_update":[{"linked_template_card_id":53,"link_type":"relative","linked_template_card_position":0,"template_card_position":0}],"links_to_existing_template_cards_to_remove":[{"linked_template_card_id":54,"link_type":"child"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"jkl012mno","link_type":"child","linked_new_template_card_position":0,"template_card_position":0}]}],"card_ids_to_remove":[55]},"CardTemplateCardInExistingTemplateCreateRequestExample":{"column_id":4129,"lane_id":1026,"position":0,"title":"New Template Card","description":"New card description.","custom_id":"NewCard01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"reference":"abc123xyz","links_to_existing_template_cards_to_add_or_update":[{"linked_template_card_id":50,"link_type":"relative","linked_template_card_position":0,"template_card_position":0}],"stickers_to_add":[{"sticker_id":1}],"tag_ids_to_add":[1],"milestone_ids_to_add":[1],"doc_ids_to_add":[5],"co_owner_ids_to_add":[3],"watcher_ids_to_add":[4],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Custom Field Value"}],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"position":0,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"abc123xyz","link_type":"child","linked_new_template_card_position":0,"template_card_position":0}]},"CardTemplateCardUpdateRequestExample":{"column_id":4129,"lane_id":1026,"position":0,"title":"Template Card","description":"Card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"stickers_to_add":[{"sticker_id":1}],"sticker_ids_to_remove":[2],"tag_ids_to_add":[1],"tag_ids_to_remove":[2],"milestone_ids_to_add":[1],"milestone_ids_to_remove":[2],"doc_ids_to_add":[5],"doc_ids_to_remove":[6],"co_owner_ids_to_add":[3],"co_owner_ids_to_remove":[4],"watcher_ids_to_add":[4],"watcher_ids_to_remove":[5],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Custom Field Value"}],"custom_field_ids_to_remove":[2],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"attachments_to_update":[{"attachment_id":123,"file_name":"updated_attachment.jpg","link":"\/files\/updated_attachment1234567890","position":1}],"attachment_ids_to_remove":[456],"subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"position":0,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"subtasks_to_update":[{"subtask_id":789,"description":"Updated Subtask"}],"subtask_ids_to_remove":[1011],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"annotations_to_update":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Updated annotation text"}],"annotations_to_remove":[{"comment_id":1234,"thread_id":"abc123xyz"}],"links_to_existing_template_cards_to_add_or_update":[{"linked_template_card_id":50,"link_type":"relative","linked_template_card_position":0,"template_card_position":0}],"links_to_existing_template_cards_to_remove":[{"linked_template_card_id":52,"link_type":"child"}],"links_to_new_template_cards_to_add":[{"linked_new_template_card_reference":"abc123xyz","link_type":"child","linked_new_template_card_position":0,"template_card_position":0}]},"BoardCardAndInitiativeViewSettingsUpdateRequestExample":{"card_card_size":"big","card_attachments":"icon","card_id":"effective_id","card_co_owners":"off","card_color_entire_surface":"off","card_comments":"on","card_cover":"on","card_created_at":"off","card_custom_fields":"row","card_custom_fields_to_show":"all","card_custom_fields_ids":[],"card_custom_fields_only_filled":"off","card_cycle_time":"icon","card_deadline":"icon","card_exit_criteria":"row_unchecked_only","card_last_modified":"off","card_last_moved":"off","card_links":"row","card_include_parents":"on","card_include_children":"on","card_include_relatives":"on","card_include_predecessors":"on","card_include_successors":"on","card_links_in_backlog":"on","card_links_in_requested":"on","card_links_in_progress":"on","card_links_in_done":"on","card_links_in_archive":"on","card_link_order":"off","card_link_group_by":"link_type","card_link_type_group_order":["parent","child","relative","predecessor","successor"],"card_local_cycle_time":"off","card_logged_time":"off","card_logged_time_with_subtasks":"off","card_logged_time_with_children":"off","card_owner":"avatar_and_username","card_priority":"icon","card_reporter":"off","card_size":"icon","card_stickers":"icon","card_subtasks":"row_all","card_tags":"row","card_title":"medium","card_type":"icon","initiative_width":"auto","initiative_height":"high","initiative_attachments":"icon","initiative_id":"custom_id","initiative_co_owners":"icon","initiative_color_entire_surface":"off","initiative_comments":"on","initiative_cover":"off","initiative_created_at":"on","initiative_custom_fields":"icon","initiative_custom_fields_to_show":"all","initiative_custom_fields_ids":[],"initiative_custom_fields_only_filled":"off","initiative_cycle_time":"icon","initiative_deadline":"icon","initiative_exit_criteria":"icon","initiative_last_modified":"on","initiative_last_moved":"on","initiative_links":"row_compact","initiative_include_parents":"on","initiative_include_children":"on","initiative_include_relatives":"off","initiative_include_predecessors":"off","initiative_include_successors":"off","initiative_links_in_backlog":"on","initiative_links_in_requested":"on","initiative_links_in_progress":"on","initiative_links_in_done":"on","initiative_links_in_archive":"on","initiative_link_order":"off","initiative_link_group_by":"link_type","initiative_link_type_group_order":["parent","child","relative","predecessor","successor"],"initiative_local_cycle_time":"off","initiative_logged_time":"icon","initiative_logged_time_with_subtasks":"off","initiative_logged_time_with_children":"off","initiative_outcomes":"icon","initiative_owner":"avatar_only","initiative_priority":"icon","initiative_reporter":"on","initiative_size":"icon","initiative_stickers":"icon","initiative_subtasks":"icon","initiative_tags":"icon","initiative_title":"short","initiative_type":"icon","initiative_planned_start_date":"icon","initiative_planned_end_date":"icon","initiative_progress":"on"},"BoardCardTypeCreateOrUpdateRequestExample":{"icon_type":0,"icon_id":1038,"color":"666666","card_color_sync":0},"CardBlockReasonSetExample":{"comment":"string","reason_id":1},"ChecklistItemCreateRequestExample":{"text":"exitCriterionName","position":0,"allowed_user_ids":[2]},"ChecklistItemUpdateRequestExample":{"text":"exitCriterionName","position":0,"allowed_user_ids_to_add":[2],"allowed_user_ids_to_remove":[3,4]},"BoardCustomFieldAllowedValueCreateOrUpdateRequestExample":{"position":0,"is_enabled":1},"BoardCustomFieldCreateOrUpdateRequestExample":{"display_width":1,"prefix":"pre","suffix":"suf","unique_values":0,"default_value":"defaultValue","inherit_default_values":1},"BoardDefaultSettingCreateOrUpdateRequestExample":{"value":2},"BoardDepatureRuleCreateOrUpdateRequestExample":{"name":"departureRule3","conditions":[{"field_type":"plain","operator":"=","field_name":"block_time","values":["1 days"]}]},"CardAttachmentCreateRequestExample":{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1},"CardAttachmentUpdateRequestExample":{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":2},"CommentAttachmentCreateRequestExample":{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},"CardCommentCreatedRequestExample":{"text":"string","attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"file_name":"document.pdf","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}]},"CardCommentUpdateRequestExample":{"text":"string","attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"file_name":"document.pdf","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"attachment_ids_to_remove":[131,132]},"BoardSettingsRequestExample":{"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":"average(1,2)","deadline_formula":"card.created_at()","default_sender_user_id":1,"default_receiver_user_id":2,"allow_generic_blocker":1},"CardColumnChecklistItemCheckRequestExample":{"comment":"Subtasks are completed."},"CardCoverImageSetRequestExample":{"cover_image_link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},"CardCustomFieldSelectedCardAddOrUpdateRequestExample":{"position":0},"CardCustomFieldSelectedValueAddOrUpdateRequestExample":{"position":0},"CardCustomFieldFileUpdateRequestExample":{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1},"CardCustomFieldAddRequestExample":{"value":"string"},"CardCustomFieldVoteSetRequestExample":{"vote":1,"comment":"Agreed"},"BoardTeamRequestExample":{"role_id":1},"BoardCreateRequestExample":{"workspace_id":224,"name":"New Board","description":"Lorem ipsum dolor sit amet.","type":0},"BoardUpdateRequestExample":{"name":"New Board Updated","description":"Updated description.","is_archived":1},"CardOutcomeCheckpointCreateRequestExample":{"time":"2025-07-20T12:00:00+00:00","name":"First stage","value":50},"CardOutcomePositionSetRequestExample":{"position":0},"CardOutcomeCheckpointUpdateRequestExample":{"time":"2025-07-20T12:00:00+00:00","name":"First stage - updated","value":50},"CardOutcomeValueCreateRequestExample":{"value":100,"time":"2025-07-20T15:00:00+00:00"},"OutcomeValueCreateRequestExample":{"time":"2025-07-20T15:00:00+00:00","value":100},"CardOutcomeValueUpdateRequestExample":{"time":"2025-07-20T12:00:00+00:00","value":75},"CardOutcomeUpdateRequestExample":{"name":"ownValueMetric","operator":"or_more","starting_value":1,"target_value":3,"current_value":2,"comment":"summary"},"CardOutcomeCreateRequestExample":{"name":"ownValueMetric","field_id":null,"rule_id":null,"starting_value":1,"current_value":2,"target_value":3,"starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"operator":"or_more","weight":1,"comment":"summary"},"CardParentCardCreateRequestExample":{"linked_card_position":0,"card_position":0,"exceeding_reason":"Just in case."},"CardStickerCreateRequestExample":{"sticker_id":4},"CardSubtaskCreateRequestExample":{"description":"Subtask 2","owner_user_id":2,"is_finished":0,"deadline":"2025-07-20T12:00:00Z","position":0,"attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}]},"CardSubtaskUpdateRequestExample":{"description":"Subtask updated","owner_user_id":2,"is_finished":0,"deadline":"2025-07-20T12:00:00Z","position":0,"attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"attachments_to_update":[{"id":123,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"attachments_to_remove":[124,125]},"CardSubtaskAttachmentCreateRequestExample":{"file_name":"s1.png","link":"\/files\/53xBzCb6m5kRW1UWFYIT"},"CardSubtaskAttachmentUpdateRequestExample":{"file_name":"s1.png","link":"\/files\/53xBzCb6m5kRW1UWFYIT","position":0},"CardLinkCardCreateRequestExample":{"linked_card_position":0,"card_position":0},"TemplateCardLinkCardRequestExample":{"template_card_position":0,"linked_template_card_position":0},"CardTemplateCardCustomFieldFileRequestExample":{"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1},"CardTemplateCardCustomFieldSelectedValueAddRequestExample":{"value_id":2001,"position":0},"CardTemplateCardSubtaskCreateRequestExample":{"description":"Subtask 1","owner_user_id":2,"position":0,"deadline":5,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":0,"deadline_sunday_is_working_day":0,"attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}]},"CardTemplateCardSubtaskUpdateRequestExample":{"description":"Subtask 1","owner_user_id":2,"position":0,"deadline":5,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":0,"deadline_sunday_is_working_day":0,"attachments_to_add":[{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"attachments_to_update":[{"id":123,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"attachments_to_remove":[124,125]},"CardTypeBoardsUpdateRequestExample":{"boards_to_add_or_update":[{"board_id":1,"icon_type":0,"icon_id":1055,"color":"794da6","card_color_sync":1},{"board_id":2,"icon_type":0,"icon_id":1056,"color":"34a97b","card_color_sync":0}],"board_ids_to_remove":[3,4]},"CardTypeCreateOrUpdateRequestExample":{"name":"Type 01","description":"Lorem ipsum dolor sit amet."},"CardAddChildCardExample":{"linked_card_position":0,"card_position":0,"exceeding_reason":"Lorem ipsum dolor sit amet."},"ColumnCreateExample":{"workflow_id":1001,"section":1,"position":0,"name":"string","description":"string","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_progress":50,"card_progress_size_type":0},"ColumnUpdateExample":{"section":1,"position":0,"name":"string","description":"string","color":"34a97b","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]","card_progress":50,"card_progress_size_type":0},"CompanySettingUpdateExample":{"value":1},"CardCreateRequestExample":{"template_id":10,"card_properties_to_copy":[{"properties":["color"],"card_id":20}],"custom_fields_to_copy":[{"field_ids":[1,2],"card_id":20}],"column_id":112,"lane_id":94,"position":0,"track":1,"planned_start_date":"2025-07-20","planned_end_date":"2025-07-30","actual_start_date":"2025-07-21T12:00:00Z","actual_end_date":"2025-07-31T12:00:00Z","title":"New Card","description":"Card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":"2025-08-20 12:00:00","reference":"abc123xyz","block_reason":{"id":1,"comment":"This is a block reason."},"stickers_to_add":[{"sticker_id":1,"if_not_present":1}],"tag_ids_to_add":[1],"tag_ids_to_remove":[2],"milestone_ids_to_add":[1],"milestone_ids_to_remove":[2],"doc_ids_to_add":[5],"co_owner_ids_to_add":[3],"co_owner_ids_to_remove":[4],"watcher_ids_to_add":[4],"watcher_ids_to_remove":[5],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Custom Field Value"}],"custom_field_ids_to_remove":[2],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"cover_image_link":"\/files\/cover1234567890","subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"is_finished":0,"deadline":"2025-08-20 12:00:00","position":0,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"column_checklist_items_to_check_or_update":[{"item_id":1,"comment":"Subtask completed."}],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"links_to_existing_cards_to_add_or_update":[{"linked_card_id":50,"link_type":"relative","linked_card_position":0,"card_position":0}],"links_to_new_cards_to_add":[{"linked_new_card_reference":"abc123xyz","link_type":"child","linked_card_position":0,"card_position":0}],"watch":1,"created_at":"2025-07-20 12:00:00","is_archived":0,"version_id":1,"archived_at":"2025-07-20 12:00:00","is_discarded":0,"discarded_at":"2025-07-20 12:00:00","exceeding_reason":"Important","reporter_user_id":4,"reporter_email":"user@mail.example"},"CustomFieldAllowedValueExample":{"value":"string","is_enabled":1,"is_default":1,"position":0},"CustomFieldAllowedValueBatchOperationsExample":{"values_to_create":[{"value":"string","is_enabled":0,"is_default":0,"position":0}],"values_to_update\"":[{"value_id":101,"value":"string","is_enabled":1,"is_default":1,"position":1}],"values_to_delete\"":[{"value_id":102,"replace_with_value_id":101}]},"CustomFieldBoardsBatchOperationsExample":{"boards_to_add_or_update":[{"board_id":344,"color":"ffffff","is_always_present":0,"position":0},{"board_id":346,"color":"9932cc","is_always_present":1,"position":0}],"board_ids_to_remove":[347]},"DataFieldBoardsBatchOperationsExample":{"boards_to_add_or_update":[{"board_id":344,"value":"test","value_is_locked":0},{"board_id":346,"value":"test2","value_is_locked":1}],"board_ids_to_remove":[347]},"DataFieldWorkspacesBatchOperationsRequestExample":{"workspaces_to_add_or_update":[{"workspace_id":344,"value":"test","show_in_dashboard":1},{"workspace_id":346,"value":"test2"}],"workspace_ids_to_remove":[347],"workspace_ids_for_apply_to_all_boards_to_add":[501],"workspace_ids_for_apply_to_all_boards_to_remove":[506],"workspace_ids_for_value_is_locked_for_all_boards_to_add":[507],"workspace_ids_for_value_is_locked_for_all_boards_to_remove":[508]},"CardUpdateRequestExample":{"column_id":112,"lane_id":94,"position":0,"track":0,"planned_start_date_sync_type":null,"planned_start_date_sync_monday_is_working_day":1,"planned_start_date_sync_tuesday_is_working_day":1,"planned_start_date_sync_wednesday_is_working_day":1,"planned_start_date_sync_thursday_is_working_day":1,"planned_start_date_sync_friday_is_working_day":1,"planned_start_date_sync_saturday_is_working_day":1,"planned_start_date_sync_sunday_is_working_day":1,"planned_start_date":"2025-07-20","planned_end_date_sync_type":null,"planned_end_date":"2025-07-30","actual_start_date":"2025-07-21T12:00:00Z","actual_end_date":"2025-07-31T12:00:00Z","title":"Updated Card","description":"Updated card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":"2025-08-20 12:00:00","reference":"abc123xyz","block_reason":{"reason_id":1,"comment":"This is block reason."},"stickers_to_add":[{"sticker_id":1,"if_not_present":1}],"sticker_ids_to_remove":[2],"tag_ids_to_add":[1],"tag_ids_to_remove":[2],"milestone_ids_to_add":[1],"milestone_ids_to_remove":[2],"doc_ids_to_add":[5],"doc_ids_to_remove":[6],"co_owner_ids_to_add":[3],"co_owner_ids_to_remove":[4],"watcher_ids_to_add":[4],"watcher_ids_to_remove":[5],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Updated Custom Field Value"}],"custom_field_ids_to_remove":[2],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"attachments_to_update":[{"id":123,"file_name":"updated_attachment.jpg","link":"\/files\/updated_attachment1234567890","position":1}],"attachment_ids_to_remove":[456],"cover_image_link":"\/files\/cover1234567890","subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"is_finished":0,"deadline":"2025-08-20 12:00:00","position":0,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"subtasks_to_update":[{"subtask_id":789,"description":"Updated Subtask"}],"subtasks_to_convert_into_cards":[{"subtask_id":789,"column_id":112,"lane_id":94}],"subtask_ids_to_remove":[1011],"column_checklist_items_to_check_or_update":[{"item_id":1,"comment":"Comment."}],"column_checklist_item_ids_to_uncheck":[2],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"annotations_to_update":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Updated annotation text"}],"annotations_to_remove":[{"comment_id":1234,"thread_id":"abc123xyz"}],"links_to_existing_cards_to_add_or_update":[{"linked_card_id":50,"link_type":"relative","linked_card_position":0,"card_position":0}],"links_to_existing_cards_to_remove":[{"linked_card_id":52,"link_type":"child"}],"links_to_new_cards_to_add":[{"linked_new_card_reference":"abc123xyz","link_type":"child","linked_card_position":0,"card_position":0}],"watch":1,"is_archived":0,"version_id":2,"is_discarded":0,"exceeding_reason":"Important","reporter_user_id":4,"reporter_email":"user@mail.example"},"CustomFieldCreateRequestExample":{"name":"singleLineTextField1","description":"","color":"eceff1","type":"single_line_text","is_always_present":0,"is_immutable":0,"availability":0,"is_enabled":1,"display_width":1,"prefix":"","suffix":"","uniqueness_of_values":0,"value_is_required":0,"default_value":"","all_properties_are_locked":0},"CustomFieldUpdateRequestExample":{"name":"singleLineTextField1","description":"","color":"eceff1","is_always_present":0,"is_immutable":0,"availability":0,"is_enabled":1,"display_width":1,"prefix":"","suffix":"","uniqueness_of_values":0,"value_is_required":0,"default_value":"","all_properties_are_locked":0},"DataFieldUpdateRequestExample":{"name":"First Data Field","description":"Text data field","color":"eceff1","availability":0,"is_enabled":1},"CardCreateManyRequestExample":{"cards":[{"template_id":10,"card_properties_to_copy":[{"properties":["color"],"card_id":20}],"custom_fields_to_copy":[{"field_ids":[1,2],"card_id":20}],"column_id":112,"lane_id":94,"position":0,"track":1,"planned_start_date":"2025-07-20","planned_end_date":"2025-07-30","actual_start_date":"2025-07-21T12:00:00Z","actual_end_date":"2025-07-31T12:00:00Z","title":"New Card","description":"Card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":"2025-08-20 12:00:00","reference":"abc123xyz","block_reason":{"id":1,"comment":"This is a block reason."},"stickers_to_add":[{"sticker_id":1,"if_not_present":1}],"tag_ids_to_add":[1],"tag_ids_to_remove":[2],"milestone_ids_to_add":[1],"milestone_ids_to_remove":[2],"co_owner_ids_to_add":[3],"co_owner_ids_to_remove":[4],"watcher_ids_to_add":[4],"watcher_ids_to_remove":[5],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Custom Field Value"}],"custom_field_ids_to_remove":[2],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"cover_image_link":"\/files\/cover1234567890","subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"is_finished":0,"deadline":"2025-08-20 12:00:00","position":0,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"column_checklist_items_to_check_or_update":[{"item_id":1,"comment":"Comment."}],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"links_to_existing_cards_to_add_or_update":[{"linked_card_id":50,"link_type":"relative","linked_card_position":0,"card_position":0}],"links_to_new_cards_to_add":[{"linked_new_card_reference":"abc123xyz","link_type":"child","linked_card_position":0,"card_position":0}],"watch":1,"created_at":"2025-07-20 12:00:00","is_archived":0,"version_id":1,"archived_at":"2025-07-20 12:00:00","is_discarded":0,"discarded_at":"2025-07-20 12:00:00","exceeding_reason":"Important","reporter_user_id":4,"reporter_email":"user@mail.example"}]},"CardUpdateManyRequestExample":{"cards":[{"card_id":1001,"column_id":112,"lane_id":94,"position":0,"track":0,"planned_start_date_sync_type":null,"planned_start_date_sync_monday_is_working_day":1,"planned_start_date_sync_tuesday_is_working_day":1,"planned_start_date_sync_wednesday_is_working_day":1,"planned_start_date_sync_thursday_is_working_day":1,"planned_start_date_sync_friday_is_working_day":1,"planned_start_date_sync_saturday_is_working_day":1,"planned_start_date_sync_sunday_is_working_day":1,"planned_start_date":"2025-07-20","planned_end_date_sync_type":null,"planned_end_date":"2025-07-30","actual_start_date":"2025-07-21T12:00:00Z","actual_end_date":"2025-07-31T12:00:00Z","title":"Updated Card","description":"Updated card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":"2025-08-20 12:00:00","reference":"abc123xyz","block_reason":{"reason_id":1,"comment":"This is block reason."},"stickers_to_add":[{"sticker_id":1,"if_not_present":1}],"sticker_ids_to_remove":[2],"tag_ids_to_add":[1],"tag_ids_to_remove":[2],"milestone_ids_to_add":[1],"milestone_ids_to_remove":[2],"co_owner_ids_to_add":[3],"co_owner_ids_to_remove":[4],"watcher_ids_to_add":[4],"watcher_ids_to_remove":[5],"custom_fields_to_add_or_update":[{"field_id":1,"value":"Updated Custom Field Value"}],"custom_field_ids_to_remove":[2],"attachments_to_add":[{"file_name":"attachment.jpg","link":"\/files\/attachment1234567890","position":0}],"attachments_to_update":[{"id":123,"file_name":"updated_attachment.jpg","link":"\/files\/updated_attachment1234567890","position":1}],"attachment_ids_to_remove":[456],"cover_image_link":"\/files\/cover1234567890","subtasks_to_add":[{"description":"Subtask 1","owner_user_id":2,"is_finished":0,"deadline":"2025-08-20 12:00:00","position":0,"attachments_to_add":[{"file_name":"subtask_attachment.jpg","link":"\/files\/subtask_attachment1234567890","position":0}]}],"subtasks_to_update":[{"subtask_id":789,"description":"Updated Subtask"}],"subtasks_to_convert_into_cards":[{"subtask_id":789,"column_id":112,"lane_id":94}],"subtask_ids_to_remove":[1011],"column_checklist_items_to_check_or_update":[{"item_id":1,"comment":"Comment."}],"column_checklist_item_ids_to_uncheck":[2],"annotations_to_add":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Annotation text"}],"annotations_to_update":[{"comment_id":2330,"thread_id":"abc123xyz","content":"Updated annotation text"}],"annotations_to_remove":[{"comment_id":1234,"thread_id":"abc123xyz"}],"links_to_existing_cards_to_add_or_update":[{"linked_card_id":50,"link_type":"relative","linked_card_position":0,"card_position":0}],"links_to_existing_cards_to_remove":[{"linked_card_id":52,"link_type":"child"}],"links_to_new_cards_to_add":[{"linked_new_card_reference":"abc123xyz","link_type":"child","linked_card_position":0,"card_position":0}],"watch":1,"is_archived":0,"version_id":2,"is_discarded":0,"exceeding_reason":"Important","reporter_user_id":4,"reporter_email":"user@mail.example"}]},"DashboardPageUserExample":{"can_edit":1},"InternalAnnouncementCreateRequestExample":{"title":"New Announcement","description":"This is the content of the announcement.","cover_image_link":"https:\/\/images.unsplash.com","for_everyone":1,"start_date":"2025-07-20T12:00:00Z","end_date":"2025-07-30T12:00:00Z","is_popover":1,"recurring_definition":{"type":"cron","expression":"? * WED *","execute_at_hour":11}},"InternalAnnouncementUpdateRequestExample":{"title":"Updated Announcement","description":"This is the updated content of the announcement.","cover_image_link":"https:\/\/images.unsplash.com\/updated","should_delete_existing_views":1,"for_everyone":1,"start_date":"2025-07-21T12:00:00Z","end_date":"2025-07-31T12:00:00Z","for_role_ids_to_add":[1,2],"for_role_ids_to_remove":[3,4],"for_team_ids_to_add":[5,6],"for_team_ids_to_remove":[7,8],"is_popover":0,"recurring_definition":{"type":"cron","expression":"? * FRI *","execute_at_hour":10}},"LaneSectionLimitExample":{"lane_id":1106,"section":3,"limit":5},"LoggedTimeRequestExample":{"parent_card_id":10,"card_id":20,"subtask_id":null,"lane_id":150,"column_id":300,"user_id":2,"category_id":1,"date":"2025-07-20","time":3600,"comment":"Worked on the project."},"LoggedTimeCategoriesBatchBoardOperationsExample":{"board_ids_to_add":[355],"board_ids_to_remove":[94]},"LoggedTimeCategoryRequestExample":{"icon_type":0,"icon_id":2345,"label":"Development","description":"Category for development tasks.","color":"34a97b","availability":0,"is_enabled":1},"MergedAreaRequestExample":{"lane_ids":[1001],"column_ids":[2000,2001],"primary_column_id":2000,"limit":0,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]"},"MilestonesBatchBoardOperationsExample":{"board_ids_to_add":[354],"board_ids_to_remove":[355]},"MilestoneRequestExample":{"icon_type":0,"icon_id":1059,"label":"milestone01","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"},"TagRequestExample":{"label":"tag1","color":"eceff1","availability":0,"is_enabled":1},"OutcomeTagRequestExample":{"label":"Q1 Target"},"OutcomeTagUpdateRequestExample":{"label":"Q1 Target Updated"},"OutcomeCreateRequestExample":{"name":"string","operator":"or_more","starting_time":"2026-01-01T11:00:00+00:00","target_time":"2026-01-02T11:00:00+00:00","starting_value":0,"target_value":100,"current_value":50,"comment":"string","weight":1},"OutcomeUpdateRequestExample":{"name":"string","target_value":120,"current_value":10,"comment":"Updated comment"},"TagsBatchBoardOperationsExample":{"board_ids_to_add":[143],"board_ids_to_remove":[139]},"UserAttributeCreateExample":{"name":"New attribute","remote_name":"New attribute remote"},"DiscardReasonRequestExample":{"label":"discardReason1","availability":0,"is_enabled":1},"BoardStickerRequestExample":{"limit_per_board":0,"limit_per_card":0},"UserRequestExample":{"email":"email1@address.com","username":"username1","realname":"realName1","avatar":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80","email_signature":"

This is a signature.<\/p>","is_tfa_enabled":0,"is_enabled":1,"is_confirmed":1,"attributes_to_add_or_update":[{"attribute_id":1,"value":"value1"}],"attribute_ids_to_delete":[2]},"InviteUserRequestExample":{"email":"email1@address.com","attributes:to_add":[{"attribute_id":1,"value":"value1"},{"attribute_id":2,"value":"value2"}],"do_not_send_confirmation_email":0},"DataFieldCreateRequestExample":{"name":"First Data Field","description":"Text data field","color":"eceff1","type":"single_line_text","is_enabled":1},"WebhookCreateRequestExample":{"url":"https:\/\/example.com\/webhook3","board_id":1,"is_enabled":1},"WorkspaceRequestExample":{"name":"Workspace 1","type":1},"WorkspaceUpdateRequestExample":{"name":"Workspace 1","is_archived":0},"WorkflowCreateRequestExample":{"type":0,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow"},"WorkflowUpdateRequestExample":{"position":0,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow"},"WorkflowCopyRequestExample":{"to_board_id":315,"name":"Copy of the Initiatives workflow","copy_service_level_expectations":1,"copy_column_checklist_items":1,"copy_arrival_rules":1,"copy_departure_rules":1,"copy_default_templates":1},"DataFieldBoardBatchOperationsExample":{"boards_to_add_or_update":[{"board_id":344,"value":"test","value_is_locked":0},{"board_id":346,"value":"test2","value_is_locked":1}],"board_ids_to_remove":[347]},"BoardDataFieldAddOrUpdateRequestExample":{"value":1,"baseline":10,"value_is_locked":1},"WorkspaceDataFieldAddOrUpdateRequestExample":{"value":1,"baseline":10,"show_in_dashboard":1,"dropdown_value_id":null,"contributor_user_id":null}},"responseExamples":{"ResponseBadRequestExample":{"error":{"code":"ABC01","message":"This is an example error message.","reference":"AB-ABC01","details":{"causingParameter":["Error explanation related to parameter."]}}},"ResponseUnauthorizedExample":{"error":{"code":"A002","message":"You are not logged in.","reference":"GE-A0002"}},"ResponseForbiddenExample":{"error":{"code":"A110","message":"You must have the owner privilege to perform this action.","reference":"GE-A110"}},"ResponseNotFoundExample":{"error":{"code":"ABC02","message":"The requested resource was not found.","reference":"AB-ABC02","details":{"type":"object","properties":{"causingParameter":{"description":"ID of the resource that was not found."}}}}},"ResponseConflictExample":{"error":{"code":"ABC03","message":"The requested resource was not found.","reference":"AB-ABC03","details":{"type":"object","properties":{"causingParameter":{"description":"ID of the resource for which the conflict occurred."}}}}},"ResponseTooManyRequestsExample":{"error":{"code":"RL02","message":"You have exceeded the minutely request limit. The limit is 10 and you've made 10 requests prior to this one. You can try again after 59 seconds.","reference":"GE-RL02","details":{"limit":10,"requests":10,"retry_after":59}}},"ResponsePaginationExample":{"description":"Pagination information for the response.","type":"object","properties":{"all_pages":{"description":"The total number of pages in the paginated result set.","type":"integer"},"current_page":{"description":"The page number of the current set of results.","type":"integer"},"results_per_page":{"description":"The number of results per page.","type":"integer"}}},"ApiLimitExample":{"data":[{"type":"hourly","limit":600},{"type":"minutely","limit":30}]},"ApiRequestHistoryExample":{"pagination":{"all_pages":1994,"current_page":1,"results_per_page":100},"data":[{"user_id":2,"resource":"api\/v*\/cards\/*","method":"get","status_code":404,"support_reference":null,"time":"2025-06-10T08:08:51+00:00"},{"user_id":2,"resource":"api\/v*\/boards\/*\/lanes\/*","method":"patch","status_code":200,"support_reference":null,"time":"2025-06-09T18:02:08+00:00"},{"user_id":2,"resource":"api\/v*\/boards\/*\/lanes","method":"get","status_code":200,"support_reference":null,"time":"2025-06-09T16:45:13+00:00"}]},"ApiRequestHistoryAggregatedExample":{"data":[{"user_id":2,"request_count":1,"time":"2024-12-23T00:00:00+00:00"},{"user_id":59,"request_count":5,"time":"2025-02-19T00:00:00+00:00"}]},"ArrivalRuleHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":113,"rule_id":31,"event_type":"updated","user_id":2,"details":{"previous_state":{"rule_id":31,"name":"test","is_enabled":1,"board_id":1001,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[]},"changes":{"conditions":[{"field_type":"plain","operator":"do_not_contain","field_name":"tags","values":[1],"ignore_if_not_present":0},{"field_type":"plain","operator":"=","field_name":"type","values":[5],"ignore_if_not_present":0}]}},"time":"2025-06-24T08:34:56+00:00"}]},"DepartureRuleHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":113,"rule_id":31,"event_type":"updated","user_id":2,"details":{"previous_state":{"rule_id":31,"name":"test","is_enabled":1,"board_id":1001,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[]},"changes":{"conditions":[{"field_type":"plain","operator":"do_not_contain","field_name":"tags","values":[1],"ignore_if_not_present":0},{"field_type":"plain","operator":"=","field_name":"type","values":[5],"ignore_if_not_present":0}]}},"time":"2025-06-24T08:34:56+00:00"}]},"ArchiveCardVersionsExample":{"data":[{"version_id":1999,"name":"Autoarchive: 2025-01-02"},{"version_id":2000,"name":"Autoarchive: 2025-01-03"},{"version_id":2001,"name":"Autoarchive: 2025-01-04"}]},"ArchiveCardVersionExample":{"data":{"version_id":2149,"name":"Archived Card Version 1.0"}},"BaiPromptHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":113,"prompt_id":31,"event_type":"deleted","user_id":2,"details":{"board_id":301,"type":2,"color":"7333bd","icon_type":0,"icon_id":1059,"name":"subtasksPrompt - 1 (updated)","context":"General Situation","topics":"Important Topics","fields_instructions":"Instructions","suggest_missing_topics":1,"author_user_id":2,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"subtasks"},{"field_type":"custom","field_id":80}]},"time":"2025-06-24T08:34:56+00:00"},{"history_id":112,"prompt_id":31,"event_type":"updated","user_id":2,"details":{"previous_state":{"board_id":301,"type":2,"color":"7333bd","icon_type":0,"icon_id":1059,"name":"subtasksPrompt - 1","context":"General Situation","topics":"Important Topics","fields_instructions":"Instructions","suggest_missing_topics":1,"author_user_id":2,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"subtasks"},{"field_type":"custom","field_id":80}]},"changes":{"name":"subtasksPrompt - 1 (updated)"}},"time":"2025-06-24T08:34:54+00:00"},{"history_id":111,"prompt_id":31,"event_type":"created","user_id":2,"details":{"type":2,"color":"7333bd","icon_id":1059,"name":"subtasksPrompt - 1","context":"General Situation","topics":"Important Topics","fields_instructions":"Instructions","suggest_missing_topics":1,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"subtasks"},{"field_type":"custom","field_id":80}],"icon_type":0,"board_id":301,"author_user_id":2},"time":"2025-06-24T08:34:45+00:00"}]},"BlockReasonBoardsExample":{"data":[{"board_id":131},{"board_id":135},{"board_id":136},{"board_id":137}]},"BlockReasonsHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":943,"reason_id":11,"event_type":"updated","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1012,"label":"newBlockReason","color":null,"with_cards":0,"with_date":0,"with_users":0,"availability":0,"is_enabled":1},"changes":{"label":"newBlockReason - updated"}},"time":"2025-06-30T06:36:27+00:00"}]},"BlockReasonsExample":{"data":[{"reason_id":1,"icon_type":0,"icon_id":1050,"label":"Waiting on us","color":"ef5350","availability":1,"is_enabled":1},{"reason_id":2,"icon_type":0,"icon_id":1051,"label":"Waiting on others","color":"880e4f","availability":1,"is_enabled":1}]},"BlockReasonExample":{"data":{"reason_id":1,"icon_type":0,"icon_id":1050,"label":"Waiting on us","color":"ef5350","availability":1,"is_enabled":1}},"BoardAccessRequestsExample":{"data":[{"board_id":97,"user_id":49,"comment":"Lorem ipsum dolor sit amet.","time":"2025-07-01T11:29:24+00:00"},{"board_id":97,"user_id":60,"comment":"comment","time":"2025-07-02T08:38:33+00:00"}]},"BoardArrivalRulesExample":{"data":[{"rule_id":17,"name":"arrivalRule1","is_enabled":1,"workflow_id":null,"lane_id":1020,"column_id":4100,"area_id":null,"conditions":[{"field_type":"plain","field_name":"block_time","operator":"=","ignore_if_not_present":0,"values":["2 days"]}]},{"rule_id":19,"name":"arrivalRule2","is_enabled":1,"workflow_id":null,"lane_id":1020,"column_id":4100,"area_id":null,"conditions":[{"field_type":"plain","field_name":"attachments","operator":"are_present","ignore_if_not_present":0,"values":[]}]}]},"BoardArrivalRuleExample":{"data":{"name":"arrivalRule","is_enabled":1,"workflow_id":null,"lane_id":1020,"column_id":4100,"area_id":null,"conditions":[{"field_type":"plain","field_name":"attachments","operator":"are_not_present","ignore_if_not_present":0,"values":[]},{"field_type":"plain","field_name":"author","operator":"!=","ignore_if_not_present":0,"values":[2]},{"field_type":"custom","field_id":153,"operator":"contains","ignore_if_not_present":0,"values":["av:134","av:135"]}]}},"BoardBaiPromptsExample":{"data":[{"prompt_id":32,"board_id":315,"type":1,"color":"7333bd","icon_type":0,"icon_id":1059,"name":"promptName","context":"generalSituation","topics":"additionalTopics","fields_instructions":"instructions","suggest_missing_topics":0,"author_user_id":2,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"comments"}]},{"prompt_id":34,"board_id":315,"type":1,"color":"7333bd","icon_type":0,"icon_id":1059,"name":"promptName2","context":"generalSituation2","topics":"importantTopics2","fields_instructions":"instructions2","suggest_missing_topics":0,"author_user_id":2,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"comments"}]}]},"BoardBaiPromptExample":{"data":{"type":1,"color":"7333bd","icon_id":1059,"name":"promptName2","context":"generalSituation2","topics":"importantTopics2","fields_instructions":"instructions2","suggest_missing_topics":0,"fields":[{"field_type":"plain","field_name":"title"},{"field_type":"plain","field_name":"description"},{"field_type":"plain","field_name":"comments"}],"icon_type":0,"board_id":315,"author_user_id":2,"prompt_id":34}},"BoardAssigneesExample":{"data":[{"user_id":2,"role_id":1},{"user_id":49,"role_id":1},{"user_id":57,"role_id":1}]},"BoardUserRoleExample":{"data":{"role_id":1}},"BoardBlockReasonsExample":{"data":[{"reason_id":1},{"reason_id":2},{"reason_id":92}]},"CardBlockReasonGetExample":{"data":{"block_type":1,"reason_id":1,"comment":"string"}},"CardTemplateCreateResponseExample":{"data":{"name":"templateName","description":"","availability":0,"is_enabled":1,"template_id":46,"primary_template_card_id":73,"template_cards":[{"template_card_id":73,"reference":"PCR","title":"primaryCardName","description":"","custom_id":null,"owner_user_id":null,"type_id":null,"size":null,"priority":null,"color":null,"deadline":null,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"attachments":[],"subtasks":[],"stickers":[],"linked_cards":[],"custom_fields":[],"tag_ids":[],"milestone_ids":[],"co_owner_ids":[],"watcher_ids":[],"annotations":[]}]}},"CardTemplateUpdateResponseExample":{"data":{"template_id":32,"primary_template_card_id":52,"name":"newTemplate","description":"","availability":0,"is_enabled":1,"template_cards":[{"template_card_id":52,"title":"newTemplateCard","description":"","custom_id":null,"owner_user_id":null,"type_id":null,"size":null,"priority":3,"color":"34a97b","deadline":null,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"attachments":[],"subtasks":[],"stickers":[],"linked_cards":[],"custom_fields":[],"tag_ids":[],"milestone_ids":[],"co_owner_ids":[],"watcher_ids":[],"annotations":[]}]}},"CardTemplateCardExample":{"data":{"template_card_id":62,"title":"Template Card","description":"Card description.","custom_id":"Card01","owner_user_id":2,"type_id":1,"size":2,"priority":3,"color":"ff5733","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"board_id":318,"workflow_id":711,"section":2,"column_id":4129,"lane_id":1026,"position":1,"attachments":[{"id":123,"file_name":"template_card_attachment.png","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"subtasks":[{"template_subtask_id":1,"description":"Subtask 1","owner_user_id":2,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"position":0,"attachments":[{"id":124,"file_name":"subtask_attachment.png","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}]}],"stickers":[{"id":4,"sticker_id":1}],"linked_cards":[{"template_card_id":2002,"link_type":"relative","position":0}],"custom_fields":[{"field_id":5319,"value":"Custom field value"}],"tag_ids":[1],"milestone_ids":[1],"co_owner_ids":[3],"watcher_ids":[4],"annotations":[{"thread_id":"abc123xyz","comment_id":240,"author_id":3,"content":"annotation text","created_at":"2025-07-20 11:00:00"}]}},"BoardCardAndInitiativeViewSettingsExample":{"data":{"card_card_size":"big","card_attachments":"icon","card_id":"effective_id","card_co_owners":"off","card_color_entire_surface":"off","card_comments":"on","card_cover":"on","card_created_at":"off","card_custom_fields":"row","card_custom_fields_to_show":"all","card_custom_fields_ids":[],"card_custom_fields_only_filled":"off","card_cycle_time":"icon","card_deadline":"icon","card_exit_criteria":"row_unchecked_only","card_last_modified":"off","card_last_moved":"off","card_links":"row","card_include_parents":"on","card_include_children":"on","card_include_relatives":"on","card_include_predecessors":"on","card_include_successors":"on","card_links_in_backlog":"on","card_links_in_requested":"on","card_links_in_progress":"on","card_links_in_done":"on","card_links_in_archive":"on","card_link_order":"off","card_link_group_by":"link_type","card_link_type_group_order":["parent","child","relative","predecessor","successor"],"card_local_cycle_time":"off","card_logged_time":"off","card_logged_time_with_subtasks":"off","card_logged_time_with_children":"off","card_owner":"avatar_and_username","card_priority":"icon","card_reporter":"off","card_size":"icon","card_stickers":"icon","card_subtasks":"row_all","card_tags":"row","card_title":"medium","card_type":"icon","initiative_width":"auto","initiative_height":"high","initiative_attachments":"icon","initiative_id":"custom_id","initiative_co_owners":"icon","initiative_color_entire_surface":"off","initiative_comments":"on","initiative_cover":"off","initiative_created_at":"on","initiative_custom_fields":"icon","initiative_custom_fields_to_show":"all","initiative_custom_fields_ids":[],"initiative_custom_fields_only_filled":"off","initiative_cycle_time":"icon","initiative_deadline":"icon","initiative_exit_criteria":"icon","initiative_last_modified":"on","initiative_last_moved":"on","initiative_links":"row_compact","initiative_include_parents":"on","initiative_include_children":"on","initiative_include_relatives":"off","initiative_include_predecessors":"off","initiative_include_successors":"off","initiative_links_in_backlog":"on","initiative_links_in_requested":"on","initiative_links_in_progress":"on","initiative_links_in_done":"on","initiative_links_in_archive":"on","initiative_link_order":"off","initiative_link_group_by":"link_type","initiative_link_type_group_order":["parent","child","relative","predecessor","successor"],"initiative_local_cycle_time":"off","initiative_logged_time":"icon","initiative_logged_time_with_subtasks":"off","initiative_logged_time_with_children":"off","initiative_outcomes":"icon","initiative_owner":"avatar_only","initiative_priority":"icon","initiative_reporter":"on","initiative_size":"icon","initiative_stickers":"icon","initiative_subtasks":"icon","initiative_tags":"icon","initiative_title":"short","initiative_type":"icon","initiative_planned_start_date":"icon","initiative_planned_end_date":"icon","initiative_progress":"on"}},"BoardCardTemplatesExample":{"data":[{"template_id":737560},{"template_id":737561},{"template_id":737562},{"template_id":737563},{"template_id":737564}]},"BoardCardTypesExample":{"data":[{"type_id":463099,"icon_type":null,"icon_id":null,"color":null,"card_color_sync":null},{"type_id":463102,"icon_type":null,"icon_id":null,"color":null,"card_color_sync":null},{"type_id":463116,"icon_type":null,"icon_id":null,"color":null,"card_color_sync":null},{"type_id":463228,"icon_type":null,"icon_id":null,"color":null,"card_color_sync":null}]},"BoardCardTypeExample":{"data":{"icon_type":0,"icon_id":1038,"color":"666666","card_color_sync":0}},"ChecklistItemsExample":{"data":[{"item_id":69,"text":"Exit criterion 1","position":0,"allowed_users":[{"user_id":2}]},{"item_id":70,"text":"Exit criterion 2","position":1,"allowed_users":[{"user_id":2}]}]},"ChecklistItemExample":{"data":{"text":"exitCriterionName","position":0,"item_id":74,"allowed_users":[{"user_id":2}]}},"ColumnChecklistItemAllowedUsersExample":{"data":[{"user_id":2}]},"BoardCustomFieldAllowedValuesExample":{"data":[{"value_id":140,"position":0,"is_enabled":1,"is_default":0},{"value_id":141,"position":1,"is_enabled":1,"is_default":0}]},"BoardCustomFieldAllowedValueExample":{"data":{"position":0,"is_enabled":1,"is_default":0}},"BoardCustomFieldDefaultContributorsExample":{"data":[{"user_id":2},{"user_id":9}]},"BoardCustomFieldsExample":{"data":[{"field_id":80,"position":0,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null},{"field_id":152,"position":1,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null},{"field_id":158,"position":2,"color":"","is_always_present":0,"display_width":1,"min_number_of_values":0,"max_number_of_values":1,"inherit_default_values":0,"allow_other_value":0},{"field_id":98,"position":3,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null},{"field_id":99,"position":4,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null},{"field_id":153,"position":5,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null},{"field_id":159,"position":6,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":0,"allow_other_value":null}]},"BoardDataFieldsExample":{"data":[{"data_field_id":80,"value":1,"baseline":10,"value_is_locked":0,"dropdown_value_id":null,"contributor_user_id":null},{"data_field_id":81,"value":null,"baseline":"User contributing to finish the card","value_is_locked":1,"dropdown_value_id":null,"contributor_user_id":2},{"data_field_id":82,"value":null,"baseline":"Dropdown value selected","value_is_locked":1,"dropdown_value_id":21,"contributor_user_id":null}]},"BoardDataFieldExample":{"data":[{"data_field_id":80,"value":1,"baseline":10,"value_is_locked":1}]},"BoardDataFieldUpdateValueExample":{"data":{"data_field_id":80,"board_id":1090,"value":5}},"WorkspaceDataFieldsExample":{"data":[{"workspace_id":727,"data_field_id":80,"value":1,"baseline":10,"show_in_dashboard":1,"dropdown_value_id":null,"contributor_user_id":null,"value_is_locked_for_all_boards":1,"apply_to_all_boards_in_workspace":1},{"data_field_id":81,"value":null,"baseline":"User contributing to finish the card","show_in_dashboard":0,"dropdown_value_id":null,"contributor_user_id":2,"value_is_locked_for_all_boards":0,"apply_to_all_boards_in_workspace":1},{"data_field_id":82,"value":null,"baseline":"Dropdown value selected","show_in_dashboard":0,"dropdown_value_id":21,"contributor_user_id":null,"value_is_locked_for_all_boards":0,"apply_to_all_boards_in_workspace":0}]},"WorkspaceDataFieldExample":{"data":[{"workspace_id":727,"data_field_id":80,"value":1,"baseline":10,"show_in_dashboard":1}]},"WorkspaceDataFieldShowInDashboardExample":{"data":[{"data_field_id":80,"value":1,"baseline":10,"dropdown_value_id":null,"contributor_user_id":null},{"data_field_id":81,"value":null,"baseline":"User contributing to finish the card","dropdown_value_id":null,"contributor_user_id":2},{"data_field_id":82,"value":null,"baseline":"Dropdown value selected","dropdown_value_id":21,"contributor_user_id":null}]},"BoardCustomFieldExample":{"data":{"position":15,"color":"eceff1","is_always_present":0,"display_width":1,"min_number_of_selected_cards":0,"max_number_of_selected_cards":1,"search":null}},"BoardCustomFieldEffectiveSettingsExample":{"data":{"color":"eceff1","is_always_present":0,"display_width":1,"value_is_required":0,"default_value":""}},"BoardDefaultSettingsExample":{"data":[{"name":"board_settings.default_template","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":1}]},"BoardDefaultSettingExample":{"data":{"name":"board_settings.default_template","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":1}},"BoardDepartureRulesExample":{"data":[{"rule_id":10,"name":"departureRule","is_enabled":1,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[{"field_type":"plain","field_name":"attachments","operator":"are_present","ignore_if_not_present":0,"values":[]}]},{"rule_id":11,"name":"departureRule2","is_enabled":1,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[{"field_type":"plain","field_name":"author","operator":"=","ignore_if_not_present":0,"values":[2,63]}]},{"rule_id":12,"name":"departureRule3","is_enabled":1,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[{"field_type":"plain","field_name":"block_time","operator":"=","ignore_if_not_present":0,"values":["1 days"]}]}]},"BoardDepartureRuleExample":{"data":{"name":"departureRule3","is_enabled":1,"workflow_id":null,"lane_id":null,"column_id":null,"area_id":null,"conditions":[{"field_type":"plain","field_name":"block_time","operator":"=","ignore_if_not_present":0,"values":["1 days"]}],"rule_id":13}},"BoardStructureExample":{"data":{"version":"1.0","workspace_id":727,"board_id":1090,"name":"Simple board","description":"","is_archived":0,"workflow_order":[1722],"workflows":{"1722":{"type":0,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow","top_lanes":[9865],"bottom_lanes":[9865],"top_columns":[16019,16020,16021,16030,16022,16023],"bottom_columns":[16019,16031,16032,16021,16030,16022,16023],"section_columns":{"1":[16019],"2":[16020],"3":[16021,16030],"4":[16022],"5":[16023]}}},"lanes":{"9865":{"workflow_id":1722,"name":"Default Swimlane","description":"","color":"ffffff"}},"columns":{"16019":{"workflow_id":1722,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"e6186a","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]","checklist_items":[196,197,198]},"16020":{"workflow_id":1722,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"7333bd","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"created_at\"}]","checklist_items":[199,200,201]},"16021":{"workflow_id":1722,"section":3,"parent_column_id":0,"name":"In Progress Column 1","description":"","color":"2666be","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"custom_id\"}]","checklist_items":[202,203,"204"]},"16022":{"workflow_id":1722,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"42af49","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"cycle_time\"}]","checklist_items":[205,206,207]},"16023":{"workflow_id":1722,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"fdd835","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"deadline\"}]","checklist_items":[208,209,210]},"16030":{"workflow_id":1722,"section":3,"parent_column_id":0,"name":"In Progress Column 2","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"16031":{"workflow_id":1722,"section":2,"parent_column_id":16020,"name":"Requested Child 1","description":"","color":"7333bd","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"16032":{"workflow_id":1722,"section":2,"parent_column_id":16020,"name":"Requested Child 2","description":"","color":"7333bd","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]}},"child_columns":{"16020":[16031,16032]},"column_checklist_items":{"196":{"column_id":16019,"text":"criterion1","position":0},"197":{"column_id":16019,"text":"criterion2","position":1},"198":{"column_id":16019,"text":"criterion3","position":2},"199":{"column_id":16020,"text":"criterion1","position":0},"200":{"column_id":16020,"text":"criterion1","position":1},"201":{"column_id":16020,"text":"criterion1","position":2},"202":{"column_id":16021,"text":"criterion1","position":0},"203":{"column_id":16021,"text":"criterion1","position":1},"205":{"column_id":16022,"text":"criterion1","position":0},"206":{"column_id":16022,"text":"criterion1","position":1},"207":{"column_id":16022,"text":"criterion1","position":2},"208":{"column_id":16023,"text":"criterion1","position":0},"209":{"column_id":16023,"text":"criterion1","position":1},"210":{"column_id":16023,"text":"criterion1","position":2},"'204'":{"column_id":16021,"text":"criterion1","position":2}},"size_type":2,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":"average(1,2)","deadline_formula":"end_of_day(card.created_at())","default_sender_user_id":2147483647,"default_receiver_user_id":2,"allow_generic_blocker":1,"cell_card_orderings":{"9865":{"16019":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]","16021":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"custom_id\"}]","16022":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"cycle_time\"}]","16023":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"deadline\"}]","16031":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"created_at\"}]"}},"cell_limits":{"9865":{"16019":1,"16021":3,"16022":4,"16023":5,"16031":2}},"lane_section_limits":{"9865":{"3":10}},"merged_areas":{"520":{"primary_column_id":16021,"limit":0,"card_ordering":null,"lane_ids":[9865],"column_ids":[16021,16030]}},"revision":27}},"BusinessRulesExecutionHistoryExample":{"pagination":{"all_pages":789,"current_page":1,"results_per_page":100},"data":[{"id":1,"business_rule_id":12,"business_rule_name":"Card is updated","executed_on_card_id":143,"executed_at":"2025-06-11T14:32:44+00:00"},{"id":2,"business_rule_id":10,"business_rule_name":"Card is created","executed_on_card_id":150,"executed_at":"2025-06-11T14:16:09+00:00"},{"id":3,"business_rule_id":5,"business_rule_name":"Card is updated - main board","executed_on_card_id":80,"executed_at":"2025-06-11T14:14:46+00:00"}]},"BusinessRulesActiveRulesLimitExample":{"data":20},"CalculatedOutcomeValueRulesActiveRulesLimitExample":{"data":200},"CalculatedOutcomeValueRulesExecutionHistoryExample":{"pagination":{"all_pages":315,"current_page":1,"results_per_page":100},"data":[{"rule_id":4,"card_id":23,"start_time":"2025-07-16T07:41:00+00:00","end_time":"2025-07-16T07:41:01+00:00","request_status":"ok","limit_exceeded":0,"processing_result":"ok","is_requested_by_user":0}]},"BoardDiscardReasonsExample":{"data":[{"reason_id":2},{"reason_id":3},{"reason_id":4}]},"BoardHistoryEventsExample":{"pagination":{"all_pages":132,"current_page":1,"results_per_page":100},"data":[{"history_id":13351,"board_id":325,"event_type":"custom_field_removed","user_id":2,"details":{"field_id":68},"time":"2025-07-16T07:05:53+00:00"},{"history_id":13350,"board_id":325,"event_type":"custom_field_removed","user_id":2,"details":{"field_id":67},"time":"2025-07-16T07:05:53+00:00"},{"history_id":13349,"board_id":325,"event_type":"custom_field_added","user_id":2,"details":{"field_id":163},"time":"2025-07-16T07:05:50+00:00"},{"history_id":13348,"board_id":325,"event_type":"updated","user_id":2,"details":{"previous_state":{"workspace_id":220,"is_archived":0,"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":null,"deadline_formula":"card.created_at()","name":"1050248","description":"

Description<\/p>","default_sender_user_id":null,"default_receiver_user_id":null,"allow_generic_blocker":1,"type":1,"main_maestro_instance_id":null},"changes":{"deadline_formula":null}},"time":"2025-07-16T06:47:00+00:00"},{"history_id":13347,"board_id":325,"event_type":"updated","user_id":2,"details":{"previous_state":{"workspace_id":220,"is_archived":0,"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":"average(1,2)","deadline_formula":"card.created_at()","name":"1050248","description":"

Description<\/p>","default_sender_user_id":null,"default_receiver_user_id":null,"allow_generic_blocker":1,"type":1,"main_maestro_instance_id":null},"changes":{"size_formula":null}},"time":"2025-07-16T06:46:58+00:00"}]},"BoardLoggedTimeCategoriesExample":{"data":[{"category_id":1},{"category_id":2},{"category_id":3}]},"CardAttachmentsExample":{"data":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}]},"CardAttachmentExample":{"data":{"id":143,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}},"BoardMilestonesExample":{"data":[{"milestone_id":3},{"milestone_id":10},{"milestone_id":11}]},"BoardPointsOfContactExample":{"data":[{"user_id":2}]},"CardColumnChecklistItemsExample":{"data":[{"item_id":1,"comment":"Subtasks are completed."},{"item_id":2,"comment":"All attachments are uploaded."}]},"CardColumnChecklistItemExample":{"data":{"item_id":1,"comment":"Subtasks are completed."}},"CardCommentAttachmentExample":{"data":{"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}},"CardCommentAttachmentIDExample":{"data":{"id":1,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}},"CardCommentAttachmentsExample":{"data":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}]},"CardCommentsExample":{"data":[{"comment_id":1,"type":"plain","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","author":{"type":"internal","value":2}},{"comment_id":2,"type":"sent as email","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","sender":{"type":"internal","value":2},"recepients":{"to":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}],"cc":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}],"bcc":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}]}}]},"CardCommentsWithCardIdExample":{"data":[{"card_id":1,"comment_id":1,"type":"plain","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","author":{"type":"internal","value":2}},{"comment_id":2,"type":"sent as email","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","sender":{"type":"internal","value":2},"recepients":{"to":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}],"cc":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}],"bcc":[{"type":"internal","value":2},{"type":"external","value":"example@email.com"}]}}]},"CardCommentCreatedResponseExample":{"data":{"type":"plain","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","author":{"type":"internal","value":2},"comment_id":1}},"CardCommentIDResponseExample":{"data":{"type":"plain","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-16T07:01:00+00:00","author":{"type":"internal","value":2}}},"CardCommentIDUpdatedResponseExample":{"data":{"type":"plain","text":"string","attachments":[{"id":141,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"},{"id":142,"file_name":"document.docx","link":"\/files\/a1b2c3d4e5f6g7h8i9j0"}],"created_at":"2025-07-16T07:00:00+00:00","last_modified":"2025-07-18T07:01:00+00:00","author":{"type":"internal","value":2}}},"BoardSettingsExample":{"data":{"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":"average(1,2)","deadline_formula":"card.created_at()","default_sender_user_id":1,"default_receiver_user_id":2,"allow_generic_blocker":1}},"CardCoverImageExample":{"data":{"attachment_id":115,"width":210,"height":170,"link":"\/coverImages\/a1b2c3d4e5f6g7h8i9j0"}},"BoardStickersExample":{"data":[{"sticker_id":1},{"sticker_id":2},{"sticker_id":3},{"sticker_id":4}]},"BoardStickerExample":{"data":{"limit_per_board":0,"limit_per_card":0}},"CurrentBoardStructureRevisionExample":{"data":{"revision":3}},"BoardStructureRevisionsExample":{"data":[{"revision":1,"replaced_at":"2025-07-15T13:38:54+00:00"},{"revision":2,"replaced_at":"2025-07-17T14:07:56+00:00"}]},"BoardStructureRevisionExample":{"data":{"version":"1.0","workspace_id":221,"board_id":326,"name":"testingPlan","description":"","is_archived":0,"workflow_order":[730,729],"workflows":{"729":{"type":0,"position":1,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow","top_lanes":[1044],"bottom_lanes":[1044],"top_columns":[4218,4219,4220,4221,4222],"bottom_columns":[4218,4219,4220,4221,4222],"section_columns":{"1":[4218],"2":[4219],"3":[4220],"4":[4221],"5":[4222]}},"730":{"type":1,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Initiatives workflow","top_lanes":[1045],"bottom_lanes":[1045],"top_columns":[4223,4224,4225,4226,4227],"bottom_columns":[4223,4224,4225,4226,4227],"section_columns":{"1":[4223],"2":[4224],"3":[4225],"4":[4226],"5":[4227]}}},"lanes":{"1044":{"workflow_id":729,"parent_lane_id":0,"name":"Default Swimlane","description":"","color":"ffffff"},"1045":{"workflow_id":730,"parent_lane_id":0,"name":"Portfolio Lane","description":"","color":"ffffff"}},"columns":{"4218":{"workflow_id":729,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4219":{"workflow_id":729,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4220":{"workflow_id":729,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4221":{"workflow_id":729,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4222":{"workflow_id":729,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4223":{"workflow_id":730,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4224":{"workflow_id":730,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4225":{"workflow_id":730,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4226":{"workflow_id":730,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4227":{"workflow_id":730,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]}},"child_lanes":{},"child_columns":{},"column_checklist_items":{},"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":null,"deadline_formula":null,"default_sender_user_id":null,"default_receiver_user_id":null,"allow_generic_blocker":1,"type":1,"main_maestro_instance_id":null,"cell_card_orderings":{},"cell_limits":{},"lane_section_limits":{},"merged_areas":{},"revision":2,"replaced_at":"2025-07-17T14:07:56+00:00"}},"CardCoOwnersExample":{"data":[{"user_id":2},{"user_id":3}]},"CardCustomFieldContributorsExample":{"data":[{"user_id":4},{"user_id":5}]},"CardCustomFieldSelectedCardsExample":{"data":[{"selected_card_id":1001,"position":0},{"selected_card_id":1002,"position":1}]},"CardCustomFieldSelectedCardExample":{"data":{"position":0}},"CardCustomFieldSelectedValuesExample":{"data":[{"value_id":2001,"position":0},{"value_id":2002,"position":1}]},"CardCustomFieldSelectedValueExample":{"data":{"position":0}},"CardCustomFieldFilesExample":{"data":[{"id":2001,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":2002,"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}]},"CardCustomFieldFileCreatedExample":{"data":{"id":2003,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}},"CardCustomFieldFileExample":{"data":{"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}},"CardCustomFieldsExample":{"data":[{"field_id":101,"value":"string","display_value":"string*"},{"field_id":102,"value":"string
string"},{"field_id":103,"value":123.45,"display_value":"123.45$"},{"field_id":104,"value":"2025-07-16"},{"field_id":105,"value":"https:\/\/example.com"},{"field_id":106,"values":["Option 1","Option 2"]},{"field_id":107,"contributors":[{"user_id":4},{"user_id":5}]},{"field_id":108,"files":[{"id":2001,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":2002,"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}]},{"field_id":109,"votes":[{"vote":1,"user_id":2,"comment":"string"}]},{"field_id":110,"selected_cards":[{"selected_card_id":1001,"position":0},{"selected_card_id":1002,"position":1}]},{"field_id":111,"value":12,"display_value":"12%"},{"field_id":112,"value":"2025-06-20"}]},"CardCustomFieldExample":{"data":{"field_id":101,"value":"string","display_value":"string*"}},"BoardTagsExample":{"data":[{"tag_id":23},{"tag_id":24},{"tag_id":25}]},"CardCustomFieldVotesExample":{"data":[{"vote":1,"comment":"Great idea!","user_id":5},{"vote":0,"comment":"Needs more work.","user_id":12}]},"CardCustomFieldVoteExample":{"data":{"vote":1,"comment":"Great idea!"}},"LinkedCardsExample":{"data":[{"card_id":1001,"type":"child","position":0},{"card_id":1120,"type":"relative","position":1}]},"BoardTeamsExample":{"data":[{"team_id":14,"role_id":1},{"team_id":15,"role_id":1},{"team_id":16,"role_id":1}]},"BoardTeamExample":{"data":{"role_id":1}},"BoardTeamCreateOrUpdateExample":{"data":{"board_id":328,"team_id":16,"role_id":1}},"BoardVisibleStandardFieldsExample":{"data":{"board_id":328,"last_modified":0,"in_current_position_since":0,"created_at":0,"reporter":0}},"BoardsExample":{"data":[{"board_id":6,"workspace_id":1,"is_archived":1,"name":"Development","description":"","type":1},{"board_id":7,"workspace_id":1,"is_archived":1,"name":"QA","description":"","type":1},{"board_id":8,"workspace_id":1,"is_archived":1,"name":"Marketing \/ Business","description":"","type":1},{"board_id":10,"workspace_id":4,"is_archived":1,"name":"IT Company Overview","description":"","type":1}]},"BoardExample":{"data":{"workspace_id":1,"is_archived":1,"name":"Development","description":"","type":1,"revision":24}},"BoardCreateExample":{"data":{"board_id":331,"workspace_id":224,"is_archived":0,"name":"New Board","description":"Lorem ipsum dolor sit amet.","type":1,"main_maestro_instance_id":null}},"BoardUpdateExample":{"data":{"workspace_id":224,"is_archived":1,"name":"New Board Updated","description":"Updated description.","type":1,"main_maestro_instance_id":null}},"CardMilestonesExample":{"data":[{"milestone_id":1},{"milestone_id":2}]},"CardOutcomesExample":{"data":[{"outcome_id":101,"position":0},{"outcome_id":102,"position":1}]},"CardOutcomePositionExample":{"data":{"position":0}},"CardOutcomeCurrentValueExample":{"data":{"id":101,"value":100,"time":"2025-07-01T12:00:00+00:00"}},"CardOutcomeHistoryExample":{"data":[{"history_id":1000,"outcome_id":100,"event_type":2,"event_guid":"A1B2C3D4E5F6G7H8I9J0","user_id":2,"old_value":"{\"field_id\":null,\"rule_id\":141,\"name\":null,\"operator\":\"or_more\",\"starting_value\":0,\"target_value\":100,\"comment\":\"string\",\"starting_value_formula\":null,\"target_value_formula\":null,\"current_value_formula\":null,\"starting_value_predefined_formula_type\":null,\"target_value_predefined_formula_type\":null,\"current_value_predefined_formula_type\":null,\"weight\":1}","changes":"{\"target_value\":1000}","time":"2025-07-01T12:00:00+00:00"}]},"CardOutcomeCheckpointsExample":{"data":[{"id":1,"time":"2025-07-19T12:00:00+00:00","name":"First stage","value":10},{"id":2,"time":"2025-07-22T12:00:00+00:00","name":"Second stage","value":15}]},"CardOutcomeCheckpointExample":{"data":{"id":3,"time":"2025-07-20T12:00:00+00:00","name":"First stage","value":50}},"OutcomeCheckpointDetailExample":{"data":{"time":"2025-07-20T12:00:00+00:00","name":"First stage","value":50}},"OutcomeValueDetailExample":{"data":{"time":"2023-06-15T10:00:00+00:00","value":42}},"CardOutcomeValuesExample":{"data":[{"id":90,"value":100,"time":"2025-07-01T12:00:00+00:00"},{"id":91,"value":150,"time":"2025-07-02T12:00:00+00:00"}]},"CardOutcomeValueExample":{"data":{"id":92,"value":200,"time":"2025-07-03T12:00:00+00:00"}},"CardOutcomeValueWithOutcomeIdExample":{"data":{"outcome_id":12,"value":200,"time":"2025-07-03T12:00:00+00:00","id":92}},"CardOutcomeExample":{"data":{"field_id":null,"rule_id":null,"name":"ownValueMetric","operator":"or_more","starting_value":1,"target_value":3,"current_value":2,"comment":"summary","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"weight":1,"created_at":"2025-07-22 07:32:27","checkpoints":[],"links_to_cards":[],"links_to_outcomes":[],"links_from_outcomes":[]}},"CardLinkedCardsExample":{"data":[{"card_id":1001,"position":0},{"card_id":1002,"position":1}]},"CardLinkedCardExample":{"data":{"position":0}},"CardLinkedTemplateCardsExample":{"data":[{"template_card_id":1001,"position":0},{"template_card_id":1002,"position":1}]},"CardParentGraphExample":{"data":[{"child_card_id":10,"parent_card_id":11,"depth":1},{"child_card_id":11,"parent_card_id":12,"depth":2}]},"CardOutcomeValueForecastExample":{"data":{"predictions":[{"date":"2025-01-01","value":43.56},{"date":"2025-01-02","value":54.37},{"date":"2025-01-03","value":65.18},{"date":"2025-01-04","value":75.99},{"date":"2025-01-05","value":86.8},{"date":"2025-01-06","value":97.6},{"date":"2025-01-07","value":108.41},{"date":"2025-01-08","value":119.22},{"date":"2025-01-09","value":130.03},{"date":"2025-01-10","value":140.84},{"date":"2025-01-11","value":151.65},{"date":"2025-01-12","value":162.46},{"date":"2025-01-13","value":173.26},{"date":"2025-01-14","value":184.07},{"date":"2025-01-15","value":194.88},{"date":"2025-01-16","value":205.69},{"date":"2025-01-17","value":216.5},{"date":"2025-01-18","value":227.31},{"date":"2025-01-19","value":238.12},{"date":"2025-01-20","value":248.92},{"date":"2025-01-21","value":259.73},{"date":"2025-01-22","value":270.54},{"date":"2025-01-23","value":281.35},{"date":"2025-01-24","value":292.16},{"date":"2025-01-25","value":302.97},{"date":"2025-01-26","value":313.77},{"date":"2025-01-27","value":324.58},{"date":"2025-01-28","value":335.39},{"date":"2025-01-29","value":346.2},{"date":"2025-01-30","value":357.01}],"onDeadline":{"date":"2025-01-30","value":357.01},"onPlannedEndDate":{"date":"2025-01-29","value":346.2},"onTargetValue":{"date":"2025-01-16","value":205.69}}},"CardPredecessorGraphExample":{"data":[{"successor_id":100,"predecessor_id":101,"depth":1},{"successor_id":100,"predecessor_id":102,"depth":1},{"successor_id":102,"predecessor_id":103,"depth":2}]},"CardSuccessorGraphExample":{"data":[{"predecessor_id":100,"successor_id":101,"depth":1},{"predecessor_id":100,"successor_id":102,"depth":1},{"predecessor_id":102,"successor_id":103,"depth":2}]},"CardRevisionsExample":{"data":[{"revision":1,"user_id":2,"replaced_at":"2025-07-01T12:00:00+00:00"},{"revision":2,"user_id":2,"replaced_at":"2025-07-02T12:00:00+00:00"}]},"CardRevisionExample":{"data":{"card_id":101,"custom_id":"string","board_id":10,"workflow_id":11,"title":"string","owner_user_id":2,"type_id":1,"color":"#FF5733","section":2,"column_id":111,"lane_id":222,"position":0,"description":"string","size":5.5,"priority":2,"deadline":"2025-12-31T23:59:59+00:00","reporter":{"type":"internal","value":2},"created_at":"2025-01-01T12:00:00+00:00","revision":3,"in_current_position_since":"2025-01-15T08:00:00+00:00","is_blocked":0,"block_reason":{"block_type":1,"reason_id":5,"comment":"string"},"child_card_stats":{"child_card_size_sum":10,"finished_bottom_child_card_size_sum":5,"unfinished_bottom_child_card_size_sum":5,"has_unfinished_child_cards":true,"last_unfinished_child_card_deadline":"2025-02-01T12:00:00+00:00"},"finished_subtask_count":0,"unfinished_subtask_count":1,"attachments":[{"id":101,"file_name":"attachment1.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":102,"file_name":"attachment2.pdf","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}],"custom_fields":[{"field_id":101,"value":"string","display_value":"string*"},{"field_id":102,"value":"string
string"}],"stickers":[{"id":1,"sticker_id":1},{"id":2,"sticker_id":2}],"tag_ids":[101,102],"co_owner_ids":[201,202],"watcher_ids":[301,302],"annotations":[],"initiative_details":{"track":0,"planned_start_date_sync_type":1,"planned_start_date_sync_monday_is_working_day":1,"planned_start_date_sync_tuesday_is_working_day":1,"planned_start_date_sync_wednesday_is_working_day":1,"planned_start_date_sync_thursday_is_working_day":1,"planned_start_date_sync_friday_is_working_day":1,"planned_start_date_sync_saturday_is_working_day":1,"planned_start_date_sync_sunday_is_working_day":1,"planned_start_date":"2025-01-01","planned_end_date_sync_type":2,"planned_end_date":"2025-01-31","actual_start_time":"2025-01-01T08:00:00+00:00","actual_end_time":"2025-01-31T18:00:00+00:00"},"outcomes":[{"outcome_id":401,"field_id":null,"rule_id":null,"name":"Outcome 1","operator":"or_more","starting_value":10,"target_value":20,"current_value":15,"comment":"Initial outcome","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"starting_value_predefined_formula_type":null,"target_value_predefined_formula_type":null,"current_value_predefined_formula_type":null,"weight":1,"created_at":"2025-01-01T12:00:00+00:00","checkpoints":[],"links_to_cards":[],"links_to_outcomes":[],"links_from_outcomes":[]}],"links_from_outcomes":[],"subtasks":[{"subtask_id":501,"description":"string","owner_user_id":2,"finished_at":null,"deadline":null,"position":0,"attachments":[]}],"linked_cards":[{"card_id":601,"type":"child","position":0},{"card_id":602,"type":"relative","position":1}],"user_id":2,"replaced_at":"2025-01-20T10:00:00+00:00"}},"CardStickersExample":{"data":[{"id":29,"sticker_id":3},{"id":30,"sticker_id":2},{"id":31,"sticker_id":2},{"id":32,"sticker_id":1}]},"CardStickerExample":{"data":{"id":33,"sticker_id":4}},"CardSubtasksExample":{"data":[{"subtask_id":1,"description":"Subtask 1","owner_user_id":2,"finished_at":"2025-07-19T12:00:00Z","deadline":"2025-07-20T12:00:00Z","attachments":[{"id":201,"file_name":"subtask_attachment.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"position":0}]},"CardSubtaskExample":{"data":{"subtask_id":2,"description":"Subtask 2","owner_user_id":2,"finished_at":null,"deadline":"2025-07-23T12:00:00Z","created_at":"2025-06-15T08:00:00Z","attachments":[{"id":202,"file_name":"subtask_attachment.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}],"position":1}},"CardSubtaskAttachmentsExample":{"data":[{"id":174,"file_name":"s1.png","link":"\/files\/53xBzCb6m5kRW1UWFYIT","position":0},{"id":176,"file_name":"s1.txt","link":"\/files\/5mHFN4hCIclw8ibjhfDl","position":1}]},"CardSubtaskAttachmentExample":{"data":{"id":174,"file_name":"s1.png","link":"\/files\/53xBzCb6m5kRW1UWFYIT","position":0}},"CardTagsExample":{"data":[{"tag_id":101},{"tag_id":102},{"tag_id":103}]},"CardTemplateCardCustomFieldContributorsExample":{"data":[{"user_id":4},{"user_id":5}]},"CardTemplateCustomFieldsExample":{"data":[{"field_id":101,"value":"string","display_value":"string*"},{"field_id":102,"value":"string
string"},{"field_id":103,"value":123.45,"display_value":"123.45$"},{"field_id":104,"value":"2025-07-16"},{"field_id":105,"value":"https:\/\/example.com"},{"field_id":106,"values":["Option 1","Option 2"]},{"field_id":107,"contributors":[{"user_id":4},{"user_id":5}]},{"field_id":108,"files":[{"id":2001,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":2002,"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}]},{"field_id":109},{"field_id":110},{"field_id":111},{"field_id":112}]},"CardTemplatesResponseExample":{"data":[{"template_id":1,"name":"Template Name","description":"lorem ipsum dolor sit amet","primary_template_card_id":1,"availability":2,"is_enabled":1},{"template_id":2,"name":"Template for 837722","description":"This is a template that applies only to a single board.","primary_template_card_id":4,"availability":1,"is_enabled":1},{"template_id":3,"name":"Template for 976644","description":"Template for 976644","primary_template_card_id":5,"availability":0,"is_enabled":1}]},"CardTemplateCardCustomFieldFilesExample":{"data":[{"id":2001,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0},{"id":2002,"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}]},"CardTemplateCardCustomFieldFileExample":{"data":{"id":2003,"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}},"CardTemplateCardCustomFieldFileUpdateExample":{"data":{"file_name":"document.txt","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":1}},"CardTemplateCardCustomFieldSelectedValueExample":{"data":{"value_id":2001,"position":0}},"CardTemplateCardSubtasksExample":{"data":[{"template_subtask_id":1,"description":"Subtask 1","owner_user_id":2,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments":[{"id":4,"file_name":"subtask_attachment.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"position":0}]},"CardTemplateCardSubtaskExample":{"data":{"template_subtask_id":2,"description":"Subtask 1","owner_user_id":2,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments":[{"id":5,"file_name":"picture.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"position":0}},"CardTemplateCardTagsExample":{"data":[{"tag_id":101},{"tag_id":102}]},"CardTemplateCardWatchersExample":{"data":[{"user_id":2},{"user_id":3}]},"CardTemplateCardsExample":{"data":[{"template_card_id":1001,"title":"Template Card","description":"This is a template card.","custom_id":"Template01","owner_user_id":2,"type_id":1,"size":1,"priority":3,"color":"34a97b","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"attachments":[{"id":1,"file_name":"template_attachment.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}],"subtasks":[{"template_subtask_id":1,"description":"Subtask 1","owner_user_id":2,"deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments":[{"id":2,"file_name":"subtask_attachment.jpg","link":"\/files\/a1b2c3d4e5f6g7h8i9j0","position":0}]}],"custom_fields":[{"value":"Text","field_id":10}],"stickers":[{"id":1,"sticker_id":1}],"tag_ids":[101],"milestones_ids":[1],"co_owner_ids":[3],"watcher_ids":[4],"annotations":[{"thread_id":"abc123xyz","comment_id":240,"author_id":3,"content":"annotation text","created_at":"2025-07-20 11:00:00"}],"linked_cards":[{"card_id":1002,"type":"child","position":0}]},{"template_card_id":1002,"title":"Template Card 2","description":"This is a template card.","custom_id":"Template02","owner_user_id":2,"type_id":1,"size":1,"priority":3,"color":"34a97b","deadline":4,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"board_id":328,"workflow_id":730,"section":1,"column_id":4224,"lane_id":1223,"position":0,"attachments":[],"subtasks":[],"custom_fields":[],"stickers":[],"tag_ids":[],"milestones_ids":[],"co_owner_ids":[],"watcher_ids":[],"annotations":[],"linked_cards":[{"card_id":1001,"type":"parent","position":0}]}]},"CardTemplateExample":{"data":{"template_id":1,"name":"Template Name","description":"lorem ipsum dolor sit amet","primary_template_card_id":1,"availability":2,"is_enabled":1,"template_cards":[{"template_card_id":1,"title":"Template Title","description":"","custom_id":null,"owner_user_id":2,"type_id":null,"size":1,"priority":3,"color":"34a97b","deadline":1,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":0,"deadline_sunday_is_working_day":0,"watchers_are_visible":0,"card_custom_id_is_visible":0,"milestones_are_visible":0,"attachments":[],"subtasks":[{"template_subtask_id":2,"description":"Subtask 1","owner_user_id":null,"deadline":null,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments":[],"position":0},{"template_subtask_id":3,"description":"Subtask 2","owner_user_id":null,"deadline":null,"deadline_monday_is_working_day":1,"deadline_tuesday_is_working_day":1,"deadline_wednesday_is_working_day":1,"deadline_thursday_is_working_day":1,"deadline_friday_is_working_day":1,"deadline_saturday_is_working_day":1,"deadline_sunday_is_working_day":1,"attachments":[],"position":1}],"custom_fields":[{"files":[{"id":12,"file_name":"Small.png","link":"\/files\/M3vaJJj3Ym82RaeFRMnm","position":0},{"id":13,"file_name":"Large.jpg","link":"\/files\/pCF2mE7OGDf7GUShVpbs","position":1}],"field_id":93}],"stickers":[],"tag_ids":[],"milestone_ids":[],"co_owner_ids":[],"watcher_ids":[],"annotations":[],"linked_cards":[]}],"revision":8,"last_modified":"2025-06-03 08:59:59"}},"CardTemplatesHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":10,"template_id":101,"event_type":"created","user_id":2,"details":{"name":"Template Name","description":"","availability":0,"is_enabled":1},"time":"2025-07-01T12:00:00+00:00"},{"history_id":11,"template_id":101,"event_type":"added_to_board","user_id":2,"details":{"board_id":1},"time":"2025-07-02T12:00:00+00:00"},{"history_id":12,"template_id":101,"event_type":"structure_updated","user_id":2,"details":null,"time":"2025-07-03T12:00:00+00:00"}]},"CardTypeBoardsResponseExample":{"data":[{"board_id":1,"icon_type":0,"icon_id":1055,"color":"794da6","card_color_sync":1},{"board_id":2,"icon_type":0,"icon_id":1056,"color":"34a97b","card_color_sync":0}]},"CardTypesExample":{"data":[{"type_id":1,"icon_type":0,"icon_id":1006,"name":"Type 01","description":"Lorem ipsum dolor sit amet.","color":"eceff1","card_color_sync":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1},{"type_id":2,"icon_type":0,"icon_id":1013,"name":"Type 02","description":"","color":"eceff1","card_color_sync":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1}]},"CardTypeExample":{"data":{"type_id":1,"icon_type":0,"icon_id":1006,"name":"Type 01","description":"Lorem ipsum dolor sit amet.","color":"eceff1","card_color_sync":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1}},"CardTypesHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":21,"type_id":101,"event_type":"added_to_board","user_id":2,"details":{"type_id":101,"board_id":3,"icon_type":0,"icon_id":1055,"color":"794da6","card_color_sync":0},"time":"2025-07-01T12:05:00+00:00"},{"history_id":20,"type_id":101,"event_type":"created","user_id":2,"details":{"icon_id":1055,"name":"New Card Type","color":"794da6","availability":1,"card_color_sync":1,"all_properties_are_locked":0,"icon_type":0,"is_enabled":1,"description":"This is a new card type."},"time":"2025-07-02T12:00:00+00:00"}]},"TokenCardsExample":{"data":[{"card_id":6854},{"card_id":11866}]},"CardWatchersExample":{"data":[{"user_id":2},{"user_id":3}]},"CellLimitsExample":{"data":[{"lane_id":1085,"column_id":4423,"limit":1},{"lane_id":1085,"column_id":4424,"limit":2},{"lane_id":1085,"column_id":4425,"limit":3},{"lane_id":1085,"column_id":4426,"limit":4},{"lane_id":1085,"column_id":4427,"limit":5}]},"CellLimitExample":{"data":{"lane_id":1085,"column_id":4423,"limit":1}},"ColumnsGetResponseExample":{"data":[{"column_id":1000,"workflow_id":100,"section":1,"parent_column_id":null,"position":0,"name":"Backlog","description":"string","color":"34a97b","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"card_progress":null,"card_progress_size_type":0},{"column_id":1001,"workflow_id":100,"section":2,"parent_column_id":null,"position":1,"name":"Requested","description":"string","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]","card_progress":null,"card_progress_size_type":0},{"column_id":1002,"workflow_id":100,"section":null,"parent_column_id":1001,"position":1,"name":"Requested Subcolumn","description":"string","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"card_progress":50,"card_progress_size_type":0}]},"ColumnGetResponseExample":{"data":{"column_id":1000,"workflow_id":100,"section":1,"parent_column_id":null,"position":0,"name":"Backlog","description":"string","color":"34a97b","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"card_progress":null,"card_progress_size_type":0}},"ColumnCreateResponseExample":{"data":{"name":"string","section":1,"workflow_id":1001,"position":0,"description":"string","color":"","limit":0,"cards_per_row":1,"flow_type":1,"parent_column_id":null,"column_id":1003,"card_progress":50,"card_progress_size_type":0}},"ColumnUpdateResponseExample":{"data":{"workflow_id":1001,"section":1,"parent_column_id":null,"name":"string","description":"string","color":"34a97b","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"block_reason\"}]","position":1,"card_progress":50,"card_progress_size_type":0}},"CardChildGraphExample":{"data":[{"parent_id":12148,"child_id":12149,"depth":1},{"parent_id":12149,"child_id":12150,"depth":2},{"parent_id":12150,"child_id":12151,"depth":3}]},"CardsExample":{"data":{"pagination":{"all_pages":310,"current_page":1,"results_per_page":200},"data":[{"card_id":10,"custom_id":"CardZ","board_id":12,"workflow_id":36,"title":"Card Title","owner_user_id":2,"type_id":1,"color":"34a97b","section":2,"column_id":63,"lane_id":48,"position":2}]}},"CompanySettingsExample":{"data":[{"name":"features.administration.do_not_send_email_confirmation","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.allow_global_card_details","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"features.api.which_user_ids_can_access","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"features.api.who_can_access","type":"string","restrictions":{"allowed_values":["none","everyone","owners","specific_users"]},"multiple_values":false,"default_value":"everyone","value":"everyone"},{"name":"features.bai.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.bai_canvas_generations.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.bai_editor_assistance.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.bai_general_assistance.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.bai_mcp.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.blockers.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.board_access_requests.are_allowed","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.board_access_requests.notifications.role_ids","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"features.board_access_requests.notifications.send_to","type":"string","restrictions":{"allowed_values":["workspace_managers","owners","specific_users","specific_user_roles","points_of_contact"]},"multiple_values":false,"default_value":"workspace_managers","value":"workspace_managers"},{"name":"features.board_access_requests.notifications.user_ids","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"features.card_attachments.disabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.card_attachments.max_size","type":"int","restrictions":{"min":1,"max":30},"multiple_values":false,"default_value":30,"value":30},{"name":"features.card_templates.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.card_types.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.custom_fields.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.discard_reasons.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners_and_managers"},{"name":"features.global_card_details","type":"string","restrictions":{"allowed_values":["custom_id","title","owner","type"]},"multiple_values":true,"default_value":["custom_id","title","owner","type"],"value":["custom_id","title","owner","type"]},{"name":"features.inline_images.disabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.inline_images.max_size","type":"int","restrictions":{"min":1,"max":7},"multiple_values":false,"default_value":7,"value":7},{"name":"features.logout_on_close","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.milestones.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.only_owners_authors_and_shared_with_can_edit_business_rules","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.only_owners_authors_and_shared_with_can_edit_cov_rules","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.only_owners_can_create_workspaces_and_boards","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.only_owners_can_delete_workspaces_and_boards","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"features.owner_promotion_notifications.send_to","type":"string","restrictions":{"allowed_values":["none","owners","specific_users"]},"multiple_values":false,"default_value":"none","value":"none"},{"name":"features.owner_promotion_notifications.user_ids","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"features.password_policy.enforce_tfa","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.password_policy.minimum_length","type":"int","restrictions":{"min":4,"max":24},"multiple_values":false,"default_value":6,"value":6},{"name":"features.password_policy.must_contain_digits","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.password_policy.must_contain_lowercase_letters","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.password_policy.must_contain_special_chars","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.password_policy.must_contain_uppercase_letters","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.password_policy.replace_after_days","type":"int","restrictions":{"min":0,"max":365},"multiple_values":false,"default_value":0,"value":0},{"name":"features.public_filters.disabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.public_filters.security","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.public_filters_and_reports.enforce_password","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.public_links_max_expiration.is_enabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"features.public_links_max_expiration.max_days","type":"int","restrictions":{"min":1,"max":365},"multiple_values":false,"default_value":365,"value":365},{"name":"features.public_reports.disabled","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"features.saved_searches.action","type":"string","restrictions":{"allowed_values":["remove_public_links_for_all_and_transfer_shared_ones","remove_public_links_for_not_shared_and_transfer_shared_ones","delete_all","delete_only_not_shared_and_transfer_shared_ones"]},"multiple_values":false,"default_value":"remove_public_links_for_all_and_transfer_shared_ones","value":"remove_public_links_for_all_and_transfer_shared_ones"},{"name":"features.saved_searches.trigger_action_on_disabled_or_deleted_user","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"features.search_power_bi_query.which_user_ids_can_manage","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"features.search_power_bi_query.who_can_manage","type":"string","restrictions":{"allowed_values":["none","all","owners","specific_users"]},"multiple_values":false,"default_value":"all","value":"none"},{"name":"features.stickers.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"features.tags.who_can_manage","type":"string","restrictions":{"allowed_values":["owners","owners_and_managers","everyone"]},"multiple_values":false,"default_value":"owners_and_managers","value":"owners"},{"name":"worklog.allowed_period.limit_type","type":"string","restrictions":{"allowed_values":["none","by_week","by_month","by_year","number_of_days"]},"multiple_values":false,"default_value":"none","value":"none"},{"name":"worklog.allowed_period.not_in_the_future","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"worklog.allowed_period.number_of_days.days","type":"int","restrictions":{"min":1,"max":365},"multiple_values":false,"default_value":7,"value":3},{"name":"worklog.allowed_period.predefined.extra_days","type":"int","restrictions":{"min":1,"max":100},"multiple_values":false,"default_value":1,"value":1},{"name":"worklog.allowed_period.predefined.option","type":"string","restrictions":{"allowed_values":["this","this_and_last_extended"]},"multiple_values":false,"default_value":"this","value":"this"},{"name":"worklog.allowed_period.timezone","type":"string","restrictions":{},"multiple_values":false,"default_value":"UTC","value":"\"><\/div>timezone1112<\/img>

"},{"name":"worklog.allowed_sections","type":"string","restrictions":{"allowed_values":["backlog","requested","progress","done","archive"]},"multiple_values":true,"default_value":null,"value":null},{"name":"worklog.category_is_required","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"worklog.max_time","type":"int","restrictions":{"min":1,"max":3600000},"multiple_values":false,"default_value":604800,"value":3600000},{"name":"worklog.owners_and_managers_cannot_log_time_for_and_edit_time_logged_by_others","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"worklog.parent_card_is_required","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0}]},"CompanySettingExample":{"data":{"name":"features.administration.do_not_send_email_confirmation","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1}},"CustomFieldAllowedValuesExample":{"data":[{"value_id":100,"position":0,"is_enabled":1,"is_default":0,"value":"Value 1"},{"value_id":101,"position":1,"is_enabled":1,"is_default":0,"value":"Value 2"}]},"CustomFieldAllowedValueCreateResponseExample":{"data":{"position":0,"is_enabled":1,"is_default":1,"value":"string","value_id":102}},"CustomFieldAllowedValueExample":{"data":{"position":0,"is_enabled":1,"is_default":0,"value":"string"}},"CustomFieldAllowedValueBatchOperationsResponseExample":{"data":[{"value_id":103,"value":"string","is_enabled":0,"is_default":0,"position":0},{"value_id":101,"value":"string","is_enabled":1,"is_default":1,"position":1}]},"CardCreateResponseExample":{"data":[{"card_id":1001,"custom_id":"Card01","board_id":328,"workflow_id":730,"title":"New Card","owner_user_id":2,"type_id":1,"color":"34a97b","section":1,"column_id":4224,"lane_id":1223,"position":0,"description":"This is a new card.","deadline":"2025-08-20T12:00:00Z","reporter":{"type":"internal","user_id":2},"created_at":"2025-07-20T10:00:00Z","revision":1,"last_modified":"2025-07-20T10:00:00Z","in_current_position_since":"2025-07-20T10:00:00Z","first_request_time":"2025-07-20T10:00:00Z","first_start_time":"2025-07-20T10:00:00Z","first_end_time":"2025-07-20T10:00:00Z","last_request_time":"2025-07-20T10:00:00Z","last_start_time":"2025-07-20T10:00:00Z","last_end_time":"2025-07-20T10:00:00Z","is_blocked":0,"block_reason":null,"child_card_stats":{"child_card_size_sum":0,"finished_bottom_child_card_size_sum":0,"unfinished_bottom_child_card_size_sum":0,"has_unfinished_child_cards":false,"last_unfinished_child_card_deadline":null},"finished_subtask_count":0,"unfinished_subtask_count":0,"custom_fields":[],"stickers":[],"tag_ids":[],"milestone_ids":[],"co_owner_ids":[],"watcher_ids":[],"checked_column_checklist_items":[],"annotations":[],"attachemnts":[],"cover_image":null,"subtasks":[],"linked_cards":[],"reference":"RRE","initiative_details":{"track":0,"has_manually_set_start_time":0,"has_manually_set_end_time":0,"planned_start_date_sync_type":null,"planned_start_date_sync_monday_is_working_day":1,"planned_start_date_sync_tuesday_is_working_day":1,"planned_start_date_sync_wednesday_is_working_day":1,"planned_start_date_sync_thursday_is_working_day":1,"planned_start_date_sync_friday_is_working_day":1,"planned_start_date_sync_saturday_is_working_day":1,"planned_start_date_sync_sunday_is_working_day":1,"planned_start_date":null,"planned_end_date_sync_type":null,"planned_end_date":null,"actual_start_time":null,"actual_end_time":null}}]},"CustomFieldBoardsExample":{"data":[{"board_id":344,"position":7,"color":"eceff1","is_always_present":1,"display_width":1,"min_number_of_values":2,"max_number_of_values":2,"inherit_default_values":1,"allow_other_value":0},{"board_id":347,"position":7,"color":null,"is_always_present":null,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":1,"allow_other_value":null}]},"CustomFieldBoardsBatchOperationsResponseExample":{"data":[{"board_id":344,"position":0,"color":"ffffff","is_always_present":0,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":1,"allow_other_value":null},{"board_id":346,"position":1,"color":"9932cc","is_always_present":1,"display_width":null,"min_number_of_values":null,"max_number_of_values":null,"inherit_default_values":1,"allow_other_value":null}]},"CustomFieldsExample":{"data":[{"name":"singleLineTextField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"prefix":"","suffix":"","uniqueness_of_values":0,"value_is_required":0,"default_value":"","type":"single_line_text","field_id":169},{"name":"multiLineTextField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"value_is_rich_text":0,"value_is_required":0,"default_value":"","type":"multi_line_text","field_id":170},{"name":"numberField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"prefix":"","suffix":"","uniqueness_of_values":0,"min_value":null,"max_value":null,"decimal_places":0,"value_is_required":0,"default_value":null,"type":"number","field_id":171},{"name":"dateField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"value_with_time":0,"value_is_required":0,"default_value":null,"type":"date","field_id":172},{"name":"linkField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"value_is_required":0,"default_value":"","type":"link","field_id":173},{"name":"dropdownField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"min_number_of_values":0,"max_number_of_values":1,"allow_other_value":0,"allowed_values_are_locked":0,"type":"dropdown","field_id":174},{"name":"contributorField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"min_number_of_contributors":0,"max_number_of_contributors":1,"type":"contributor","field_id":175},{"name":"fileField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"min_number_of_files":0,"max_number_of_files":1,"type":"file","field_id":176},{"name":"voteField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"comment_is_required":0,"type":"vote","field_id":177},{"name":"cardPickerField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"min_number_of_selected_cards":0,"max_number_of_selected_cards":1,"search":"[{\"command\":\"where\",\"field\":\"boardparent\",\"operator\":\"=\",\"value\":348,\"required\":false,\"constraints\":{\"boards\":[]}}]","type":"card_picker","field_id":178},{"name":"calculatedNumberField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"prefix":"","suffix":"","decimal_places":0,"formula":"sum(1,2)","type":"calculated_number","field_id":179},{"name":"calculatedDateField","description":"","color":"eceff1","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"availability":0,"is_enabled":1,"category_id":null,"display_width":1,"value_with_time":0,"formula":"add_days(card.deadline(),1)","type":"calculated_date","field_id":180}]},"CustomFieldHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":3,"field_id":101,"event_type":"field_updated","user_id":2,"details":{"previous_state":[{"field_id":101,"name":"string","description":"string","color":"eceff1","type":"single_line_text","is_immutable":0,"is_always_present":0,"all_properties_are_locked":0,"allowed_values_are_locked":null,"availability":0,"is_enabled":1,"category_id":null,"prefix":"","suffix":"","decimal_places":null,"display_width":1,"uniqueness_of_values":0,"min_number_of_values":null,"max_number_of_values":null,"min_value":null,"max_value":null,"value_with_time":null,"value_is_rich_text":null,"value_is_required":0,"formula":null,"search":null,"default_value":"","allow_other_value":null,"comment_is_required":null}],"changes":[{"description":"string"}]},"time":"2025-07-02T12:00:00+00:00"},{"history_id":2,"field_id":101,"event_type":"field_added_to_board","user_id":2,"details":{"board_id":1,"position":0,"color":null,"is_always_present":null,"prefix":null,"suffix":null,"decimal_places":null,"display_width":null,"unique_values":null,"min_number_of_values":null,"max_number_of_values":null,"min_value":null,"max_value":null,"value_is_required":null,"formula":null,"search":null,"default_value":null,"inherit_default_values":1,"allow_other_value":null,"comment_is_required":null},"time":"2025-07-01T12:00:00+00:00"},{"history_id":1,"field_id":1,"event_type":"field_created","user_id":2,"details":{"category_id":null,"name":"string","description":"string","color":"eceff1","type":"single_line_text","is_always_present":0,"is_immutable":0,"availability":0,"is_enabled":1,"all_properties_are_locked":0,"prefix":"","suffix":"","decimal_places":null,"display_width":1,"uniqueness_of_values":0,"min_number_of_values":null,"max_number_of_values":null,"min_value":null,"max_value":null,"value_with_time":null,"value_is_rich_text":null,"value_is_required":null,"formula":null,"search":null,"default_value":null,"allow_other_value":0,"comment_is_required":null,"field_id":101},"time":"2025-07-01T12:00:00+00:00"}]},"DataFieldsExample":{"data":[{"name":"Single Line Text Field","description":"Text data field","color":"eceff1","availability":0,"is_enabled":1,"type":"single_line_text","data_field_id":169},{"name":"Calculated Number Field","description":"Calculated number data field","color":"eceff1","availability":0,"is_enabled":1,"formula":"sum","type":"calculated_number","field_id":170}]},"CardExample":{"data":{"card_id":1001,"custom_id":"Card01","board_id":328,"workflow_id":730,"title":"New Card","owner_user_id":2,"type_id":1,"color":"34a97b","section":1,"column_id":4224,"lane_id":1223,"position":0,"description":"This is a new card.","deadline":"2025-08-20T12:00:00Z","reporter":{"type":"internal","user_id":2},"created_at":"2025-07-20T10:00:00Z","revision":1,"last_modified":"2025-07-20T10:00:00Z","in_current_position_since":"2025-07-20T10:00:00Z","first_request_time":"2025-07-20T10:00:00Z","first_start_time":"2025-07-20T10:00:00Z","first_end_time":"2025-07-20T10:00:00Z","last_request_time":"2025-07-20T10:00:00Z","last_start_time":"2025-07-20T10:00:00Z","last_end_time":"2025-07-20T10:00:00Z","is_blocked":0,"block_reason":null,"child_card_stats":{"child_card_size_sum":0,"finished_bottom_child_card_size_sum":0,"unfinished_bottom_child_card_size_sum":0,"has_unfinished_child_cards":false,"last_unfinished_child_card_deadline":null},"finished_subtask_count":0,"unfinished_subtask_count":0,"custom_fields":[],"stickers":[],"tag_ids":[],"milestone_ids":[],"co_owner_ids":[],"watcher_ids":[],"checked_column_checklist_items":[],"annotations":[],"attachemnts":[],"cover_image":null,"subtasks":[],"linked_cards":[],"reference":"RRE","initiative_details":{"track":0,"has_manually_set_start_time":0,"has_manually_set_end_time":0,"planned_start_date_sync_type":null,"planned_start_date_sync_monday_is_working_day":1,"planned_start_date_sync_tuesday_is_working_day":1,"planned_start_date_sync_wednesday_is_working_day":1,"planned_start_date_sync_thursday_is_working_day":1,"planned_start_date_sync_friday_is_working_day":1,"planned_start_date_sync_saturday_is_working_day":1,"planned_start_date_sync_sunday_is_working_day":1,"planned_start_date":null,"planned_end_date_sync_type":null,"planned_end_date":null,"actual_start_time":null,"actual_end_time":null}}},"CustomFieldExample":{"data":{"category_id":null,"name":"singleLineTextField1","description":"","color":"eceff1","is_always_present":0,"is_immutable":0,"availability":0,"is_enabled":1,"all_properties_are_locked":0,"prefix":"","suffix":"","display_width":1,"uniqueness_of_values":0,"value_is_required":0,"default_value":"","field_id":182,"type":"single_line_text"}},"DataFieldExample":{"data":{"name":"First Data Field","description":"Text data field","color":"eceff1","availability":0,"is_enabled":1,"data_field_id":1,"type":"single_line_text"}},"CloneDashboardPageResponseExample":{"data":{"name":"Cloned Dashboard","dashboard_page_id":1000,"dashboard_page_users":[{"dashboard_page_id":1000,"user_id":2,"can_edit":1}],"dashboard_page_teams":[{"dashboard_page_id":1000,"team_id":1,"can_edit":1}],"dashboard_page_workspaces":[{"dashboard_page_id":1000,"workspace_id":1,"position":0}],"dashboard_page_widgets":[{"widget_id":2000,"dashboard_page_id":1000,"name":"Widget","type":11,"configuration":"string","position":0}]}},"EmailIntegrationErrorsExample":{"pagination":{"all_pages":10,"current_page":1,"results_per_page":100},"data":[{"sender":"sender@mail.example","receivers":["recepient1@mail.example","recepient2@mail.example"],"received_at":"2025-07-20T10:00:00Z","subject":"Test Email","error_message":"An error occurred while processing your request: (A100) You do not have the permissions required to perform this action."}]},"DashboardPageUsersExample":{"data":[{"dashboard_page_id":30,"user_id":2,"can_edit":1},{"dashboard_page_id":30,"user_id":9,"can_edit":0}]},"DashboardPageUserExample":{"data":{"dashboard_page_id":30,"user_id":2,"can_edit":1}},"GlobalUserPrivileges":{"data":[{"name":"owner","available":1},{"name":"create_team_workspaces","available":1},{"name":"make_payments","available":1},{"name":"manage_business_rules","available":1},{"name":"manage_integrations","available":1},{"name":"invite_users","available":1},{"name":"manage_teams","available":1},{"name":"manage_user_wip_limits","available":1},{"name":"manage_roles","available":1},{"name":"manage_card_elements","available":1},{"name":"manage_security_settings","available":1},{"name":"manage_dashboards","available":1},{"name":"manage_logged_time","available":1},{"name":"manage_worklog_configurations","available":1},{"name":"access_audit_logs","available":1},{"name":"enable_and_disable_users","available":1},{"name":"delete_users","available":1},{"name":"manage_outcome_rules","available":1},{"name":"manage_data_fields","available":0}]},"InternalAnnouncementsExample":{"data":[{"announcement_id":1,"title":"Announcement Title","description":"This is the content of the announcement.","cover_image_link":"https:\/\/images.unsplash.com","for_everyone":1,"for_owners":0,"for_workspace_managers":0,"is_popover":1,"start_time":"2025-08-20T07:10:00+00:00","end_time":"2025-08-30T07:10:00+00:00","is_active":1,"for_role_ids":[],"for_team_ids":[],"recurring_definition":null,"available":0}]},"InternalAnnouncementCreateExample":{"data":{"title":"Announcement Title","start_time":"2025-08-08T08:03:00+00:00","for_everyone":1,"cover_image_link":"https:\/\/images.unsplash.com","description":"This is the content of the announcement.","for_owners":0,"for_workspace_managers":0,"is_popover":1,"announcement_id":2,"recurring_definition":null,"for_role_ids":[],"for_team_ids":[]}},"InternalAnnouncementExample":{"data":{"announcement_id":3,"title":"Announcement Title","description":"This is the content of the announcement.","cover_image_link":"https:\/\/images.unsplash.com","for_everyone":1,"for_owners":0,"for_workspace_managers":0,"is_popover":1,"start_time":"2025-08-08T08:03:00+00:00","end_time":"2025-08-10T08:03:00+00:00","is_active":1,"for_role_ids":[],"for_team_ids":[],"recurring_definition":null}},"InternalAnnouncementsHistory":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":8,"announcement_id":2,"event_type":"deleted","user_id":2,"details":{"announcement_id":2,"title":"title - updated","description":"

description<\/p>","cover_image_link":null,"for_everyone":1,"for_owners":0,"for_workspace_managers":0,"is_popover":1,"start_time":"2025-08-08T08:03:00+00:00","end_time":null,"is_active":1,"recurring_definition":null},"time":"2025-08-08T08:03:39+00:00"},{"history_id":7,"announcement_id":2,"event_type":"updated","user_id":2,"details":{"previous_state":{"announcement_id":2,"title":"title","description":"

description<\/p>","cover_image_link":null,"for_everyone":1,"for_owners":0,"for_workspace_managers":0,"is_popover":1,"start_time":"2025-08-08T08:03:00+00:00","end_time":null,"is_active":1,"recurring_definition":null},"changes":{"title":"title - updated"}},"time":"2025-08-08T08:03:34+00:00"},{"history_id":6,"announcement_id":2,"event_type":"created","user_id":2,"details":{"title":"title","description":"

description<\/p>","start_time":"2025-08-08T08:03:00+00:00","end_time":null,"cover_image_link":null,"is_popover":1,"for_everyone":1,"for_owners":0,"for_workspace_managers":0,"recurring_definition":null},"time":"2025-08-08T08:03:26+00:00"}]},"IntegrationSettingsExample":{"data":[{"name":"integration_settings.oidc.allow_kanbanize_login","type":"string","restrictions":{"allowed_values":["none","owners","integration_managers","all"]},"multiple_values":false,"default_value":"non","value":"none"},{"name":"integration_settings.oidc.client_id","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.oidc.client_secret","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.oidc.create_user_on_login","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"integration_settings.oidc.issuer_url","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.oidc.redirect_logout_url","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.oidc.redirect_url","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.allow_kanbanize_login","type":"string","restrictions":{"allowed_values":["none","owners","integration_managers","all"]},"multiple_values":false,"default_value":"none","value":"none"},{"name":"integration_settings.saml.create_user_on_login","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"integration_settings.saml.idp_attribute_name_for_email","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_attribute_name_for_first_name","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_attribute_name_for_last_name","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_entity_id","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_login_url","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_logout_url","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.idp_x509_certificate","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.scim","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integration_settings.saml.scim.authToken","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":""},{"name":"integration_settings.saml.sign_outgoing_messages","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.bitbucket","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.box","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.dropbox","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.git_hub","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.git_lab","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.google_drive","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.oidc","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.saml","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.one_drive","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.svn","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.trello","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"integrations.zapier","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0}]},"IntegrationSettingExample":{"data":{"name":"integrations.bitbucket","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0}},"LanesExample":{"data":[{"lane_id":11,"workflow_id":5,"parent_lane_id":null,"position":0,"name":"Lane 1","description":"Description for Lane 1","color":"34a97b"},{"lane_id":12,"workflow_id":5,"parent_lane_id":null,"position":1,"name":"Lane 2","description":"Description for Lane 2","color":"e0e0e0"}]},"LaneExample":{"data":{"workflow_id":5,"parent_lane_id":null,"position":0,"name":"Lane 1","description":"Description for Lane 1","color":"34a97b"}},"LaneDefaultSettingsExample":{"data":[{"name":"lane_settings.default_template","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":2}]},"LaneDefaultSettingExample":{"data":{"name":"lane_settings.default_template","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":2}},"LaneSectionLimitsExample":{"data":[{"lane_id":1105,"section":3,"limit":1337},{"lane_id":1106,"section":3,"limit":2674}]},"LaneSectionLimitExample":{"data":{"lane_id":1106,"section":3,"limit":5}},"JsonExportWorkspacesExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Event Type","Workspace name","Author","Details","Time (Europe\/Sofia)"],"items":[["Added to dashboard","string","user","The workspace has been added to the dashboard \"dashboard\".","2025-01-02 12:00:00"],["Created","string","user","The workspace has been created.","2025-01-01 12:00:00"]]}},"JsonExportBoardsExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Event Type","Board name","Author","Details","Time (Europe\/Sofia)"],"items":[["Board updated","string","user","The board allow generic blocker setting has been changed from Allowed to Not allowed.","2025-01-02 12:00:00"],["Board created","string","user","The board has been created.","2025-01-01 12:00:00"]]}},"JsonExportUsersExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Event Type","Author","Author Email","Affected User","Affected User Email","Details","Time (Europe\/Sofia)"],"items":[["User confirmed","user2","user2@email.com","user2","user2@email.com","user2 has accepted user1's invitation to join the account.","2025-01-02 12:00:00"],["User invited","user1","user1@email.com","user2","user2@email.com","user2 as been invited to join the account by user1.","2025-01-01 12:00:00"]]}},"JsonExportBusinessRulesExecutionExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Business rule name","Business rule ID","Executed on card ID","Executed at (Europe\/Sofia)"],"items":[["Card is moved",11,1001,"2025-01-02 12:00:00"],["Card is created",10,1000,"2025-01-01 12:00:00"]]}},"JsonExportEmailIntegrationExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Sender","Receivers","Subject","Details","Card id","Event type","Received at (Europe\/Sofia)"],"items":[["sender@email.com","receiver@email.com","{Board name}{1001}","Processed Successfully",1001,"Card Updated","2025-01-02 12:00:00"],["sender@email.com","receiver@email.com","{Board name}","Processed Successfully",1000,"Card Created","2025-01-01 12:00:00"]]}},"JsonExportCalculatedOutcomeValueRulesExecutionExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Rule name","Rule ID","Card ID","Started at (Europe\/Sofia)","Finished at (Europe\/Sofia)","Request status","Exceeded the result limit","Processing result","Requested by user"],"items":[["rule 2",11,1001,"2025-01-02 12:00:00","2025-01-02 12:00:00","Successfully received data","no","Successfully updated the card","no"],["rule 1",10,1000,"2025-01-01 12:00:00","2025-01-01 12:00:00","Successfully received data","no","The formula produced an empty value","no"]]}},"JsonExportEmailIntegrationErrorsExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Sender","Receivers","Subject","Details","Card id","Event type","Received at (Europe\/Sofia)"],"items":[["sender@email.com","receiver@email.com","{Board name}{1001}","The count of attachments on card with id 1001 exceeds the per-card limit of 5.",1001,"Card Updated","2025-01-02 12:00:00"],["sender@email.com","receiver@email.com","{Board name}","The parameters in the request body did not pass validation.",1000,"Card Created","2025-01-01 12:00:00"]]}},"JsonExportWebhooksExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":{"titles":["Event Type","Username","Details","Received at (Europe\/Sofia)"],"items":[["Deleted","user","user has deleted a webhook URL https:\/\/example.com\/webhook on Example board.","2025-01-02 12:00:00"],["Created","user","user has created a webhook URL https:\/\/example.com\/webhook on Example board.","2025-01-01 12:00:00"]]}},"JsonOldApiExportExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Resource","Username","Time (Europe\/Sofia)"],"items":[["api\/v1\/cards\/1001","user 2","2025-01-03 12:00:00"],["api\/v1\/boards\/2002","user 1","2025-01-02 12:00:00"],["api\/v1\/cards\/1003","**Deleted User**","2025-01-01 12:00:00"]]}},"JsonExportApiRequestHistoryExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Status code","Method","Resource","Username","Time (Europe\/Sofia)"],"items":[[200,"GET","\/api\/v*\/cards\/*","john.doe","2025-08-01 09:15:00"],[404,"POST","\/api\/v*\/boards\/*","jane.smith","2025-08-01 09:16:00"],[401,"DELETE","\/api\/v*\/cards","**Deleted User**","2025-08-01 09:17:00"]]}},"JsonExportUsersLastActivityExample":{"data":{"titles":["Username","Real name","Email","Last activity (Europe\/Sofia)"],"items":[["john.doe","John Doe","john.doe@email.com","2025-08-01 09:15:00"],["jane.smith","Jane Smith","jane.smith@email.com","No activity"]]}},"JsonExportCustomFieldsExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Custom field name","Event type","Author","Details","Executed at (Europe\/Sofia)"],"items":[["**Deleted Custom Field**","Deleted","**Deleted User**","**Deleted User** deleted the custom field Urgency.","2025-08-01 09:17:00"],["Priority","Updated","jane.smith","jane.smith changed the name of the custom field Urgency to Priority.","2025-08-01 09:16:00"],["Priority","Created","john.doe","john.doe created the custom field Priority of type dropdown.","2025-08-01 09:15:00"]]}},"JsonExportStickersExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Updated for board","john.doe","john.doe has updated the sticker Urgent. The limit per board has been changed from 5 to 10.","2025-08-01 09:19:00"],["Added to board","jane.smith","jane.smith has added the sticker Urgent to Board Alpha board.","2025-08-01 09:18:00"],["Updated","jane.smith","jane.smith has updated the Urgent sticker. The color has been changed.","2025-08-01 09:16:00"],["Created","john.doe","john.doe has created a sticker Urgent with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportTagsExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the tag Critical to Board Alpha board.","2025-08-01 09:19:00"],["Updated","jane.smith","jane.smith has updated the Urgent tag. The color has been changed.","2025-08-01 09:16:00"],["Created","john.doe","john.doe has created a tag Urgent with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportMilestonesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the milestone Release to Board Alpha board.","2025-08-01 09:19:00"],["Updated","jane.smith","jane.smith has updated the Release milestone. The color has been changed.","2025-08-01 09:16:00"],["Created","john.doe","john.doe has created a milestone Release with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportTeamsExample":{"pagination":{"allPages":1,"currentPage":1,"results_per_page":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to dashboard page","jane.smith","jane.smith has added Engineering Team to Product Dashboard dashboard page","2025-08-01 09:25:00"],["Created","john.doe","john.doe has created a team Engineering Team.","2025-08-01 09:15:00"]]}},"JsonExportLoggedTimesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Updated","john.doe","john.doe has updated the logged time with comment: 'Updated work log' and logged time: 2h.","2025-08-01 09:18:00"],["Created","john.doe","john.doe has created a logged time with comment: 'Initial entry.' and logged time 30m.","2025-08-01 09:16:00"]]}},"JsonExportLoggedTimeCategoriesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the logged time category Research to Board Alpha board.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created a logged time category Research with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportBlockReasonsExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the block reason Critical to Board Alpha board.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created a block reason Urgent with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportCardTemplatesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the card template Initiative to Board Alpha board.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created a card template Initiative with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportCardTypesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has added the card type Initiative to Board Alpha board.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created a card type Initiative with availability level Global.","2025-08-01 09:15:00"]]}},"JsonExportInternalAnnouncementsExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Added to board","john.doe","john.doe has updated the Announcement internal announcement.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created an internal announcement Announcement.","2025-08-01 09:15:00"]]}},"JsonExportBAIPromptsExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Updated","jane.smith","jane.smith has updated the Welcome Message BAI prompt.","2025-08-01 09:18:00"],["Created","john.doe","john.doe has created a BAI prompt Welcome Message.","2025-08-01 09:15:00"]]}},"JsonExportRolesExample":{"pagination":{"allPages":1,"currentPage":1,"resultsPerPage":100},"data":{"titles":["Event Type","Username","Details","Time (Europe\/Sofia)"],"items":[["Permissions Changed","jane.smith","jane.smith has added Card details permissions for role Manager.","2025-08-01 09:20:00"],["Created","john.doe","john.doe has created a role Manager.","2025-08-01 09:15:00"]]}},"LoggedTimesExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"logged_time_id":1,"parent_card_id":null,"card_id":20,"subtask_id":null,"lane_id":150,"column_id":300,"user_id":2,"category_id":null,"date":"2025-07-20","time":3600,"comment":"Worked on the card for an hour.","logged_at":"2025-08-11T12:00:00+00:00"}]},"LoggedTimeExample":{"data":{"logged_time_id":1,"parent_card_id":null,"card_id":20,"subtask_id":null,"lane_id":150,"column_id":300,"user_id":2,"category_id":null,"date":"2025-07-20","time":3600,"comment":"Worked on the card for an hour.","logged_at":"2025-08-11T12:00:00+00:00"}},"LoggedTimeCategoriesExample":{"data":[{"category_id":1,"icon_type":0,"icon_id":2345,"label":"Development","description":"Time spent on development tasks.","color":"34a97b","availability":0,"is_enabled":1}]},"LoggedTimeCategoryExample":{"data":{"category_id":1,"icon_type":0,"icon_id":2345,"label":"Development","description":"Time spent on development tasks.","color":"34a97b","availability":0,"is_enabled":1}},"LoggedTimeCategoryBoardsExample":{"data":[{"board_id":90},{"board_id":94}]},"LoggedTimeCategoryHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":21,"category_id":1,"event_type":"removed_from_board","user_id":2,"details":{"board_id":92},"time":"2025-08-12T11:57:43+00:00"},{"history_id":20,"category_id":1,"event_type":"added_to_board","user_id":2,"details":{"board_id":92},"time":"2025-08-12T11:57:39+00:00"},{"history_id":19,"category_id":5,"event_type":"deleted","user_id":2,"details":{"icon_type":0,"icon_id":1002,"label":"newCategory - updated","description":"updated","color":"7333bd","availability":0,"is_enabled":1},"time":"2025-08-12T11:57:26+00:00"},{"history_id":18,"category_id":5,"event_type":"removed_from_board","user_id":2,"details":{"board_id":355},"time":"2025-08-12T11:57:26+00:00"},{"history_id":17,"category_id":5,"event_type":"enabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1002,"label":"newCategory - updated","description":"updated","color":"7333bd","availability":0,"is_enabled":0},"changes":{"is_enabled":1}},"time":"2025-08-12T11:57:17+00:00"},{"history_id":16,"category_id":5,"event_type":"disabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1002,"label":"newCategory - updated","description":"updated","color":"7333bd","availability":0,"is_enabled":1},"changes":{"is_enabled":0}},"time":"2025-08-12T11:57:14+00:00"},{"history_id":15,"category_id":5,"event_type":"updated","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1019,"label":"newCategory","description":"","color":"45b64c","availability":0,"is_enabled":1},"changes":{"color":"7333bd","icon_id":1002,"label":"newCategory - updated","description":"updated"}},"time":"2025-08-12T11:57:08+00:00"},{"history_id":14,"category_id":5,"event_type":"added_to_board","user_id":2,"details":{"board_id":355},"time":"2025-08-12T11:56:53+00:00"},{"history_id":13,"category_id":5,"event_type":"created","user_id":2,"details":{"color":"45b64c","icon_id":1019,"label":"newCategory","description":"","availability":0,"icon_type":0,"is_enabled":1},"time":"2025-08-12T11:56:52+00:00"}]},"LoggedTimeHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":38,"logged_time_id":29,"card_id":12185,"event_type":"created","user_id":2,"details":{"parent_card_id":null,"card_id":12185,"subtask_id":null,"lane_id":1113,"column_id":4559,"user_id":2,"category_id":null,"date":"2025-08-12","time":3600,"comment":"","logged_at":"2025-08-12 12:22:35"},"time":"2025-08-12T12:22:43+00:00"},{"history_id":37,"logged_time_id":29,"card_id":12182,"event_type":"updated_after_subtask_converted_to_card","user_id":2,"details":{"previous_state":{"parent_card_id":null,"card_id":12182,"subtask_id":12184,"lane_id":1113,"column_id":4559,"user_id":2,"category_id":null,"date":"2025-08-12","time":3600,"comment":"","logged_at":"2025-08-12 12:22:35"},"changes":{"card_id":12185,"subtask_id":null,"lane_id":1113,"column_id":1113}},"time":"2025-08-12T12:22:43+00:00"},{"history_id":36,"logged_time_id":29,"card_id":12182,"event_type":"created","user_id":2,"details":{"card_id":12182,"subtask_id":12184,"user_id":2,"date":"2025-08-12","time":3600,"comment":"","lane_id":1113,"column_id":4559,"parent_card_id":null,"category_id":null,"logged_at":"2025-08-12T12:22:35+00:00"},"time":"2025-08-12T12:22:35+00:00"},{"history_id":35,"logged_time_id":28,"card_id":12182,"event_type":"transferred_to_card_after_subtask_deleted","user_id":2,"details":{"previous_state":{"card_id":12182,"parent_card_id":null,"subtask_id":12183,"lane_id":1113,"column_id":4559,"user_id":2,"category_id":null,"date":"2025-08-12","time":3600,"comment":"","logged_at":"2025-08-12 12:22:12"},"changes":{"subtask_id":null}},"time":"2025-08-12T12:22:24+00:00"},{"history_id":34,"logged_time_id":28,"card_id":12182,"event_type":"created","user_id":2,"details":{"card_id":12182,"subtask_id":12183,"user_id":2,"date":"2025-08-12","time":3600,"comment":"","lane_id":1113,"column_id":4559,"parent_card_id":null,"category_id":null,"logged_at":"2025-08-12T12:22:12+00:00"},"time":"2025-08-12T12:22:12+00:00"},{"history_id":33,"logged_time_id":27,"card_id":12182,"event_type":"deleted","user_id":2,"details":{"parent_card_id":null,"card_id":12182,"subtask_id":null,"lane_id":1113,"column_id":4559,"user_id":2,"category_id":null,"date":"2025-08-12","time":7200,"comment":"comment","logged_at":"2025-08-12T12:22:01+00:00"},"time":"2025-08-12T12:22:09+00:00"},{"history_id":32,"logged_time_id":27,"card_id":12182,"event_type":"updated","user_id":2,"details":{"previous_state":{"parent_card_id":null,"card_id":12182,"subtask_id":null,"lane_id":1113,"column_id":4559,"user_id":2,"category_id":null,"date":"2025-08-12","time":3600,"comment":"","logged_at":"2025-08-12T12:22:01+00:00"},"changes":{"time":7200,"comment":"comment"}},"time":"2025-08-12T12:22:06+00:00"},{"history_id":31,"logged_time_id":27,"card_id":12182,"event_type":"created","user_id":2,"details":{"card_id":12182,"user_id":2,"date":"2025-08-12","time":3600,"comment":"","subtask_id":null,"lane_id":1113,"column_id":4559,"parent_card_id":null,"category_id":null,"logged_at":"2025-08-12T12:22:01+00:00"},"time":"2025-08-12T12:22:01+00:00"}]},"MergedAreasExample":{"data":[{"primary_column_id":22,"limit":12,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"created_at\"}]","lane_ids":[50],"column_ids":[22,28],"area_id":63}]},"MergedAreaExample":{"data":{"primary_column_id":22,"limit":12,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"created_at\"}]","lane_ids":[50],"column_ids":[22,28],"board_id":5,"area_id":63}},"MergedAreaUpdateExample":{"data":{"primary_column_id":22,"limit":12,"card_ordering":"[{\"field_type\":\"plain\",\"direction\":\"asc\",\"field_name\":\"created_at\"}]","lane_ids":[50],"column_ids":[22,28]}},"MyAppSettingsExample":{"data":[{"name":"autoload_board","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":null},{"name":"board_sidebar","type":"int","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"collapsed_widget_ids","type":"string","restrictions":{},"multiple_values":false,"default_value":"","value":""},{"name":"last_seen_news_date","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":"user"},{"name":"maestro.card_links.types","type":"string","restrictions":{"allowed_values":["none","parent_child","predecessor_successor","relative"]},"multiple_values":true,"default_value":["parent_child","predecessor_successor","relative"],"value":["parent_child","predecessor_successor","relative"]},{"name":"maestro.card_links.visibility","type":"string","restrictions":{"allowed_values":["never","always","on_selection_first_level_only","on_selection_all_levels"]},"multiple_values":false,"default_value":"always","value":"always"},{"name":"maestro.edge_scrolling","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":1,"value":1},{"name":"maestro.scroll_wheel_zoom","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"maestro.snap_to_objects","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"personal_liability_accepted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"privacy_policy_accepted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"privacy_policy_changes_warning","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"seen_walkthroughs","type":"string","restrictions":{},"multiple_values":true,"default_value":null,"value":null},{"name":"use_color_blind_safe_palette","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0},{"name":"use_dark_mode","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":0}]},"MeExample":{"data":{"user_id":2,"email":"email@email.com","username":"username","realname":"firstName lastName","avatar":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80","email_signature":null,"is_tfa_enabled":0,"is_enabled":1,"is_confirmed":1,"registration_date":"2024-07-29","timezone":"Europe\/Sofia","language":"en"}},"MilestoneBoardsExample":{"data":[{"board_id":355},{"board_id":356}]},"MyAppSettingExample":{"data":{"name":"use_dark_mode","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1}},"MilestoneCardsExample":{"data":[{"card_id":12171},{"card_id":12187}]},"MyAnnouncementsExample":{"data":{"internal":[{"announcement_id":1,"title":"Announcement Title","description":"This is the content of the announcement.","cover_image_link":"https:\/\/images.unsplash.com","is_popover":1,"start_time":"2025-08-20T07:10:00+00:00","end_time":"2025-08-30T07:10:00+00:00","is_active":1,"is_seen":1}],"system":[{"announcement_id":2,"title":"System Announcement Title","description":"This is the content of the system announcement.","cover_image_link":"https:\/\/images.unsplash.com","is_popover":1,"start_time":"2025-08-20T07:10:00+00:00","end_time":"2025-08-30T07:10:00+00:00","is_active":1,"is_seen":0}]}},"MyBoardSettingsExample":{"data":[{"name":"board_settings.board_color","type":"color","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"board_settings.board_image","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"board_settings.collapsed_items","type":"string","restrictions":{},"multiple_values":true,"default_value":null,"value":null},{"name":"board_settings.default_assignee","type":"string","restrictions":{},"multiple_values":false,"default_value":"None","value":"None"},{"name":"board_settings.default_column","type":"string","restrictions":{},"multiple_values":false,"default_value":"requested","value":"requested"},{"name":"board_settings.default_sender_user_id","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":false,"default_value":null,"value":null},{"name":"board_settings.default_swimlane","type":"string","restrictions":{},"multiple_values":false,"default_value":"None","value":null},{"name":"board_settings.default_template","type":"string","restrictions":{},"multiple_values":false,"default_value":"None","value":"None"},{"name":"board_settings.expanded_items","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"board_settings.gantt_chart_view_workflows","type":"int","restrictions":{"min":1,"max":1000000000},"multiple_values":true,"default_value":null,"value":null},{"name":"board_settings.old_export_settings","type":"string","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"notifications.common.disable_for_my_actions","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.common.enable_desktop_notifications","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.common.only_when_co_owner","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.common.only_when_contributor","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.common.only_when_owner","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.common.only_when_reporter","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.common.only_when_subtask_owner","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.common.stop_mentions_mails","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.added_as_co_owner","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_assigned_to_me","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.inbox.card_blocked_or_unblocked","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_created","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_discarded","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_moved","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_moved_to_done","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_moved_to_in_progress","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_moved_to_or_from_board","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.card_updated","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.comment_added_or_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.inbox.deadline_tomorrow","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.inbox.subtask_assigned_to_me","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.subtask_created","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.subtask_deadline_tomorrow","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.subtask_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.inbox.subtask_marked_finished_or_unfinished","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.added_as_co_owner","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_assigned_to_me","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.mail.card_blocked_or_unblocked","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_created","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_discarded","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_moved","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_moved_to_done","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_moved_to_in_progress","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_moved_to_or_from_board","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.card_updated","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.comment_added_or_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.mail.deadline_tomorrow","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.mail.subtask_assigned_to_me","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":1},{"name":"notifications.mail.subtask_created","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.subtask_deadline_tomorrow","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.subtask_deleted","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null},{"name":"notifications.mail.subtask_marked_finished_or_unfinished","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null}]},"MyBoardSettingExample":{"data":{"name":"board_settings.board_color","type":"color","restrictions":{},"multiple_values":false,"default_value":null,"value":null}},"MilestoneHistoryExample":{"pagination":{"all_pages":5,"current_page":1,"results_per_page":100},"data":[{"history_id":458,"milestone_id":13,"event_type":"removed_from_board","user_id":2,"details":{"board_id":356},"time":"2025-08-14T07:06:54+00:00"},{"history_id":457,"milestone_id":13,"event_type":"added_to_board","user_id":2,"details":{"board_id":356},"time":"2025-08-14T07:06:49+00:00"},{"history_id":456,"milestone_id":13,"event_type":"enabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1059,"label":"newMilestone - updated","description":"","color":"7333bd","availability":0,"is_enabled":0,"date":"2025-08-14"},"changes":{"is_enabled":1}},"time":"2025-08-14T07:06:42+00:00"},{"history_id":455,"milestone_id":13,"event_type":"disabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1059,"label":"newMilestone - updated","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"},"changes":{"is_enabled":0}},"time":"2025-08-14T07:06:40+00:00"},{"history_id":454,"milestone_id":13,"event_type":"updated","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1059,"label":"newMilestone","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"},"changes":{"label":"newMilestone - updated"}},"time":"2025-08-14T07:06:36+00:00"},{"history_id":453,"milestone_id":13,"event_type":"added_to_board","user_id":2,"details":{"board_id":354},"time":"2025-08-14T07:06:31+00:00"},{"history_id":452,"milestone_id":13,"event_type":"created","user_id":2,"details":{"icon_type":0,"icon_id":1059,"label":"newMilestone","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14","description":""},"time":"2025-08-14T07:06:31+00:00"}]},"MilestonesExample":{"data":[{"milestone_id":14,"icon_type":0,"icon_id":1059,"label":"milestone01","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"},{"milestone_id":15,"icon_type":0,"icon_id":1059,"label":"milestone02","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"},{"milestone_id":16,"icon_type":0,"icon_id":1059,"label":"milestone03","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"}]},"MilestoneExample":{"data":{"milestone_id":14,"icon_type":0,"icon_id":1059,"label":"milestone01","description":"","color":"7333bd","availability":0,"is_enabled":1,"date":"2025-08-14"}},"MyDashboardPageSettingsExample":{"data":[{"name":"background_settings.color","type":"color","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"background_settings.image","type":"url","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"tab_settings.color","type":"color","restrictions":{},"multiple_values":false,"default_value":null,"value":null},{"name":"tab_settings.is_hidden","type":"int","restrictions":{"allowed_values":[0,1]},"multiple_values":false,"default_value":0,"value":null}]},"MyDashboardPageSingleSettingExample":{"data":{"name":"background_settings.color","type":"color","restrictions":{},"multiple_values":false,"default_value":null,"value":null}},"OldApiLimitsExample":{"data":[{"function":"login","type":"hourly","limit":200},{"function":"login","type":"minutely","limit":20},{"function":"get_projects_and_boards","type":"hourly","limit":200},{"function":"get_projects_and_boards","type":"minutely","limit":20},{"function":"get_board_structure","type":"hourly","limit":200},{"function":"get_board_structure","type":"minutely","limit":20},{"function":"get_full_board_structure","type":"hourly","limit":200},{"function":"get_full_board_structure","type":"minutely","limit":20},{"function":"get_board_settings","type":"hourly","limit":200},{"function":"get_board_settings","type":"minutely","limit":20},{"function":"create_new_task","type":"hourly","limit":200},{"function":"create_new_task","type":"minutely","limit":20},{"function":"get_task_details","type":"hourly","limit":200},{"function":"get_task_details","type":"minutely","limit":20},{"function":"get_all_tasks","type":"hourly","limit":200},{"function":"get_all_tasks","type":"minutely","limit":20},{"function":"add_comment","type":"hourly","limit":200},{"function":"add_comment","type":"minutely","limit":20},{"function":"move_task","type":"hourly","limit":200},{"function":"move_task","type":"minutely","limit":20},{"function":"edit_task","type":"hourly","limit":200},{"function":"edit_task","type":"minutely","limit":20},{"function":"block_task","type":"hourly","limit":200},{"function":"block_task","type":"minutely","limit":20},{"function":"delete_task","type":"hourly","limit":200},{"function":"delete_task","type":"minutely","limit":20},{"function":"add_subtask","type":"hourly","limit":200},{"function":"add_subtask","type":"minutely","limit":20},{"function":"edit_subtask","type":"hourly","limit":200},{"function":"edit_subtask","type":"minutely","limit":20},{"function":"log_time","type":"hourly","limit":200},{"function":"log_time","type":"minutely","limit":20},{"function":"edit_logged_time","type":"hourly","limit":200},{"function":"edit_logged_time","type":"minutely","limit":20},{"function":"delete_logged_time","type":"hourly","limit":200},{"function":"delete_logged_time","type":"minutely","limit":20},{"function":"get_log_time_activities","type":"hourly","limit":200},{"function":"get_log_time_activities","type":"minutely","limit":20},{"function":"get_tasks_with_log_time","type":"hourly","limit":200},{"function":"get_tasks_with_log_time","type":"minutely","limit":20},{"function":"get_links","type":"hourly","limit":200},{"function":"get_links","type":"minutely","limit":20},{"function":"edit_link","type":"hourly","limit":200},{"function":"edit_link","type":"minutely","limit":20},{"function":"get_board_activities","type":"hourly","limit":200},{"function":"get_board_activities","type":"minutely","limit":20},{"function":"get_all_board_info","type":"hourly","limit":200},{"function":"get_all_board_info","type":"minutely","limit":20},{"function":"get_tasks_for_cell","type":"hourly","limit":200},{"function":"get_tasks_for_cell","type":"minutely","limit":20}]},"MyDashboardPagesExample":{"data":[{"dashboard_page_id":18,"position":0},{"dashboard_page_id":32,"position":1}]},"MyDashboardPageExample":{"data":[{"dashboard_page_id":18,"position":0}]},"MyFavoriteBoardsExample":{"data":[{"board_id":247,"position":0},{"board_id":356,"position":1}]},"MyFavoriteBoardExample":{"data":{"position":0}},"RoleHistoryExample":{"pagination":{"all_pages":5,"current_page":1,"results_per_page":100},"data":[{"history_id":476,"role_id":11,"event_type":"deleted","user_id":2,"details":"newRole1-updated","time":"2025-08-15T07:54:48+00:00"},{"history_id":475,"role_id":11,"event_type":"permissions_changed","user_id":2,"details":{"added":["cards.block"]},"time":"2025-08-15T07:54:42+00:00"},{"history_id":474,"role_id":11,"event_type":"renamed","user_id":2,"details":{"previous_state":"newRole1","changes":"newRole1-updated"},"time":"2025-08-15T07:54:36+00:00"},{"history_id":473,"role_id":11,"event_type":"permissions_changed","user_id":2,"details":{"added":["cards.create"]},"time":"2025-08-15T07:54:20+00:00"},{"history_id":472,"role_id":11,"event_type":"created","user_id":2,"details":"newRole1","time":"2025-08-15T07:54:20+00:00"}]},"RolePermissionsExample":{"data":[{"name":"cards.view","available":0},{"name":"cards.create","available":0},{"name":"cards.update","available":0},{"name":"cards.delete","available":0},{"name":"cards.block","available":0},{"name":"cards.move","available":0},{"name":"cards.move_to_board","available":0},{"name":"cards.copy","available":0},{"name":"cards.view_archived","available":0},{"name":"cards.archive","available":0},{"name":"cards.view_discarded","available":0},{"name":"cards.discard","available":0},{"name":"subtasks.view","available":0},{"name":"subtasks.create","available":0},{"name":"subtasks.update","available":0},{"name":"subtasks.delete","available":0},{"name":"subtasks.convert","available":0},{"name":"subtasks.move","available":0},{"name":"comments.view","available":0},{"name":"comments.create","available":0},{"name":"comments.delete","available":0},{"name":"links.view","available":0},{"name":"links.create","available":0},{"name":"links.delete","available":0},{"name":"links.reorder","available":0},{"name":"worklog","available":0},{"name":"export","available":0},{"name":"notifications","available":0},{"name":"attachments.view","available":0},{"name":"attachments.add","available":0},{"name":"attachments.remove","available":0},{"name":"custom_fields.add","available":0},{"name":"custom_fields.remove","available":0},{"name":"actual_start_end_times.update","available":0},{"name":"api","available":0},{"name":"history","available":0},{"name":"metrics","available":0},{"name":"analytics","available":0},{"name":"add_users_to_board","available":0},{"name":"manage_board_filters","available":0},{"name":"workflow","available":0},{"name":"boards.update.name","available":0},{"name":"boards.update.description","available":0},{"name":"boards.update.size_type","available":0},{"name":"boards.update.allow_exceeding","available":0},{"name":"boards.update.limit_type","available":0},{"name":"boards.update.custom_card_id","available":0},{"name":"boards.update.auto_archive_conf","available":0},{"name":"boards.update.generic_blocker_availability","available":0},{"name":"boards.update.default_sender_receiver","available":0},{"name":"boards.manage_arrival_rules","available":0},{"name":"boards.manage_departure_rules","available":0},{"name":"boards.manage_field_formulas","available":0},{"name":"boards.manage_default_templates","available":0},{"name":"boards.manage_maestro_instances","available":0},{"name":"boards.manage_ai_tools","available":0},{"name":"boards.manage_data_fields","available":0},{"name":"boards.manage_maestro_content","available":0},{"name":"workflows.create","available":0},{"name":"workflows.update","available":0},{"name":"workflows.enable_and_disable","available":0},{"name":"workflows.delete","available":0},{"name":"workflows.move","available":0},{"name":"workflows.manage_arrival_rules","available":0},{"name":"workflows.manage_departure_rules","available":0},{"name":"workflows.manage_default_templates","available":0},{"name":"columns.create","available":0},{"name":"columns.update.name","available":0},{"name":"columns.update.description","available":0},{"name":"columns.update.color","available":0},{"name":"columns.update.limit","available":0},{"name":"columns.update.cards_per_row","available":0},{"name":"columns.update.flow_type","available":0},{"name":"columns.delete","available":0},{"name":"columns.move","available":0},{"name":"columns.manage_arrival_rules","available":0},{"name":"columns.manage_departure_rules","available":0},{"name":"columns.manage_service_level_expectations","available":0},{"name":"columns.manage_exit_criteria","available":0},{"name":"columns.manage_card_ordering","available":0},{"name":"lanes.create","available":0},{"name":"lanes.update.name","available":0},{"name":"lanes.update.description","available":0},{"name":"lanes.update.color","available":0},{"name":"lanes.update.limit","available":0},{"name":"lanes.delete","available":0},{"name":"lanes.move","available":0},{"name":"lanes.manage_arrival_rules","available":0},{"name":"lanes.manage_departure_rules","available":0},{"name":"lanes.manage_service_level_expectations","available":0},{"name":"lanes.manage_default_templates","available":0},{"name":"cells.update.merge_and_unmerge","available":0},{"name":"cells.update.limit","available":0},{"name":"cells.manage_arrival_rules","available":0},{"name":"cells.manage_departure_rules","available":0},{"name":"cells.manage_service_level_expectations","available":0},{"name":"cells.manage_card_ordering","available":0}]},"RolesExample":{"data":[{"role_id":1,"name":"default"},{"role_id":2,"name":"admin"},{"role_id":3,"name":"Restrictive"},{"role_id":4,"name":"Customer"}]},"RoleExample":{"data":{"name":"Customer","available":0}},"StickersHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":105,"sticker_id":10,"event_type":"updated_for_board","user_id":2,"details":{"previous_state":{"board_id":1,"limit_per_board":10,"limit_per_card":2},"changes":{"limit_per_board":10,"limit_per_card":2}},"time":"2025-01-04T12:00:00+00:00"},{"history_id":104,"sticker_id":10,"event_type":"added_to_board","user_id":2,"details":{"board_id":1},"time":"2025-01-03T14:00:00+00:00"},{"history_id":103,"sticker_id":10,"event_type":"enabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1047,"label":"string","color":"eceff1","availability":0,"is_enabled":0},"changes":{"is_enabled":1}},"time":"2025-01-03T14:00:00+00:00"},{"history_id":102,"sticker_id":10,"event_type":"disabled","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1047,"label":"string","color":"eceff1","availability":0,"is_enabled":1},"changes":{"is_enabled":0}},"time":"2025-01-03T12:00:00+00:00"},{"history_id":101,"sticker_id":10,"event_type":"updated","user_id":2,"details":{"previous_state":{"icon_type":0,"icon_id":1012,"label":"string","color":"eceff1","availability":0,"is_enabled":1},"changes":{"icon_id":1047}},"time":"2025-01-02T12:00:00+00:00"},{"history_id":100,"sticker_id":10,"event_type":"created","user_id":2,"details":{"icon_id":1012,"label":"string","color":"eceff1","availability":0,"icon_type":0,"is_enabled":1}}]},"StickersExample":{"data":[{"sticker_id":10,"icon_type":0,"icon_id":1047,"label":"string","color":"eceff1","availability":0,"is_enabled":1,"board_ids":[{"board_id":1},{"board_id":2}],"board_count":[{"count":2}],"card_count":[{"count":1}],"business_rules":[{"rule_id":101,"name":"string"}],"arrival_rule_ids":[{"rule_id":100}],"arrival_rule_count":{"count":1},"departure_rule_ids":[{"rule_id":200}],"departure_rule_count":{"count":1},"template_ids":[{"template_id":300},{"template_id":301}],"template_count":{"count":2}}]},"TagsExample":{"data":[{"tag_id":11,"label":"tag1","color":"eceff1","availability":0,"is_enabled":1},{"tag_id":12,"label":"tag2","color":"eceff1","availability":0,"is_enabled":1},{"tag_id":13,"label":"tag4","color":"eceff1","availability":0,"is_enabled":1}]},"TagExample":{"data":{"tag_id":11,"label":"tag1","color":"eceff1","availability":0,"is_enabled":1}},"OutcomeTagsExample":{"data":[{"tag_id":101,"label":"Q1 Target"},{"tag_id":102,"label":"Q2 Milestone"},{"tag_id":103,"label":"Strategic Initiative"}]},"OutcomeTagExample":{"data":{"tag_id":101,"label":"Q1 Target"}},"OutcomeTagsExpandedExample":{"data":[{"tag_id":101,"label":"Q1 Target","outcome_ids":[{"outcome_id":1001},{"outcome_id":1002}],"outcome_count":{"count":2}}]},"OutcomeTagOutcomesExample":{"data":[{"outcome_id":5001},{"outcome_id":5002}]},"OutcomesExample":{"data":[{"outcome_id":5001,"card_id":100,"field_id":null,"rule_id":null,"name":"string","operator":"or_more","owner_user_id":null,"prefix":"","suffix":"","starting_time":"2026-01-01T11:00:00+00:00","target_time":"2026-01-02T11:00:00+00:00","current_value_since":"2026-01-01T11:00:00+00:00","starting_value":0,"target_value":100,"current_value":50,"comment":"string","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"starting_value_predefined_formula_type":null,"target_value_predefined_formula_type":null,"current_value_predefined_formula_type":null,"weight":1,"created_by_user_id":2,"created_at":"2026-01-01T11:00:00+00:00","checkpoints":[],"values":[{"value":0,"time":"2026-01-01T11:00:00+00:00","id":1001},{"value":50,"time":"2026-01-01T11:00:00+00:00","id":1002}],"tag_ids":[{"tag_id":101}],"usage":{"in_cards":1,"in_maestro_instances":0}}]},"OutcomeExample":{"data":{"card_id":null,"field_id":null,"rule_id":null,"name":"string","operator":"or_more","owner_user_id":null,"prefix":"","suffix":"","starting_time":"2026-01-01T11:00:00+00:00","target_time":"2026-01-02T11:00:00+00:00","current_value_since":"2026-01-01T11:00:00+00:00","starting_value":0,"target_value":100,"current_value":50,"comment":"string","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"starting_value_predefined_formula_type":null,"target_value_predefined_formula_type":null,"current_value_predefined_formula_type":null,"weight":1,"created_by_user_id":2,"created_at":"2026-01-01T11:00:00+00:00"}},"OutcomePatchExample":{"data":{"outcome_id":5001,"card_id":null,"field_id":null,"rule_id":null,"name":"string","operator":"or_more","owner_user_id":null,"prefix":"","suffix":"","starting_time":"2026-01-01T11:00:00+00:00","target_time":"2026-01-02T11:00:00+00:00","current_value_since":"2026-01-01T11:00:00+00:00","starting_value":0,"target_value":100,"current_value":50,"comment":"string","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"starting_value_predefined_formula_type":null,"target_value_predefined_formula_type":null,"current_value_predefined_formula_type":null,"weight":1,"created_by_user_id":2,"created_at":"2026-01-01T11:00:00+00:00"}},"OutcomeCreateExample":{"data":{"outcome_id":5001,"card_id":null,"field_id":null,"rule_id":null,"name":"string","operator":"or_more","owner_user_id":null,"prefix":"","suffix":"","starting_time":"2026-01-01T11:00:00+00:00","target_time":"2026-01-02T11:00:00+00:00","current_value_since":"2026-01-01T11:00:00+00:00","starting_value":0,"target_value":100,"current_value":50,"comment":"string","starting_value_formula":null,"target_value_formula":null,"current_value_formula":null,"starting_value_predefined_formula_type":null,"target_value_predefined_formula_type":null,"current_value_predefined_formula_type":null,"weight":1,"created_by_user_id":2,"created_at":"2026-01-01T11:00:00+00:00"}},"TagBoardsExample":{"data":[{"board_id":139},{"board_id":142}]},"TagCardsExample":{"data":[{"card_id":12205},{"card_id":12206}]},"TeamsHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":101,"team_id":1,"event_type":"created","user_id":2,"details":{"name":"New team","description":"This is a new team"},"time":"2025-01-01T12:00:00+00:00"},{"history_id":102,"team_id":1,"event_type":"added_to_board","user_id":2,"details":{"board_id":1,"role_id":2},"time":"2025-01-02T12:00:00+00:00"}]},"TeamsExample":{"data":[{"team_id":1,"name":"New team","description":"This is a new team"},{"team_id":2,"name":"Another team","description":"This is another team"}]},"TeamExample":{"data":{"team_id":1,"name":"New team","description":"This is a new team"}},"TagHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":95,"tag_id":27,"event_type":"deleted","user_id":2,"details":{"label":"newTag01 - updated","color":"7333bd","availability":0,"is_enabled":1},"time":"2025-08-19T10:24:47+00:00"},{"history_id":94,"tag_id":27,"event_type":"removed_from_board","user_id":2,"details":{"board_id":361},"time":"2025-08-19T10:24:43+00:00"},{"history_id":93,"tag_id":27,"event_type":"enabled","user_id":2,"details":{"previous_state":{"label":"newTag01 - updated","color":"7333bd","availability":0,"is_enabled":0},"changes":{"is_enabled":1}},"time":"2025-08-19T10:24:30+00:00"},{"history_id":92,"tag_id":27,"event_type":"disabled","user_id":2,"details":{"previous_state":{"label":"newTag01 - updated","color":"7333bd","availability":0,"is_enabled":1},"changes":{"is_enabled":0}},"time":"2025-08-19T10:24:28+00:00"},{"history_id":91,"tag_id":27,"event_type":"updated","user_id":2,"details":{"previous_state":{"label":"newTag01","color":"7333bd","availability":0,"is_enabled":1},"changes":{"label":"newTag01 - updated"}},"time":"2025-08-19T10:24:18+00:00"},{"history_id":90,"tag_id":27,"event_type":"added_to_board","user_id":2,"details":{"board_id":361},"time":"2025-08-19T10:24:14+00:00"},{"history_id":89,"tag_id":27,"event_type":"created","user_id":2,"details":{"label":"newTag01","color":"7333bd","availability":0,"is_enabled":1},"time":"2025-08-19T10:24:14+00:00"}]},"UserAttributesExample":{"data":[{"attribute_id":1,"name":"Departament","remote_name":"Departament number"},{"attribute_id":2,"name":"City","remote_name":"Locale"}]},"UserAttributeExample":{"data":{"attribute_id":1,"name":"Departament","remote_name":"Departament number"}},"DiscardReasonsHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"history_id":20,"reason_id":6,"event_type":"deleted","user_id":2,"details":{"label":"newDiscardReason - updated","availability":0,"is_enabled":1},"time":"2025-08-20T07:38:53+00:00"},{"history_id":19,"reason_id":6,"event_type":"removed_from_board","user_id":2,"details":{"board_id":359},"time":"2025-08-20T07:38:43+00:00"},{"history_id":18,"reason_id":6,"event_type":"removed_from_board","user_id":2,"details":{"board_id":361},"time":"2025-08-20T07:38:38+00:00"},{"history_id":17,"reason_id":6,"event_type":"added_to_board","user_id":2,"details":{"board_id":361},"time":"2025-08-20T07:37:56+00:00"},{"history_id":16,"reason_id":6,"event_type":"added_to_board","user_id":2,"details":{"board_id":359},"time":"2025-08-20T07:37:49+00:00"},{"history_id":15,"reason_id":6,"event_type":"enabled","user_id":2,"details":{"previous_state":{"label":"newDiscardReason - updated","availability":0,"is_enabled":0},"changes":{"is_enabled":1}},"time":"2025-08-20T07:35:52+00:00"},{"history_id":14,"reason_id":6,"event_type":"disabled","user_id":2,"details":{"previous_state":{"label":"newDiscardReason - updated","availability":0,"is_enabled":1},"changes":{"is_enabled":0}},"time":"2025-08-20T07:35:47+00:00"},{"history_id":13,"reason_id":6,"event_type":"updated","user_id":2,"details":{"previous_state":{"label":"newDiscardReason","availability":0,"is_enabled":1},"changes":{"label":"newDiscardReason - updated"}},"time":"2025-08-20T07:34:42+00:00"},{"history_id":12,"reason_id":6,"event_type":"created","user_id":2,"details":{"label":"newDiscardReason","availability":0,"is_enabled":1},"time":"2025-08-20T07:34:20+00:00"}]},"DiscardReasonsExample":{"data":[{"reason_id":1,"label":"discardReason1","availability":0,"is_enabled":1},{"reason_id":2,"label":"discardReason2","availability":0,"is_enabled":1},{"reason_id":3,"label":"discardReason3","availability":0,"is_enabled":1}]},"DiscardReasonExample":{"data":{"reason_id":1,"label":"discardReason1","availability":0,"is_enabled":1}},"BoardEffectiveCycleTimeColumnsExample":{"data":[{"workflow_id":"13556","name":"Initiatives workflow","effective_cycle_time_columns":[{"column_id":107904,"name":"Requested"},{"column_id":107905,"name":"In Progress"}]},{"workflow_id":"13555","name":"Cards workflow","effective_cycle_time_columns":[{"column_id":107899,"name":"Requested"},{"column_id":107900,"name":"In Progress"}]}]},"UserHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"id":1,"affected_user_id":10,"user_id":10,"event_type":"user_confirmed","details":{"user_id":10,"email":"email@example.com","username":"JD","realname":"John Doe","timezone":"Europe\/Paris","language":"en","avatar":null,"email_signature":null,"is_tfa_enabled":0,"is_enabled":1,"is_confirmed":1,"role_in_company":"","registration_date":"2025-08-10"},"time":"2025-08-10T12:00:00+00:00"},{"id":2,"affected_user_id":10,"user_id":2,"event_type":"added_to_team","details":{"team_id":1},"time":"2025-08-10T12:05:00+00:00"}]},"UserInvolvedBusinessRulesExample":{"data":{"59":[{"rule_id":127471,"name":"Card is created"},{"rule_id":127472,"name":"Card is moved"}]}},"UsersAttributesExample":{"data":[{"user_id":10,"attribute_id":1,"value":"Sales"},{"user_id":10,"attribute_id":2,"value":"New York"}]},"UsersAttributeExample":{"data":{"user_id":10,"attribute_id":1,"value":"Sales"}},"UserTeamsExample":{"data":[{"team_id":1},{"team_id":7},{"team_id":8}]},"UsersExample":{"data":[{"user_id":2,"username":"username1","realname":"realName1","avatar":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80","attributes":[{"attribute_id":1,"value":"value1"},{"attribute_id":2,"value":"value2"}]},{"user_id":3,"username":"userName2","realname":"realName2","avatar":null,"attributes":[]}]},"UserExample":{"data":{"email":"email1@address.com","username":"username1","realname":"realName1","avatar":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80","email_signature":"

This is a signature.<\/p>","is_tfa_enabled":0,"is_enabled":1,"is_confirmed":1,"registration_date":"2025-01-01","timezone":"Europe\/Sofia","language":"en","attributes":[{"attribute_id":1,"value":"value1"},{"attribute_id":2,"value":"value2"}]}},"UserInviteExample":{"data":{"email":"email1@address.com","username":"username1","realname":"realName1","avatar":"\/avatars\/0YIZJOvKgAOuRS7LkBjF\/80x80","email_signature":"

This is a signature.<\/p>","is_tfa_enabled":0,"is_enabled":1,"is_confirmed":1,"registration_date":"2025-01-01","timezone":"Europe\/Sofia","language":"en","user_id":2,"attributes":[{"attribute_id":1,"value":"value1"},{"attribute_id":2,"value":"value2"}]}},"WebhookHistoryExample":{"pagination":{"all_pages":1,"current_page":1,"results_per_page":100},"data":[{"id":5145,"webhook_id":2637,"user_id":2,"event_type":"deleted","details":{"webhook_id":2637,"is_enabled":1,"board_id":367,"url":"https:\/\/webhook.site\/980eb5df-3d57-4d3a-ac9e-ecabf09966dd"},"time":"2025-08-26T07:40:35+00:00"},{"id":5144,"webhook_id":2637,"user_id":2,"event_type":"updated","details":{"previous_state":{"webhook_id":2637,"is_enabled":1,"board_id":367,"url":"https:\/\/webhook.site\/980eb5df-3d57-4d3a-ac9e-ecabf09966dc"},"changes":{"url":"https:\/\/webhook.site\/980eb5df-3d57-4d3a-ac9e-ecabf09966dd"}},"time":"2025-08-26T07:40:28+00:00"},{"id":5143,"webhook_id":2637,"user_id":2,"event_type":"created","details":{"url":"https:\/\/webhook.site\/980eb5df-3d57-4d3a-ac9e-ecabf09966dc","is_enabled":1,"board_id":367,"webhook_id":2637},"time":"2025-08-26T07:40:24+00:00"}]},"WebhooksExample":{"data":[{"webhook_id":20,"is_enabled":1,"board_id":1,"url":"https:\/\/example.com\/webhook1"},{"webhook_id":21,"is_enabled":0,"board_id":2,"url":"https:\/\/example.com\/webhook2"}]},"WebhookExample":{"data":{"is_enabled":1,"board_id":1,"url":"https:\/\/example.com\/webhook1"}},"WebhookCreateResponseExample":{"data":{"url":"https:\/\/example.com\/webhook3","is_enabled":1,"board_id":1,"secret":"abcdefghij1234567890","webhook_id":22}},"WorkspaceManagersExample":{"data":[{"user_id":2},{"user_id":3}]},"WorkspacesExample":{"data":[{"workspace_id":1,"type":1,"is_archived":0,"name":"Workspace 1"},{"workspace_id":2,"type":2,"is_archived":1,"name":"Management Workspace 1"}]},"WorkspaceCreateExample":{"data":{"workspace_id":1,"is_archived":0,"name":"Workspace 1"}},"WorkspaceUpdateExample":{"data":{"type":1,"is_archived":0,"name":"Workspace 1"}},"WorkspaceExample":{"data":{"is_archived":0,"name":"Workspace 1"}},"DataFieldBoardBatchOperationsExample":{"data":[{"board_id":139,"value":5,"baseline":null,"value_is_locked":0},{"board_id":142,"value":10,"baseline":20,"value_is_locked":1}]},"WorkspaceHistoryExample":{"pagination":{"all_pages":13,"current_page":1,"results_per_page":100},"data":[{"history_id":1263,"workspace_id":261,"event_type":"removed_from_dashboard_page","user_id":2,"details":{"dashboard_page_id":35},"time":"2025-08-27T08:31:19+00:00"},{"history_id":1262,"workspace_id":261,"event_type":"added_to_dashboard_page","user_id":2,"details":{"dashboard_page_id":35},"time":"2025-08-27T08:31:07+00:00"},{"history_id":1261,"workspace_id":261,"event_type":"wm_removed","user_id":2,"details":"49","time":"2025-08-27T08:30:53+00:00"},{"history_id":1260,"workspace_id":261,"event_type":"wm_added","user_id":2,"details":"49","time":"2025-08-27T08:30:50+00:00"},{"history_id":1259,"workspace_id":261,"event_type":"board_moved_in","user_id":2,"details":{"board_id":371,"name":"New board"},"time":"2025-08-27T08:30:17+00:00"},{"history_id":1258,"workspace_id":262,"event_type":"board_moved_out","user_id":2,"details":{"board_id":371,"name":"New board"},"time":"2025-08-27T08:30:17+00:00"},{"history_id":1257,"workspace_id":262,"event_type":"board_moved_in","user_id":2,"details":{"board_id":371,"name":"New board"},"time":"2025-08-27T08:30:06+00:00"},{"history_id":1256,"workspace_id":261,"event_type":"board_moved_out","user_id":2,"details":{"board_id":371,"name":"New board"},"time":"2025-08-27T08:30:06+00:00"},{"history_id":1255,"workspace_id":262,"event_type":"board_deleted","user_id":2,"details":{"board_id":372,"name":"New board - updated"},"time":"2025-08-27T08:29:57+00:00"},{"history_id":1254,"workspace_id":262,"event_type":"board_archived","user_id":2,"details":{"previous_state":{"board_id":372,"name":"New board - updated"},"changes":{"is_archived":1}},"time":"2025-08-27T08:29:53+00:00"},{"history_id":1253,"workspace_id":262,"event_type":"board_renamed","user_id":2,"details":{"previous_state":{"board_id":372,"name":"New board"},"changes":{"board_id":372,"name":"New board - updated"}},"time":"2025-08-27T08:29:31+00:00"},{"history_id":1252,"workspace_id":262,"event_type":"board_unarchived","user_id":2,"details":{"previous_state":{"board_id":372,"name":"New board"},"changes":{"is_archived":0}},"time":"2025-08-27T08:29:20+00:00"},{"history_id":1251,"workspace_id":262,"event_type":"unarchived","user_id":2,"details":{"previous_state":{"type":1,"is_archived":1,"name":"New workspace - updated"},"changes":{"is_archived":0}},"time":"2025-08-27T08:29:20+00:00"},{"history_id":1250,"workspace_id":262,"event_type":"archived","user_id":2,"details":{"previous_state":{"type":1,"is_archived":0,"name":"New workspace - updated"},"changes":{"is_archived":1}},"time":"2025-08-27T08:29:16+00:00"},{"history_id":1249,"workspace_id":262,"event_type":"board_archived","user_id":2,"details":{"previous_state":{"board_id":372,"name":"New board"},"changes":{"is_archived":1}},"time":"2025-08-27T08:29:16+00:00"},{"history_id":1248,"workspace_id":262,"event_type":"updated","user_id":2,"details":{"previous_state":{"type":1,"is_archived":0,"name":"New workspace"},"changes":{"name":"New workspace - updated"}},"time":"2025-08-27T08:29:07+00:00"},{"history_id":1247,"workspace_id":262,"event_type":"board_created","user_id":2,"details":{"board_id":372,"name":"New board"},"time":"2025-08-27T08:28:20+00:00"},{"history_id":1246,"workspace_id":262,"event_type":"wm_added","user_id":2,"details":"2","time":"2025-08-27T08:28:20+00:00"},{"history_id":1245,"workspace_id":262,"event_type":"created","user_id":2,"details":{"name":"New workspace","type":1,"is_archived":0,"workspace_id":262},"time":"2025-08-27T08:28:20+00:00"},{"history_id":1244,"workspace_id":261,"event_type":"board_created","user_id":2,"details":{"board_id":371,"name":"New board"},"time":"2025-08-27T08:28:00+00:00"},{"history_id":1243,"workspace_id":261,"event_type":"wm_added","user_id":2,"details":"2","time":"2025-08-27T08:27:59+00:00"},{"history_id":1242,"workspace_id":261,"event_type":"created","user_id":2,"details":{"name":"New workspace","type":1,"is_archived":0,"workspace_id":261},"time":"2025-08-27T08:27:59+00:00"}]},"WorkflowsExample":{"data":[{"type":2,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Timeline workflow","workflow_id":836},{"type":1,"position":1,"is_enabled":1,"is_collapsible":1,"name":"Initiatives workflow","workflow_id":706},{"type":0,"position":2,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow","workflow_id":705}]},"WorkflowCreateExample":{"data":{"type":0,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow","workflow_id":705}},"WorkflowExample":{"data":{"type":0,"position":2,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow"}},"WorkflowCopyExample":{"data":{"board_structure":{"version":"1.0","workspace_id":210,"board_id":315,"name":"1048179","description":"","is_archived":0,"workflow_order":[836,706,705,841],"workflows":{"705":{"type":0,"position":2,"is_enabled":1,"is_collapsible":1,"name":"Cards workflow","top_lanes":[1020],"bottom_lanes":[1020],"top_columns":[4098,4099,4100,4101,4102],"bottom_columns":[4098,4099,4100,4101,4102],"section_columns":{"1":[4098],"2":[4099],"3":[4100],"4":[4101],"5":[4102]}},"706":{"type":1,"position":1,"is_enabled":1,"is_collapsible":1,"name":"Initiatives workflow","top_lanes":[1021],"bottom_lanes":[1021],"top_columns":[4103,4104,4105,4106,4107],"bottom_columns":[4103,4104,4105,4106,4107],"section_columns":{"1":[4103],"2":[4104],"3":[4105],"4":[4106],"5":[4107]}},"836":{"type":2,"position":0,"is_enabled":1,"is_collapsible":1,"name":"Timeline workflow","top_lanes":[1153],"bottom_lanes":[1153],"top_columns":[4753,4754,4755,4756,4757],"bottom_columns":[4753,4754,4755,4756,4757],"section_columns":{"1":[4753],"2":[4754],"3":[4755],"4":[4756],"5":[4757]}},"841":{"type":1,"position":3,"is_enabled":1,"is_collapsible":1,"name":"Copy of the Initiatives workflow","top_lanes":[1158],"bottom_lanes":[1158],"top_columns":[4778,4779,4780,4781,4782],"bottom_columns":[4778,4779,4780,4781,4782],"section_columns":{"1":[4778],"2":[4779],"3":[4780],"4":[4781],"5":[4782]}}},"lanes":{"1020":{"workflow_id":705,"parent_lane_id":0,"name":"Default Swimlane","description":"","color":"ffffff"},"1021":{"workflow_id":706,"parent_lane_id":0,"name":"Portfolio Lane","description":"","color":"ffffff"},"1153":{"workflow_id":836,"parent_lane_id":0,"name":"Timeline","description":"","color":"ffffff"},"1158":{"workflow_id":841,"parent_lane_id":0,"name":"Portfolio Lane","description":"","color":"ffffff"}},"columns":{"4098":{"workflow_id":705,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4099":{"workflow_id":705,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4100":{"workflow_id":705,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4101":{"workflow_id":705,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4102":{"workflow_id":705,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4103":{"workflow_id":706,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4104":{"workflow_id":706,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4105":{"workflow_id":706,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4106":{"workflow_id":706,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4107":{"workflow_id":706,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4753":{"workflow_id":836,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4754":{"workflow_id":836,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4755":{"workflow_id":836,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4756":{"workflow_id":836,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4757":{"workflow_id":836,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4778":{"workflow_id":841,"section":1,"parent_column_id":0,"name":"Backlog","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4779":{"workflow_id":841,"section":2,"parent_column_id":0,"name":"Requested","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4780":{"workflow_id":841,"section":3,"parent_column_id":0,"name":"In Progress","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]},"4781":{"workflow_id":841,"section":4,"parent_column_id":0,"name":"Done","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":2,"card_ordering":null,"checklist_items":[]},"4782":{"workflow_id":841,"section":5,"parent_column_id":0,"name":"Ready to Archive","description":"","color":"","limit":0,"cards_per_row":1,"flow_type":1,"card_ordering":null,"checklist_items":[]}},"child_lanes":{},"child_columns":{},"column_checklist_items":{},"size_type":0,"allow_exceeding":0,"autoarchive_cards_after":7,"limit_type":0,"allow_repeating_custom_card_ids":1,"is_discard_reason_required":0,"size_formula":"average(1,2)","deadline_formula":"card.created_at()","default_sender_user_id":2147483647,"default_receiver_user_id":2,"allow_generic_blocker":1,"type":1,"main_maestro_instance_id":null,"cell_card_orderings":{},"cell_limits":{},"lane_section_limits":{},"merged_areas":{},"revision":14},"cycle_time_column_ids":[4099,4100,4104,4105,4754,4755,4779,4780],"initiative_workflow_settings":[{"workflow_id":706,"built_in_rules_can_start_initiatives":1,"built_in_rules_can_finish_initiatives":1,"built_in_rules_can_move_to_requested":1,"built_in_rules_can_move_back_from_done":1,"built_in_rules_can_move_from_backlog_to_requested":1,"built_in_rules_can_move_from_done_to_archive":1},{"workflow_id":841,"built_in_rules_can_start_initiatives":1,"built_in_rules_can_finish_initiatives":1,"built_in_rules_can_move_to_requested":1,"built_in_rules_can_move_back_from_done":1,"built_in_rules_can_move_from_backlog_to_requested":1,"built_in_rules_can_move_from_done_to_archive":1}],"new_workflow_default_templates":{"workflow_template_id":235,"lane_templates":{"818":233,"819":233}}}},"DataFieldWorkspacesBatchOperationsExample":{"data":{"apply_to_all_boards_in_workspace_ids":[501],"value_is_locked_for_all_boards_in_workspace_ids":[507],"workspace_data_fields":[{"workspace_id":344,"value":"test","baseline":null,"show_in_dashboard":1},{"workspace_id":346,"value":"test2","baseline":null,"show_in_dashboard":0}]}}}},"security":[{"apikey":[]}]}