{ "swagger": "2.0", "info": { "title": "RestyaBoard", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "apiteam@swagger.io" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "basePath": "/v1", "schemes": [ "http" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "paths": { "/v1/oauth.json": { "get": { "tags": [ "users" ], "summary": "Get Oauth token", "description": "", "produces": [ "application/json" ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "access_token": { "type": "string" }, "expires_in": { "type": "string" }, "token_type": { "type": "string" }, "scope": { "type": "string" }, "id": { "type": "integer" }, "links": { "type": "string" }, "languages": { "type": "string" }, "apps": { "type": "string" } } } } } } }, "/v1/users/me.json": { "get": { "tags": [ "users" ], "summary": "Fetch user", "description": "Returns Users listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "User": { "properties": { "id": { "type": "integer" }, "role_id": { "type": "integer" }, "username": { "type": "string" }, "password": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "initials": { "type": "string" }, "about_me": { "type": "string" }, "profile_picture_path": { "type": "string" }, "notification_frequency": { "type": "string" }, "is_allow_desktop_notification": { "type": "boolean", "default": false }, "is_active": { "type": "boolean", "default": false }, "is_email_confirmed": { "type": "boolean", "default": false }, "created_organization_count": { "type": "integer" }, "created_board_count": { "type": "integer" }, "joined_organization_count": { "type": "integer" }, "list_count": { "type": "integer" }, "joined_card_count": { "type": "integer" }, "created_card_count": { "type": "integer" }, "joined_board_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "is_productivity_beats": { "type": "boolean", "default": false }, "organizations": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "website_url": { "type": "string" }, "logo_url": { "type": "string" }, "organization_visibility": { "type": "integer" } } }, "last_activity_id": { "type": "integer" }, "boards_stars": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" }, "name": { "type": "string" }, "background_picture_url": { "type": "string" }, "background_color": { "type": "string" } } }, "last_login_date": { "type": "string" }, "last_login_ip": { "type": "string" }, "login_city_name": { "type": "string" }, "login_state_name": { "type": "string" }, "login_country_name": { "type": "string" }, "login_country_iso2": { "type": "string" }, "registered_ip": { "type": "string" }, "register_city_name": { "type": "string" }, "register_state_name": { "type": "string" }, "register_country_name": { "type": "string" }, "register_country_iso2": { "type": "string" }, "login_type": { "type": "string" }, "created": { "type": "string" }, "user_login_count": { "type": "integer" }, "is_send_newsletter": { "type": "integer" }, "last_email_notified_activity_id": { "type": "integer" }, "owner_board_count": { "type": "integer" }, "member_board_count": { "type": "integer" }, "owner_organization_count": { "type": "integer" }, "member_organization_count": { "type": "integer" }, "is_ldap": { "type": "integer" }, "notify_count": { "type": "integer" }, "language": { "type": "string" }, "timezone": { "type": "string" } } } } } }, "404": { "description": "Not found" } } } }, "/v1/users.json": { "get": { "tags": [ "users" ], "summary": "users", "description": "Returns Users listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "username": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "full_name": { "type": "string" }, "initials": { "type": "string" }, "about_me": { "type": "string" }, "profile_picture_path": { "type": "string" }, "notification_frequency": { "type": "integer" }, "is_allow_desktop_notification": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "is_email_confirmed": { "type": "boolean", "default": false }, "created_organization_count": { "type": "integer" }, "created_board_count": { "type": "integer" }, "joined_organization_count": { "type": "integer" }, "list_count": { "type": "integer" }, "joined_card_count": { "type": "integer" }, "created_card_count": { "type": "integer" }, "joined_board_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "last_activity_id": { "type": "integer" }, "last_login_date": { "type": "integer" }, "last_login_ip_id": { "type": "integer" }, "ip_id": { "type": "integer" }, "login_type_id": { "type": "integer" }, "is_productivity_beats": { "type": "integer" }, "user_login_count": { "type": "integer" }, "is_ldap": { "type": "integer" }, "is_send_newsletter": { "type": "integer" }, "last_email_notified_activity_id": { "type": "integer" }, "owner_board_count": { "type": "integer" }, "member_board_count": { "type": "integer" }, "owner_organization_count": { "type": "integer" }, "member_organization_count": { "type": "integer" }, "language": { "type": "integer" }, "timezone": { "type": "integer" } } } }, "404": { "description": "User not found" } } }, "post": { "tags": [ "users" ], "summary": "Creates User", "description": "Created User", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created user object", "required": true, "schema": { "properties": { "email": { "type": "string" }, "is_agree_terms_and_conditions": { "type": "boolean", "default": false }, "password": { "type": "string" }, "username": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } } } } }, "/v1/users/logout.json": { "get": { "tags": [ "users" ], "summary": "Logs out current logged in user session", "description": ".", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "user": { "type": "string" } } } } } } }, "/v1/users/{userId}/activities.json": { "get": { "tags": [ "users" ], "summary": "Activities", "description": "Returns User Activities.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Selected User ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } } }, "404": { "description": "User not found" } } } }, "/v1/users/search.json": { "get": { "tags": [ "users" ], "summary": "Get User by Name", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "q", "in": "query", "description": "User name to fetch Users", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "username": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "full_name": { "type": "string" } } } }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}.json": { "get": { "tags": [ "users" ], "summary": "users", "description": "Returns Users listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Selected User ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "username": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "full_name": { "type": "string" }, "initials": { "type": "string" }, "about_me": { "type": "string" }, "profile_picture_path": { "type": "string" }, "notification_frequency": { "type": "integer" }, "is_allow_desktop_notification": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "is_email_confirmed": { "type": "boolean", "default": false }, "created_organization_count": { "type": "integer" }, "created_board_count": { "type": "integer" }, "joined_organization_count": { "type": "integer" }, "list_count": { "type": "integer" }, "joined_card_count": { "type": "integer" }, "created_card_count": { "type": "integer" }, "joined_board_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "last_activity_id": { "type": "integer" }, "last_login_date": { "type": "integer" }, "last_login_ip_id": { "type": "integer" }, "ip_id": { "type": "integer" }, "login_type_id": { "type": "integer" }, "is_productivity_beats": { "type": "integer" }, "user_login_count": { "type": "integer" }, "is_ldap": { "type": "integer" }, "is_send_newsletter": { "type": "integer" }, "last_email_notified_activity_id": { "type": "integer" }, "owner_board_count": { "type": "integer" }, "member_board_count": { "type": "integer" }, "owner_organization_count": { "type": "integer" }, "member_organization_count": { "type": "integer" }, "language": { "type": "integer" }, "timezone": { "type": "integer" } } } }, "404": { "description": "User not found" } } }, "put": { "tags": [ "users" ], "summary": "Edit user", "description": "Update the users details", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Current Login user ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Edit user object", "required": true, "schema": { "properties": { "dob": { "type": "string" }, "first_name": { "type": "string" }, "gender_id": { "type": "integer" }, "last_name": { "type": "string" }, "username": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "email": { "type": "string" }, "is_agree_terms_and_conditions": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } } } }, "404": { "description": "User not found" } } }, "delete": { "tags": [ "users" ], "summary": "Deletes the user", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "user id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/users/{userId}/boards.json": { "get": { "tags": [ "boards" ], "summary": "Get User boards", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Selected User ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "starred_boards": { "type": "array", "items": { "type": "integer" } }, "user_boards": { "properties": { "organization_id": { "type": "integer" }, "organization_name": { "type": "string" }, "board_id": { "type": "integer" } } } } } } } } }, "/v1/users/{userId}/cards.json": { "get": { "tags": [ "cards" ], "summary": "View user cards", "description": "View user cards", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Selected user ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "cards_users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } } } } }, "/v1/boards/search.json": { "get": { "tags": [ "boards" ], "summary": "Get Board by Name", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "q", "in": "query", "description": "Board name to fetch Users", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "background_color": { "type": "string" } } } }, "404": { "description": "Not found" } } } }, "/v1/boards/list.json": { "get": { "tags": [ "boards" ], "summary": "List boards", "description": "Returns a Board List", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "type", "in": "query", "description": "User name to fetch Users", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } } }, "/v1/boards.json": { "get": { "tags": [ "boards" ], "summary": "Find Board by userId", "description": "Returns a Board based on userID", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } }, "post": { "tags": [ "boards" ], "summary": "Add a new board", "description": "", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created Board", "required": true, "schema": { "properties": { "board_visibility": { "type": "integer" }, "name": { "type": "string" }, "group_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "simple_boards": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "name": { "type": "string" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "string" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "string" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_logo_url": { "type": "string" } } } } } } } } }, "/v1/settings/{settingId}.json": { "get": { "tags": [ "settings" ], "summary": "Get Settings by ID", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "settingId", "in": "path", "description": "Id of settings to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "parent_id": { "type": "integer" } } } }, "404": { "description": "Not found" } } } }, "/v1/email_templates/{emailTemplateId}.json": { "get": { "tags": [ "email_templates" ], "summary": "Get email template by ID", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "emailTemplateId", "in": "path", "description": "Id of template to fetch", "required": true, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "display_name": { "type": "string" }, "template": { "properties": { "from_email": { "type": "string" }, "reply_to_email": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "email_text_content": { "type": "string" }, "email_variables": { "type": "string" } } } } } }, "404": { "description": "Not found" } } }, "put": { "tags": [ "email_templates" ], "summary": "Update an email templates", "description": "Update the email templates", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "emailTemplateId", "in": "path", "description": "emailTemplate id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Update emailTemplate object", "required": true, "schema": { "properties": { "from_email": { "type": "string" }, "reply_to_email": { "type": "string" }, "subject": { "type": "string" }, "email_text_content": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "from_email": { "type": "string" }, "reply_to_email": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "subject": { "type": "string" }, "email_text_content": { "type": "string" }, "email_variables": { "type": "string" }, "display_name": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}.json": { "get": { "tags": [ "boards" ], "summary": "View board", "description": "Returns a Board based on ID", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } }, "put": { "tags": [ "boards" ], "summary": "Edit board", "description": "Update the board details", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Edit board", "required": true, "schema": { "properties": { "name": { "type": "string" }, "board_visibility": { "type": "integer" }, "organization_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/organizations.json": { "get": { "tags": [ "organizations" ], "summary": "Finds organizations by tags", "description": "Returns organization list.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid input" } } }, "post": { "tags": [ "organizations" ], "summary": "Add a new organizations to the store", "description": "", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created Organization object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "group_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/organizations/{organizationId}.json": { "get": { "tags": [ "organizations" ], "summary": "Find organizations by userId", "description": "Returns a organizations based on organizationsID", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "Selected organization Id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } }, "put": { "tags": [ "organizations" ], "summary": "Update an existing organizations", "description": "Update the Organization", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "Organization id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created webhook object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" }, "405": { "description": "Validation exception" } } }, "delete": { "tags": [ "organizations" ], "summary": "Deletes a organization", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "hook id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/activities.json": { "get": { "tags": [ "cards" ], "summary": "Activities", "description": "Returns Card Activities", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/activities.json": { "get": { "tags": [ "lists" ], "summary": "Activities", "description": "Returns list Activities", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": {} } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/activities.json": { "get": { "tags": [ "boards" ], "summary": "Activities", "description": "Returns Board Activities", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } } }, "/v1/boards/{boardId}/boards_stars.json": { "get": { "tags": [ "boards" ], "summary": "Board stars", "description": ".", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_starred": { "type": "integer" } } } } } }, "post": { "tags": [ "boards" ], "summary": "Star board", "description": "Star board", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs add Subscriber into the Board", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Star board", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "is_starred": { "type": "boolean", "default": true }, "user_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/board_subscribers.json": { "get": { "tags": [ "boards" ], "summary": "listing the board Subscribers", "description": "listing the board Subscribers", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "boards" ], "summary": "Add subscriber to Board", "description": "Add subscriber to Board", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs add Subscriber into the Board", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "user_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}.json": { "get": { "tags": [ "cards" ], "summary": "Cards", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "attachment_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "label_count": { "type": "integer" }, "cards_user_count": { "type": "integer" }, "cards_subscriber_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "user_id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "comment_count": { "type": "integer" }, "color": { "type": "string" }, "cards_checklists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "name": { "type": "string" }, "checklist_item_count": { "type": "string" }, "checklist_item_completed_count": { "type": "integer" }, "position": { "type": "integer" } } }, "cards_users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_voters": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "cards_labels": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "card_id": { "type": "integer" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" } } }, "username": { "type": "string" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "notification_due_date": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "cards" ], "summary": "Edit card", "description": "Update the Card details", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Edit card", "required": true, "schema": { "properties": { "name": { "type": "string" }, "is_archived": { "type": "boolean", "default": false }, "due_date": { "type": "string" }, "position": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "cards" ], "summary": "Deletes the card", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Board ID to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list ID to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "card ID to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists.json": { "get": { "tags": [ "lists" ], "summary": "View board by ID", "description": "Returns a Board based on ID", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } }, "post": { "tags": [ "lists" ], "summary": "Add a new list to the board", "description": "Created a List for board", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created list object", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "name": { "type": "string" }, "position": { "type": "integer" }, "uuid": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "card_count": { "type": "integer" }, "is_deleted": { "type": "boolean", "default": false }, "lists_subscriber_count": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "lists" ], "summary": "Deletes a list", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards.json": { "get": { "tags": [ "cards" ], "summary": "Archived card send back to board", "description": "Archived card send back to board", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "list_id": { "type": "integer" }, "board_id": { "type": "integer" }, "card_id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "cards" ], "summary": "Move list cards", "description": "", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created card object", "required": true, "schema": { "properties": { "is_archived": { "type": "integer" }, "list_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "cards" ], "summary": "Add a new card", "description": "", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created card object", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/user_logins.json": { "get": { "tags": [ "user_logins" ], "summary": "List User Logins", "description": "User Logins details", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "ip_id": { "type": "integer" }, "user_agent": { "type": "string" }, "username": { "type": "string" }, "email": { "type": "string" }, "role_id": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "full_name": { "type": "string" }, "is_login_failed": { "type": "string" } } } }, "404": { "description": "Page not found" }, "405": { "description": "Validation exception" } } } }, "/v1/activities.json": { "get": { "tags": [ "activities" ], "summary": "List Activities", "description": "Activities details", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "description": { "type": "string" } } } }, "404": { "description": "Page not found" }, "405": { "description": "Validation exception" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists.json": { "get": { "tags": [ "checklists" ], "summary": "Add a new checklists to the card", "description": "Created checklists", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "checklist": { "properties": { "created": { "type": "string" }, "modified": { "type": "string" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "checklists" ], "summary": "Add a new checklists to the card", "description": "Created checklists", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "position": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "checklist": { "properties": { "created": { "type": "string" }, "modified": { "type": "string" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/visibility.json": { "get": { "tags": [ "boards" ], "summary": "View board visibility", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "board_visibility": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/workflow_templates.json": { "get": { "tags": [ "boards" ], "summary": "", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "name": { "type": "string" }, "value": { "type": "string" } } } }, "404": { "description": "Page not found" }, "405": { "description": "Invalid ID supplied" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/search.json": { "get": { "tags": [ "cards" ], "summary": "cards by listID", "description": "Returns Card details", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/cards/search.json": { "get": { "tags": [ "cards" ], "summary": "cards by name", "description": "Returns Card Activities", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/acl_links.json": { "get": { "tags": [ "acl" ], "summary": "acl", "description": "Returns settings listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "acl_links": { "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "group_id": { "type": "integer" }, "acl_links_roles": { "type": "string" }, "is_guest_action": { "type": "boolean" }, "is_user_action": { "type": "boolean" }, "is_admin_action": { "type": "boolean" }, "is_hide": { "type": "boolean" } } } } } }, "400": { "description": "Invalid input" } } }, "post": { "tags": [ "acl" ], "summary": "Add a acl", "description": "Created acl", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created acl object", "required": true, "schema": { "properties": { "acl_link_id": { "type": "integer" }, "role_id": { "type": "integer" }, "table": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/settings.json": { "get": { "tags": [ "settings" ], "summary": "settings", "description": "Returns settings listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "SITE_NAME": { "type": "integer" }, "PAGING_COUNT": { "type": "string" }, "SITE_TIMEZONE": { "type": "string" }, "DROPBOX_APPKEY": { "type": "string" }, "FLICKR_API_KEY": { "type": "string" }, "LABEL_ICON": { "type": "string" }, "DEFAULT_LANGUAGE": { "type": "string" }, "IMAP_EMAIL": { "type": "string" }, "DEFAULT_CARD_VIEW": { "type": "string" }, "apps_data": { "type": "string" } } } }, "400": { "description": "Invalid input" } } }, "post": { "tags": [ "settings" ], "summary": "Add settings", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created settings object", "required": true, "schema": { "properties": { "setting_category_id": { "type": "integer" }, "name": { "type": "string" }, "value": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/apps.json": { "get": { "tags": [ "apps" ], "summary": "Apps", "description": "Returns apps listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "uid": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "author": { "type": "string" }, "author_email": { "type": "string" }, "author_url": { "type": "string" }, "version": { "type": "string" }, "price": { "type": "string" }, "icon": { "type": "string" }, "settings_description": { "type": "string" }, "settings": { "type": "integer" }, "assets": { "type": "string" }, "enabled": { "type": "boolean" }, "folder": { "type": "string" } } } }, "400": { "description": "Invalid input" } } } }, "/v1/apps/settings.json": { "get": { "tags": [ "apps" ], "summary": "Apps", "description": "Returns apps listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "app", "in": "query", "description": "Selected board ID", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "label": { "type": "string" }, "info": { "type": "string" }, "value": { "type": "string" }, "is_public": { "type": "boolean" }, "name": { "type": "string" }, "folder": { "type": "string" }, "app_name": { "type": "string" }, "settings_description": { "type": "string" } } } }, "400": { "description": "Invalid input" } } } }, "/v1/oauth/clients.json": { "get": { "tags": [ "oauth_clients" ], "summary": "Finds organizations by tags", "description": "Returns clients listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "policy_url": { "type": "string" }, "tos_url": { "type": "string" }, "logo_url": { "type": "string" }, "client_url": { "type": "string" }, "client_name": { "type": "string" }, "scope": { "type": "string" }, "grant_types": { "type": "string" }, "redirect_uri": { "type": "integer" }, "client_secret": { "type": "string" }, "client_id": { "type": "integer" } } } } } }, "400": { "description": "Invalid input" } } }, "post": { "tags": [ "oauth_clients" ], "summary": "Add a new oauth_clients to the store", "description": "Created clients", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created client object", "required": true, "schema": { "properties": { "client_name": { "type": "string" }, "client_url": { "type": "string" }, "logo_url": { "type": "string" }, "policy_url": { "type": "string" }, "redirect_uris": { "type": "string" }, "tos_url": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/oauth/applications.json": { "get": { "tags": [ "oauth_applications" ], "summary": "Finds oauth application by tags", "description": "Returns oauth application listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "array": { "type": "string" } } } }, "400": { "description": "Invalid input" } } } }, "/v1/webhooks.json": { "get": { "tags": [ "webhooks" ], "summary": "Finds webhooks by tags", "description": "Returns webhooks listing.", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "name": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "description": { "type": "string" }, "secret": { "type": "string" }, "url": { "type": "string" } } } }, "400": { "description": "Invalid input" } } }, "post": { "tags": [ "webhooks" ], "summary": "Add a new webhooks to the store", "description": "Created Webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created webhook object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "description": { "type": "string" }, "secret": { "type": "string" }, "url": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/users/bulk_action.json": { "post": { "tags": [ "users" ], "summary": "Enter your Email, and we will send resetting your password.", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created list subcriber object", "required": true, "schema": { "properties": { "user_id": { "type": "integer" }, "action_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } } } } }, "/v1/boards/bulk_action.json": { "post": { "tags": [ "boards" ], "summary": "Bulk action", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Bulk action", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "action_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } } } } }, "/v1/users/forgotpassword.json": { "post": { "tags": [ "users" ], "summary": "Enter your Email, and we will send resetting your password.", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created list subcriber object", "required": true, "schema": { "properties": { "email": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } } } } }, "/v1/users/register.json": { "post": { "tags": [ "users" ], "summary": "Creates User", "description": "Created Webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created user object", "required": true, "schema": { "properties": { "email": { "type": "string" }, "is_agree_terms_and_conditions": { "type": "boolean", "default": false }, "password": { "type": "string" }, "username": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } } } } }, "/v1/users/login.json": { "post": { "tags": [ "users" ], "summary": "Logs user into the system", "description": "", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created Board", "required": true, "schema": { "properties": { "email": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "links": { "type": "string" }, "access_token": { "type": "string" }, "expires_in": { "type": "integer" }, "token_type": { "type": "string" }, "scope": { "type": "integer" }, "refresh_token": { "type": "integer" }, "users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "username": { "type": "string" }, "email": { "type": "string" }, "password": { "type": "string" }, "full_name": { "type": "string" }, "initials": { "type": "string" }, "about_me": { "type": "string" }, "profile_picture_path": { "type": "string" }, "notification_frequency": { "type": "integer" }, "is_allow_desktop_notification": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "is_email_confirmed": { "type": "boolean", "default": false }, "created_organization_count": { "type": "integer" }, "created_board_count": { "type": "integer" }, "joined_organization_count": { "type": "integer" }, "list_count": { "type": "integer" }, "joined_card_count": { "type": "integer" }, "created_card_count": { "type": "integer" }, "joined_board_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "last_activity_id": { "type": "integer" }, "last_login_date": { "type": "integer" }, "last_login_ip_id": { "type": "integer" }, "ip_id": { "type": "integer" }, "login_type_id": { "type": "integer" }, "is_productivity_beats": { "type": "integer" }, "user_login_count": { "type": "integer" }, "is_ldap": { "type": "integer" }, "is_send_newsletter": { "type": "integer" }, "last_email_notified_activity_id": { "type": "integer" }, "owner_board_count": { "type": "integer" }, "member_board_count": { "type": "integer" }, "owner_organization_count": { "type": "integer" }, "member_organization_count": { "type": "integer" }, "language": { "type": "integer" }, "timezone": { "type": "integer" } } }, "boards": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/users/{userId}/adminchangepassword.json": { "post": { "tags": [ "users" ], "summary": "Change password", "description": "Update the users details", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "user ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Change Password user object", "required": true, "schema": { "properties": { "confirmpassword": { "type": "string" }, "id": { "type": "integer" }, "oldpassword": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "400": { "description": "Invalid username supplied" }, "404": { "description": "User not found" } } } }, "/v1/users/{userId}/changepassword.json": { "post": { "tags": [ "users" ], "summary": "Edit user", "description": "Update the users details", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Current Login user ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Change Password user object", "required": true, "schema": { "properties": { "confirmpassword": { "type": "string" }, "id": { "type": "integer" }, "oldpassword": { "type": "string" }, "password": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "400": { "description": "Invalid username supplied" }, "404": { "description": "User not found" } } } }, "/v1/boards/{boardId}/copy.json": { "post": { "tags": [ "boards" ], "summary": "Copy board", "description": "Copy board", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs add Subscriber into the Board", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Copy board", "required": true, "schema": { "properties": { "board_visibility": { "type": "integer" }, "keepCards": { "type": "boolean", "default": true }, "organization_id": { "type": "integer" } } } } ], "responses": { "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/custom_backgrounds.json": { "post": { "tags": [ "boards" ], "summary": "Upload custom background to board", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs add Subscriber into the Board", "required": true, "type": "integer", "format": "int64" } ], "responses": { "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/users.json": { "post": { "tags": [ "boards" ], "summary": "Add Board Member", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs add Subscriber into the Board", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Add Board Member", "required": true, "schema": { "properties": { "board_user_role_id": { "type": "integer" }, "user_id": { "type": "integer" } } } } ], "responses": { "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/list_subscribers.json": { "post": { "tags": [ "lists" ], "summary": "Add a new list subcriber to the board", "description": "Created a List subcriber for board", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created list subcriber object", "required": true, "schema": { "properties": { "is_subscribed": { "type": "boolean", "default": true } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "card_count": { "type": "integer" }, "is_deleted": { "type": "boolean", "default": false }, "lists_subscriber_count": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/comments.json": { "post": { "tags": [ "comments" ], "summary": "Add a new comments to the card", "description": "Created comments", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "comment": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "list_id": { "type": "integer" }, "board_id": { "type": "integer" }, "card_id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/card_subscribers.json": { "post": { "tags": [ "cards" ], "summary": "Subscribe Card", "description": "Subscribe Card", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created webhook object", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "card_id": { "type": "integer" }, "is_offline": { "type": "boolean", "default": true }, "is_subscribed": { "type": "boolean", "default": true }, "list_id": { "type": "integer" }, "user_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/card_voters.json": { "post": { "tags": [ "card_voters" ], "summary": "Add a new card_voters", "description": "Created card_voters", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "checklist": { "properties": { "created": { "type": "string" }, "modified": { "type": "string" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/attachments.json": { "post": { "tags": [ "card_attachments" ], "summary": "Add a new card_attachments", "description": "Created comments", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "list_id": { "type": "integer" }, "board_id": { "type": "integer" }, "card_id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/labels.json": { "post": { "tags": [ "cards_labels" ], "summary": "Add a new labels to the card", "description": "Created labels", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "list_id": { "type": "integer" }, "board_id": { "type": "integer" }, "card_id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists/{checklistId}/items.json": { "post": { "tags": [ "checklist_tems" ], "summary": "Add a new checklistItem", "description": "Created checklistItem", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistId", "in": "path", "description": "checklistId to Post", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "check_list": { "properties": { "created": { "type": "string" }, "modified": { "type": "string" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists/{checkListId}/items/{itemId}/convert_to_card.json": { "post": { "tags": [ "cards" ], "summary": "Convert item to card", "description": "Convert item to card", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "checkListId", "in": "path", "description": "Selected checkList ID", "required": true, "type": "integer", "format": "int64" }, { "name": "itemId", "in": "path", "description": "Selected item Id", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "cards": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "attachment_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "label_count": { "type": "integer" }, "cards_user_count": { "type": "integer" }, "cards_subscriber_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "user_id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "comment_count": { "type": "integer" }, "custom_fields": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "options": { "type": "integer" }, "label": { "type": "string" }, "position": { "type": "integer" } } }, "color": { "type": "string" }, "cards_checklists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "name": { "type": "string" }, "checklist_item_count": { "type": "string" }, "checklist_item_completed_count": { "type": "integer" }, "position": { "type": "integer" } } }, "cards_users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_voters": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "cards_labels": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "card_id": { "type": "integer" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/users/{userId}.json": { "post": { "tags": [ "cards" ], "summary": "Assign member to card", "description": "Assign member to card", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "userId", "in": "path", "description": "Selected user ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Assign member to card", "required": true, "schema": { "properties": { "board_id": { "type": "integer" }, "initials": { "type": "string" }, "is_offline": { "type": "boolean", "default": true }, "list_id": { "type": "integer" }, "profile_picture_path": { "type": "string" }, "username": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "cards": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "attachment_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "label_count": { "type": "integer" }, "cards_user_count": { "type": "integer" }, "cards_subscriber_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "user_id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "comment_count": { "type": "integer" }, "custom_fields": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "options": { "type": "integer" }, "label": { "type": "string" }, "position": { "type": "integer" } } }, "color": { "type": "string" }, "cards_checklists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "name": { "type": "string" }, "checklist_item_count": { "type": "string" }, "checklist_item_completed_count": { "type": "integer" }, "position": { "type": "integer" } } }, "cards_users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_voters": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "string" }, "card_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "cards_labels": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "card_id": { "type": "integer" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } } } } } }, "delete": { "tags": [ "cards" ], "summary": "Deletes a cardUser", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "card id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "userId", "in": "path", "description": "User id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/copy.json": { "post": { "tags": [ "cards" ], "summary": "Copy card", "description": "Copy card", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "Selected list ID", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "Selected card ID", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Copy card", "required": true, "schema": { "properties": { "copied_card_id": { "type": "integer" }, "keep_activities": { "type": "boolean", "default": true }, "keep_attachments": { "type": "boolean", "default": true }, "keep_checklists": { "type": "boolean", "default": true }, "keep_labels": { "type": "boolean", "default": true }, "keep_users": { "type": "boolean", "default": true }, "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "cards": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "description": { "type": "string" }, "due_date": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "boolean", "default": false }, "attachment_count": { "type": "integer" }, "checklist_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "checklist_item_completed_count": { "type": "integer" }, "label_count": { "type": "integer" }, "cards_user_count": { "type": "integer" }, "cards_subscriber_count": { "type": "integer" }, "card_voter_count": { "type": "integer" }, "activity_count": { "type": "integer" }, "user_id": { "type": "integer" }, "is_deleted": { "type": "integer" }, "comment_count": { "type": "integer" }, "custom_fields": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "type": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "options": { "type": "integer" }, "label": { "type": "string" }, "position": { "type": "integer" } } }, "color": { "type": "string" }, "cards_checklists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "name": { "type": "string" }, "checklist_item_count": { "type": "string" }, "checklist_item_completed_count": { "type": "integer" }, "position": { "type": "integer" } } }, "cards_users": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_voters": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" } } }, "cards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "card_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "cards_labels": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "label_id": { "type": "integer" }, "card_id": { "type": "integer" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" } } }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } } } }, "405": { "description": "Invalid input" } } } }, "/v1/organizations/{organizationId}/users/{userId}.json": { "post": { "tags": [ "organizations" ], "summary": "Added users for organizations", "description": "Added user the Organization", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "Organization id to post", "required": true, "type": "integer", "format": "int64" }, { "name": "userId", "in": "path", "description": "UserId id to post", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "405": { "description": "Validation exception" } } } }, "/v1/organizations/{organizationId}/upload_logo.json": { "post": { "tags": [ "organizations" ], "summary": "Add a new organizations to the store", "description": "Upload logo", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "Organization id to update", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/custom_fields/update_position.json": { "put": { "tags": [ "custom_fields" ], "summary": "Update custom field position", "description": "Update custom field position", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "The transaltion JSON you want to post", "required": true, "schema": { "properties": { "custom_field": { "type": "array", "items": { "type": "object", "properties": { "custom_field_id": { "type": "integer", "format": "int64" }, "position": { "type": "integer", "format": "int64" } } } } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/roles.json": { "post": { "tags": [ "roles" ], "summary": "Add a new role to the store", "description": "Created a role", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created Role object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/board_user_roles.json": { "post": { "tags": [ "board_user_roles" ], "summary": "Add a board user roles", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created board user role object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "405": { "description": "Invalid input" } } } }, "/v1/organization_user_roles.json": { "post": { "tags": [ "organization_user_roles" ], "summary": "Add a new organization user roles", "description": "Created a organization user roles", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created organization user role object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/oauth/token.json": { "post": { "tags": [ "users" ], "summary": "Get token", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "body", "in": "body", "description": "oauthToken", "required": true, "schema": { "properties": { "code": { "type": "string" }, "redirect_uri": { "type": "string" } } } } ], "responses": { "405": { "description": "Invalid input" } } } }, "/v1/users/{userId}/activation.json": { "put": { "tags": [ "users" ], "summary": "User activation", "description": "Update the users details", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "Selected user ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "email": { "type": "string" }, "is_agree_terms_and_conditions": { "type": "string" }, "password": { "type": "string" }, "username": { "type": "string" } } } }, "404": { "description": "User not found" } } } }, "/v1/oauth/clients/{clientId}.json": { "put": { "tags": [ "oauth_clients" ], "summary": "Update an existing Client", "description": "Update the Cliene", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "clientId", "in": "path", "description": "client id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created client object", "required": true, "schema": { "properties": { "client_name": { "type": "string" }, "client_url": { "type": "string" }, "logo_url": { "type": "string" }, "policy_url": { "type": "string" }, "redirect_uris": { "type": "string" }, "tos_url": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "oauth_clients" ], "summary": "Deletes a client", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "clientId", "in": "path", "description": "client id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards_users/{boardUserId}.json": { "put": { "tags": [ "boards" ], "summary": "Update board member permissions", "description": "Update board member permissions", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardUserId", "in": "path", "description": "ID of Board user that needs to be update", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "404": { "description": "Page not found" }, "405": { "description": "Invalid ID supplied" } } } }, "/v1/boards/{boardId}/lists/{listId}.json": { "put": { "tags": [ "lists" ], "summary": "Update an existing webhooks", "description": "Update the webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Update list object", "required": true, "schema": { "properties": { "is_archive": { "type": "boolean", "default": false }, "name": { "type": "string" }, "position": { "type": "string" } } } } ], "responses": { "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "lists" ], "summary": "Deletes a list", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/comments/{commentId}.json": { "put": { "tags": [ "comments" ], "summary": "Update a comment", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "card id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "commentId", "in": "path", "description": "commentId to deupdatelete", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Update comment object", "required": true, "schema": { "properties": { "comment": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "comments" ], "summary": "Deletes a comment", "description": "Delete a comment", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "listId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "commentId", "in": "path", "description": "commentId to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists/{checklistId}.json": { "put": { "tags": [ "checklists" ], "summary": "Update an existing checklists", "description": "Update the checklists", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "boardId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "listId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistId", "in": "path", "description": "checklistId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Update checklists object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "checklists" ], "summary": "Deletes a checklists", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistId", "in": "path", "description": "checklistId to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists/{checklistId}/checklistItems/{checklistItemId}": { "put": { "tags": [ "checklist_tems" ], "summary": "Update an existing checklistItem", "description": "Update the checklistItem", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "boardId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "listId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistId", "in": "path", "description": "checklistId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistItemId", "in": "path", "description": "checklistItemId to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Update checklists object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" }, "difference": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/activities/undo/{activityId}.json": { "put": { "tags": [ "activities_listing" ], "summary": "Undo activities", "description": "Update the activities", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "activityId", "in": "path", "description": "activityId to undo", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/board_subscribers/{boardSubscriberId}.json": { "put": { "tags": [ "boards" ], "summary": "Update an existing webhooks", "description": "Update the webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "ID of Board that needs Unsubscribe from the Board", "required": true, "type": "integer", "format": "int64" }, { "name": "boardSubscriberId", "in": "path", "description": "ID of User that needs to Unsubscribe from the Board", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "405": { "description": "Invalid Input" } } } }, "/v1/boards/{boardId}/lists/{listId}/list_subscribers/{listSubscriberId}.json": { "put": { "tags": [ "lists" ], "summary": "Update an existing webhooks", "description": "Update the webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "listSubscriberId", "in": "path", "description": "listSubscriber Id to update", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/organizations_users/{organizationUserId}.json": { "put": { "tags": [ "organizations" ], "summary": "Update an existing organizationUser", "description": "Update the organizationUser", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationUserId", "in": "path", "description": "Organization ID to get listing", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Change Member Permission", "required": true, "schema": { "properties": { "is_admin": { "type": "boolean", "default": false }, "user_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/webhooks/{webhooksId}.json": { "put": { "tags": [ "webhooks" ], "summary": "Update an existing webhooks", "description": "Update the webhook", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "webhooksId", "in": "path", "description": "Webhook id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created webhook object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "is_active": { "type": "boolean", "default": false }, "description": { "type": "string" }, "secret": { "type": "string" }, "url": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "webhooks" ], "summary": "Deletes a webhook", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "webhooksId", "in": "path", "description": "hook id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/roles/{roleId}.json": { "put": { "tags": [ "roles" ], "summary": "Updating a Role", "description": "Update a role", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "roleId", "in": "path", "description": "Role id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Edit Role", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "Sucess": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "roles" ], "summary": "Deletes a webhook", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "roleId", "in": "path", "description": "role id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/board_user_roles/{boardUserRoleId}.json": { "put": { "tags": [ "board_user_roles" ], "summary": "Edit board user role", "description": "Update the board user role", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardUserRoleId", "in": "path", "description": "Board user role to edit", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Edit edit board user role object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "success": { "type": "string" } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } }, "delete": { "tags": [ "board_user_roles" ], "summary": "Deletes a webhook", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardUserRoleId", "in": "path", "description": "board user id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/organization_user_roles/{organizationUserRoleId}": { "put": { "tags": [ "organization_user_roles" ], "summary": "Updating a organization user roles", "description": "Update a organization user roles", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationUserRoleId", "in": "path", "description": "Organization User Role Id to update", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Organization User Role Object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "Sucess": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/organizations/{organizationId}/organizations_users/{organizationUserId}.json": { "delete": { "tags": [ "organizations" ], "summary": "Deletes a organizationUser", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationId", "in": "path", "description": "organization id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "organizationUserId", "in": "path", "description": "organizationUser id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/boards_users/{boardUserId}": { "delete": { "tags": [ "boards" ], "summary": "Deletes a organizationUser", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "boardUserId", "in": "path", "description": "boardUser id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/cards.json": { "delete": { "tags": [ "cards" ], "summary": "Deletes a cards", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/labels/{labelId}.json": { "delete": { "tags": [ "boards" ], "summary": "Delete the label", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "labelId", "in": "path", "description": "label id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/card_voters/{cardVoterId}.json": { "delete": { "tags": [ "card_voters" ], "summary": "Deletes a cardVoter", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "boardId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "listId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardVoterId", "in": "path", "description": "cardVoterId to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/attachments/{attachmentId}.json": { "delete": { "tags": [ "cards" ], "summary": "Remove attachment from card", "description": "Remove attachment from card", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Board ID to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list ID to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "card ID to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "attachmentId", "in": "path", "description": "Attachment ID to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/checklists/{checklistId}/checklistItems/{checklistItemId}.json": { "delete": { "tags": [ "checklist_tems" ], "summary": "Deletes a checklistItem", "description": "Delete a checklistItem", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "cardId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistId", "in": "path", "description": "checklistId to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "checklistItemId", "in": "path", "description": "checklistItemId to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } } } } }, "/v1/boards/{boardId}/lists/{listId}/cards/{cardId}/cards_users/{cardUserId}.json": { "delete": { "tags": [ "organizations" ], "summary": "Deletes a cardUser", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "board id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "listId", "in": "path", "description": "list id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardId", "in": "path", "description": "card id to delete", "required": true, "type": "integer", "format": "int64" }, { "name": "cardUserId", "in": "path", "description": "cardUser id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "activities": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" }, "board_name": { "type": "string" }, "list_name": { "type": "string" }, "card_name": { "type": "string" }, "username": { "type": "string" }, "full_name": { "type": "string" }, "profile_picture_path": { "type": "string" }, "initials": { "type": "string" }, "label_name": { "type": "string" }, "card_description": { "type": "string" }, "user_role_id": { "type": "integer" }, "checklist_item_name": { "type": "string" }, "checklist_item_parent_name": { "type": "string" }, "checklist_name": { "type": "string" }, "organization_name": { "type": "string" }, "organization_logo_url": { "type": "string" }, "moved_list_name": { "type": "string" }, "created_time": { "type": "string" }, "card_position": { "type": "string" }, "comment_count": { "type": "integer" } } }, "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/oauth/applications/{applicationId}.json": { "delete": { "tags": [ "oauth_applications" ], "summary": "Deletes a client application", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "applicationId", "in": "path", "description": "application Id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 }, "message": { "type": "string" } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/organization_user_roles/{organizationUserRoleId}.json": { "delete": { "tags": [ "organization_user_roles" ], "summary": "Deletes a webhook", "description": "", "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "organizationUserRoleId", "in": "path", "description": "organizationUser id to delete", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "error": { "properties": { "code": { "type": "number", "default": 0 } } } } } }, "400": { "description": "Invalid ID supplied" }, "404": { "description": "Page not found" } } } }, "/v1/boards/{boardId}/chat_history.json": { "get": { "tags": [ "boards" ], "summary": "View board chat history", "description": "Returns a Board based on ID", "consumes": [ "application/json", "application/xml" ], "produces": [ "application/xml", "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "boardId", "in": "path", "description": "Selected board ID", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "organization_id": { "type": "integer" }, "board_visibility": { "type": "integer" }, "background_color": { "type": "integer" }, "background_picture_url": { "type": "string" }, "commenting_permissions": { "type": "integer" }, "voting_permissions": { "type": "integer" }, "inivitation_permissions": { "type": "integer" }, "is_closed": { "type": "integer" }, "is_allow_organization_members_to_join": { "type": "integer" }, "boards_user_count": { "type": "integer" }, "list_count": { "type": "integer" }, "card_count": { "type": "integer" }, "boards_subscriber_count": { "type": "integer" }, "background_pattern_url": { "type": "string" }, "boards_star_count": { "type": "integer" }, "is_show_image_front_of_card": { "type": "integer" }, "background_picture_path": { "type": "string" }, "music_name": { "type": "string" }, "music_content": { "type": "string" }, "archived_list_count": { "type": "integer" }, "archived_card_count": { "type": "integer" }, "organization_name": { "type": "string" }, "organization_website_url": { "type": "string" }, "organization_description": { "type": "string" }, "organization_logo_url": { "type": "string" }, "organization_visibility": { "type": "string" }, "activities": { "properties": { "id": { "type": "string" }, "created": { "type": "string" }, "modified": { "type": "string" }, "board_id": { "type": "integer" }, "list_id": { "type": "integer" }, "card_id": { "type": "integer" }, "user_id": { "type": "integer" }, "foreign_id": { "type": "integer" }, "type": { "type": "string" }, "comment": { "type": "string" }, "revisions": { "type": "string" }, "root": { "type": "integer" }, "freshness_ts": { "type": "string" }, "depth": { "type": "integer" }, "path": { "type": "string" }, "materialized_path": { "type": "string" }, "organization_id": { "type": "integer" } } }, "boards_subscribers": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_subscribed": { "type": "integer" } } }, "boards_stars": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "is_starred": { "type": "integer" } } }, "lists": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "name": { "type": "string" }, "position": { "type": "integer" }, "is_archived": { "type": "integer" }, "card_count": { "type": "integer" }, "lists_subscriber_count": { "type": "integer" }, "is_deleted": { "type": "integer" }, "custom_fields": { "type": "string" }, "color": { "type": "string" } } }, "boards_user": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "user_id": { "type": "integer" }, "board_id": { "type": "integer" }, "board_user_role_id": { "type": "integer" } } }, "default_email_list_id": { "type": "integer" }, "is_default_email_position_as_bottom": { "type": "integer" }, "custom_fields": { "type": "string" } } } } } } }, "/v1/search.json": { "get": { "tags": [ "boards" ], "summary": "Elastic search", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "q", "in": "query", "description": "board name to fetch", "required": false, "type": "string" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "cards": { "properties": { "name": { "type": "string" }, "list_id": { "type": "integer" }, "list_name": { "type": "string" }, "board_id": { "type": "integer" }, "board_name": { "type": "string" }, "attachment_count": { "type": "string" }, "due_date": { "type": "string" }, "comment_count": { "type": "integer" }, "type": { "type": "string" }, "checklist_item_completed_count": { "type": "integer" }, "checklist_item_count": { "type": "integer" }, "vote_count": { "type": "integer" }, "description": { "type": "string" }, "highlight": { "type": "string" } } } } } }, "400": { "description": "Invalid input" } } } }, "/v1/users/import.json": { "post": { "tags": [ "users" ], "summary": "Import Users", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "file", "in": "formData", "description": "Upload File.", "required": false, "type": "file" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": {} } }, "405": { "description": "Invalid input" } } } }, "/v1/broadcasts.json": { "get": { "tags": [ "broadcasts" ], "summary": "Add a new broadcasts to the card", "description": "Created broadcasts", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "message": { "type": "string" }, "broadcast_end_date": { "type": "string" }, "is_broadcast": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "broadcasts" ], "summary": "Add a new broadcasts to the card", "description": "Created broadcasts", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "message": { "type": "string" }, "broadcast_end_date": { "type": "string" }, "is_broadcast": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "message": { "type": "string" }, "broadcast_end_date": { "type": "string" }, "is_broadcast": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/broadcasts/{broadcastId}.json": { "get": { "tags": [ "broadcasts" ], "summary": "Put broadcasts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "broadcastId", "in": "path", "description": "ID of broadcast that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "broadcasts" ], "summary": "Put broadcasts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "broadcastId", "in": "path", "description": "ID of broadcast that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "message": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "broadcasts" ], "summary": "delete broadcasts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "broadcastId", "in": "path", "description": "ID of broadcast that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/me/broadcasts.json": { "get": { "tags": [ "broadcasts" ], "summary": "View broadcasts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/groups.json": { "get": { "tags": [ "groups" ], "summary": "Add a new groups to the card", "description": "Created groups", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "groups" ], "summary": "Add a new groups to the card", "description": "Created groups", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/groups/{groupId}.json": { "get": { "tags": [ "groups" ], "summary": "Put groups", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "ID of groups that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "groups" ], "summary": "Put groups", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "ID of groups that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "groups" ], "summary": "delete groups", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "groupId", "in": "path", "description": "ID of groups that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/groups_users.json": { "post": { "tags": [ "groups" ], "summary": "View groups_users", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "group_id": { "type": "integer" }, "user_id": { "type": "integer" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/groups/{groupId}/users/{userId}.json": { "delete": { "tags": [ "groups" ], "summary": "Put groups", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "userId", "in": "path", "description": "ID of userId that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "groupId", "in": "path", "description": "ID of groups that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/card_diagrams.json": { "get": { "tags": [ "card_diagrams" ], "summary": "Add a new card_diagrams to the card", "description": "Created card_diagrams", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "card_diagrams" ], "summary": "Add a new card_diagrams to the card", "description": "Created card_diagrams", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, { "name": "attachment", "in": "formData", "description": "Upload File.", "required": false, "type": "file" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/card_diagrams/{cardDiagramId}.json": { "get": { "tags": [ "card_diagrams" ], "summary": "Put card_diagrams", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "cardDiagramId", "in": "path", "description": "ID of card that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "card_diagrams" ], "summary": "Put card_diagrams", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "cardDiagramId", "in": "path", "description": "ID of card_diagrams that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "card_diagrams" ], "summary": "delete card_diagrams", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "cardDiagramId", "in": "path", "description": "ID of card that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "board_id": { "type": "string" }, "list_id": { "type": "string" }, "card_id": { "type": "string" }, "parent_id": { "type": "string" }, "path": { "type": "string" }, "version": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/pages.json": { "get": { "tags": [ "pages" ], "summary": "Add a new pages", "description": "Created pages", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "pages" ], "summary": "Add a new pages", "description": "Created pages", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/pages/{pagesId}.json": { "get": { "tags": [ "pages" ], "summary": "Put pages", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "pagesId", "in": "path", "description": "ID of card that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "pages" ], "summary": "Put pages", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "pagesId", "in": "path", "description": "ID of pages that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "title": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "pages" ], "summary": "delete pages", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "pagesId", "in": "path", "description": "ID of pages that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "title": { "type": "string" }, "user_id": { "type": "string" }, "parent_id": { "type": "string" }, "description": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/contacts.json": { "get": { "tags": [ "contacts" ], "summary": "Add a new contacts", "description": "Created contacts", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "post": { "tags": [ "contacts" ], "summary": "Add a new contacts", "description": "Created contacts", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "contact_custom_field": { "type": "array", "items": { "type": "object", "properties": { "custom_field_id": { "type": "integer", "format": "int64" }, "value": { "type": "string" } } } } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } }, "/v1/contacts/{contactsId}.json": { "get": { "tags": [ "contacts" ], "summary": "Put contacts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "contactsId", "in": "path", "description": "ID of card that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "put": { "tags": [ "contacts" ], "summary": "Put contacts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "contactsId", "in": "path", "description": "ID of contacts that needs to be fetched", "required": true, "type": "integer", "format": "int64" }, { "name": "body", "in": "body", "description": "Created comment object", "required": true, "schema": { "properties": { "name": { "type": "string" }, "email": { "type": "string" }, "contact_custom_field": { "type": "array", "items": { "type": "object", "properties": { "custom_field_id": { "type": "integer", "format": "int64" }, "value": { "type": "string" } } } } } } } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" } } } }, "405": { "description": "Invalid input" } } }, "delete": { "tags": [ "contacts" ], "summary": "delete contacts", "description": "", "produces": [ "application/json" ], "parameters": [ { "name": "token", "in": "query", "description": "OAuth token", "required": true, "type": "string", "items": { "type": "string" } }, { "name": "contactsId", "in": "path", "description": "ID of contacts that needs to be fetched", "required": true, "type": "integer", "format": "int64" } ], "responses": { "200": { "description": "successful operation", "schema": { "properties": { "id": { "type": "integer" }, "created": { "type": "string" }, "modified": { "type": "string" }, "name": { "type": "string" }, "user_id": { "type": "string" }, "email": { "type": "string" } } } }, "405": { "description": "Invalid input" } } } } } }