{ "openapi": "3.0.1", "info": { "title": "ConnectWise PSA API - ResolutionFlow Integration Reference", "description": "Extracted subset of the ConnectWise PSA OpenAPI spec (v2025.16) containing only endpoints and schemas relevant to ResolutionFlow's PSA integration. Covers: Service Tickets, Notes, Companies, Contacts, Configurations, Boards, Callbacks, Documents, Members, Time Entries, Knowledge Base, Projects, Workflows, Activities, Agreements, SLAs, and Schedules.", "version": "2025.16", "original_title": "Connectwise Manage Public Endpoints" }, "servers": [ { "url": "http://cloud.na.myconnectwise.net/2025.16/apis/3.0" } ], "paths": { "/company/communicationTypes": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of CommunicationType", "operationId": "getCompanyCommunicationTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "post": { "tags": [ "CommunicationTypes" ], "summary": "Post CommunicationType", "operationId": "postCompanyCommunicationTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "communicationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } }, "required": true }, "responses": { "201": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "/company/communicationTypes/count": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get Count of Usage", "operationId": "getCompanyCommunicationTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/communicationTypes/info": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get List of CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CommunicationTypeInfos", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CommunicationTypeInfo" } } } } } } } }, "/company/communicationTypes/info/count": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get Count of CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/communicationTypes/{id}": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get CommunicationType", "operationId": "getCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } }, "delete": { "tags": [ "CommunicationTypes" ], "summary": "Delete CommunicationType", "operationId": "deleteCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CommunicationTypes" ], "summary": "Put CommunicationType", "operationId": "putCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "communicationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } }, "required": true }, "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } }, "patch": { "tags": [ "CommunicationTypes" ], "summary": "Patch CommunicationType", "operationId": "patchCompanyCommunicationTypesById", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CommunicationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CommunicationType" } } } } } } }, "/company/communicationTypes/{id}/info": { "get": { "tags": [ "CommunicationTypeInfo" ], "summary": "Get CommunicationTypeInfos", "operationId": "getCompanyCommunicationTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "AddressFormatInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CommunicationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CommunicationTypeInfo" } } } } } } }, "/company/communicationTypes/{id}/usages": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCommunicationTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/communicationTypes/{id}/usages/list": { "get": { "tags": [ "CommunicationTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyCommunicationTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "communicationTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies": { "get": { "tags": [ "Companies" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompanies", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company" } } } } } } }, "post": { "tags": [ "Companies" ], "summary": "Post ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "postCompanyCompanies", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "company", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "required": true }, "responses": { "201": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/count": { "get": { "tags": [ "Companies" ], "summary": "Get Count of ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/default": { "get": { "tags": [ "Companies" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/info": { "get": { "tags": [ "CompanyInfos" ], "summary": "Get List of CompanyInfos", "operationId": "getCompanyCompaniesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of companyInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyInfo" } } } } } } } }, "/company/companies/info/count": { "get": { "tags": [ "CompanyInfos" ], "summary": "Get Count of CompanyInfos", "operationId": "getCompanyCompaniesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/info/types": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get List of CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeInfo" } } } } } } } }, "/company/companies/info/types/count": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get Count of CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/info/types/{id}": { "get": { "tags": [ "CompanyTypeInfos" ], "summary": "Get CompanyTypeInfo", "operationId": "getCompanyCompaniesInfoTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyTypeInfo" } } } } } } }, "/company/companies/statuses": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of CompanyStatus", "operationId": "getCompanyCompaniesStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "post": { "tags": [ "CompanyStatuses" ], "summary": "Post CompanyStatus", "operationId": "postCompanyCompaniesStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } }, "required": true }, "responses": { "201": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "/company/companies/statuses/count": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get Count of CompanyStatus", "operationId": "getCompanyCompaniesStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/statuses/{id}": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get CompanyStatus", "operationId": "getCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } }, "delete": { "tags": [ "CompanyStatuses" ], "summary": "Delete CompanyStatus", "operationId": "deleteCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyStatuses" ], "summary": "Put CompanyStatus", "operationId": "putCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } }, "required": true }, "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } }, "patch": { "tags": [ "CompanyStatuses" ], "summary": "Patch CompanyStatus", "operationId": "patchCompanyCompaniesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyStatus" } } } } } } }, "/company/companies/statuses/{id}/usages": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/statuses/{id}/usages/list": { "get": { "tags": [ "CompanyStatuses" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/types": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of CompanyType", "operationId": "getCompanyCompaniesTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "post": { "tags": [ "CompanyTypes" ], "summary": "Post CompanyType", "operationId": "postCompanyCompaniesTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyType" } } }, "required": true }, "responses": { "201": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "/company/companies/types/count": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get Count of CompanyType", "operationId": "getCompanyCompaniesTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/types/{id}": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get CompanyType", "operationId": "getCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } }, "delete": { "tags": [ "CompanyTypes" ], "summary": "Delete Usage", "operationId": "deleteCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTypes" ], "summary": "Put CompanyType", "operationId": "putCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyType" } } }, "required": true }, "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } }, "patch": { "tags": [ "CompanyTypes" ], "summary": "Patch CompanyType", "operationId": "patchCompanyCompaniesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyType" } } } } } } }, "/company/companies/types/{id}/usages": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/types/{id}/usages/list": { "get": { "tags": [ "CompanyTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{id}": { "get": { "tags": [ "Companies" ], "summary": "Get ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "getCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "delete": { "tags": [ "Companies" ], "summary": "Delete ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "deleteCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Companies" ], "summary": "Put ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "putCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "company", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company" } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company" } } } } } }, "patch": { "tags": [ "Companies" ], "summary": "Patch ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "operationId": "patchCompanyCompaniesById", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConnectWise.Apis.v3_0.v2015_3.Company.Company.Company", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company" } } } } } } }, "/company/companies/{id}/merge": { "post": { "tags": [ "Companies" ], "summary": "Post SuccessResponse", "operationId": "postCompanyCompaniesByIdMerge", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "merge", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyMerge" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/company/companies/{id}/usages": { "get": { "tags": [ "Companies" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{id}/usages/list": { "get": { "tags": [ "Companies" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/customStatusNotes": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get List of CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "post": { "tags": [ "CompanyCustomNotes" ], "summary": "Post CompanyCustomNote", "operationId": "postCompanyCompaniesByParentIdCustomStatusNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } }, "required": true }, "responses": { "201": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "/company/companies/{parentId}/customStatusNotes/count": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get Count of CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/customStatusNotes/{id}": { "get": { "tags": [ "CompanyCustomNotes" ], "summary": "Get CompanyCustomNote", "operationId": "getCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } }, "delete": { "tags": [ "CompanyCustomNotes" ], "summary": "Delete CompanyCustomNote", "operationId": "deleteCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyCustomNotes" ], "summary": "Put CompanyCustomNote", "operationId": "putCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "customNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } }, "required": true }, "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } }, "patch": { "tags": [ "CompanyCustomNotes" ], "summary": "Patch CompanyCustomNote", "operationId": "patchCompanyCompaniesByParentIdCustomStatusNotesById", "parameters": [ { "name": "id", "in": "path", "description": "customStatusNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyCustomNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCustomNote" } } } } } } }, "/company/companies/{parentId}/groups": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get List of CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "post": { "tags": [ "CompanyGroups" ], "summary": "Post CompanyGroup", "operationId": "postCompanyCompaniesByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } }, "required": true }, "responses": { "201": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "/company/companies/{parentId}/groups/count": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get Count of CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/groups/{id}": { "get": { "tags": [ "CompanyGroups" ], "summary": "Get CompanyGroup", "operationId": "getCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } }, "delete": { "tags": [ "CompanyGroups" ], "summary": "Delete CompanyGroup", "operationId": "deleteCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyGroups" ], "summary": "Put CompanyGroup", "operationId": "putCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } }, "required": true }, "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } }, "patch": { "tags": [ "CompanyGroups" ], "summary": "Patch CompanyGroup", "operationId": "patchCompanyCompaniesByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyGroup" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get List of ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "post": { "tags": [ "ManagementReportNotifications" ], "summary": "Post ManagementReportNotification", "operationId": "postCompanyCompaniesByParentIdManagementReportNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "201": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications/count": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get Count of ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/managementReportNotifications/{id}": { "get": { "tags": [ "ManagementReportNotifications" ], "summary": "Get ManagementReportNotification", "operationId": "getCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "delete": { "tags": [ "ManagementReportNotifications" ], "summary": "Delete ManagementReportNotification", "operationId": "deleteCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ManagementReportNotifications" ], "summary": "Put ManagementReportNotification", "operationId": "putCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } }, "patch": { "tags": [ "ManagementReportNotifications" ], "summary": "Patch ManagementReportNotification", "operationId": "patchCompanyCompaniesByParentIdManagementReportNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportNotificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementReportNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportNotification" } } } } } } }, "/company/companies/{parentId}/managementReportSetup": { "get": { "tags": [ "ManagementReportSetups" ], "summary": "Get List of ManagementReportSetup", "operationId": "getCompanyCompaniesByParentIdManagementReportSetup", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "post": { "tags": [ "ManagementReportSetups" ], "summary": "Post ManagementReportSetup", "operationId": "postCompanyCompaniesByParentIdManagementReportSetup", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } }, "required": true }, "responses": { "201": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "/company/companies/{parentId}/managementReportSetup/{id}": { "put": { "tags": [ "ManagementReportSetups" ], "summary": "Put ManagementReportSetup", "operationId": "putCompanyCompaniesByParentIdManagementReportSetupById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementReportSetup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } }, "required": true }, "responses": { "200": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } }, "patch": { "tags": [ "ManagementReportSetups" ], "summary": "Patch ManagementReportSetup", "operationId": "patchCompanyCompaniesByParentIdManagementReportSetupById", "parameters": [ { "name": "id", "in": "path", "description": "managementReportSetupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ManagementReportSetup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ManagementReportSetup" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get List of CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReports", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "post": { "tags": [ "CompanyManagementSummarys" ], "summary": "Post CompanyManagementSummary", "operationId": "postCompanyCompaniesByParentIdManagementSummaryReports", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementSummary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } }, "required": true }, "responses": { "201": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports/count": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get Count of CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReportsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/managementSummaryReports/{id}": { "get": { "tags": [ "CompanyManagementSummarys" ], "summary": "Get CompanyManagementSummary", "operationId": "getCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } }, "delete": { "tags": [ "CompanyManagementSummarys" ], "summary": "Delete CompanyManagementSummary", "operationId": "deleteCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyManagementSummarys" ], "summary": "Put CompanyManagementSummary", "operationId": "putCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managementSummary", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } }, "required": true }, "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } }, "patch": { "tags": [ "CompanyManagementSummarys" ], "summary": "Patch CompanyManagementSummary", "operationId": "patchCompanyCompaniesByParentIdManagementSummaryReportsById", "parameters": [ { "name": "id", "in": "path", "description": "managementSummaryReportId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyManagementSummary", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyManagementSummary" } } } } } } }, "/company/companies/{parentId}/notes": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get List of CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "post": { "tags": [ "CompanyNotes" ], "summary": "Post CompanyNote", "operationId": "postCompanyCompaniesByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } }, "required": true }, "responses": { "201": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "/company/companies/{parentId}/notes/count": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get Count of CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/notes/{id}": { "get": { "tags": [ "CompanyNotes" ], "summary": "Get CompanyNote", "operationId": "getCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } }, "delete": { "tags": [ "CompanyNotes" ], "summary": "Delete CompanyNote", "operationId": "deleteCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyNotes" ], "summary": "Put CompanyNote", "operationId": "putCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } }, "required": true }, "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } }, "patch": { "tags": [ "CompanyNotes" ], "summary": "Patch CompanyNote", "operationId": "patchCompanyCompaniesByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNote" } } } } } } }, "/company/companies/{parentId}/serviceTemplates": { "get": { "tags": [ "CompanyServiceTemplates" ], "summary": "Get List of CompanyServiceTemplate", "operationId": "getCompanyCompaniesByParentIdServiceTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyServiceTemplate" } } } } } } }, "post": { "tags": [ "CompanyServiceTemplates" ], "summary": "Post CompanyServiceTemplate", "operationId": "postCompanyCompaniesByParentIdServiceTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/company/companies/{parentId}/serviceTemplates/count": { "get": { "tags": [ "CompanyServiceTemplates" ], "summary": "Get Count of CompanyServiceTemplate", "operationId": "getCompanyCompaniesByParentIdServiceTemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/serviceTemplates/{id}": { "get": { "tags": [ "CompanyServiceTemplates" ], "summary": "Get a specific CompanyServiceTemplate", "operationId": "getCompanyCompaniesByParentIdServiceTemplatesById", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "put": { "tags": [ "CompanyServiceTemplates" ], "summary": "Put CompanyServiceTemplate", "operationId": "putCompanyCompaniesByParentIdServiceTemplatesById", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ServiceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "patch": { "tags": [ "CompanyServiceTemplates" ], "summary": "Patch CompanyServiceTemplate", "operationId": "patchCompanyCompaniesByParentIdServiceTemplatesById", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "delete": { "tags": [ "CompanyServiceTemplates" ], "summary": "Delete CompanyServiceTemplate", "operationId": "deleteCompanyCompaniesByParentIdServiceTemplatesById", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/companies/{parentId}/serviceTemplates/{id}/copy": { "post": { "tags": [ "CompanyServiceTemplates" ], "summary": "Create a Copied CompanyServiceTemplate", "operationId": "postCompanyCompaniesByParentIdServiceTemplatesByIdCopy", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/company/companies/{parentId}/serviceTemplates/{id}/generate": { "post": { "tags": [ "CompanyServiceTemplates" ], "summary": "Post Count of CompanyServiceTemplate", "operationId": "postCompanyCompaniesByParentIdServiceTemplatesByIdGenerate", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "templateGenerate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateGenerate" } } }, "required": true }, "responses": { "200": { "description": "TemplateGeneratedCountsModel", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TemplateGeneratedCountsModel" } } } } } } }, "/company/companies/{parentId}/serviceTemplates/{id}/link": { "post": { "tags": [ "CompanyServiceTemplates" ], "summary": "Create a Linked CompanyServiceTemplate", "operationId": "postCompanyCompaniesByParentIdServiceTemplatesByIdLink", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/company/companies/{parentId}/serviceTemplates/{id}/unlink": { "post": { "tags": [ "CompanyServiceTemplates" ], "summary": "Unlink a CompanyServiceTemplate", "operationId": "postCompanyCompaniesByParentIdServiceTemplatesByIdUnlink", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/company/companies/{parentId}/sites": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of CompanySite", "operationId": "getCompanyCompaniesByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "post": { "tags": [ "CompanySites" ], "summary": "Post CompanySite", "operationId": "postCompanyCompaniesByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySite" } } }, "required": true }, "responses": { "201": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "/company/companies/{parentId}/sites/count": { "get": { "tags": [ "CompanySites" ], "summary": "Get Count of CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/sites/info": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get List of CompanySiteInfos", "operationId": "getCompanyCompaniesByParentIdSitesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of companySiteInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanySiteInfo" } } } } } } } }, "/company/companies/{parentId}/sites/info/count": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get Count of CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/sites/{id}": { "get": { "tags": [ "CompanySites" ], "summary": "Get CompanySite", "operationId": "getCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } }, "delete": { "tags": [ "CompanySites" ], "summary": "Delete CompanySite", "operationId": "deleteCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanySites" ], "summary": "Put CompanySite", "operationId": "putCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanySite" } } }, "required": true }, "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } }, "patch": { "tags": [ "CompanySites" ], "summary": "Patch CompanySite", "operationId": "patchCompanyCompaniesByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanySite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanySite" } } } } } } }, "/company/companies/{parentId}/sites/{id}/info": { "get": { "tags": [ "CompanySiteInfos" ], "summary": "Get CompanySiteInfos", "operationId": "getCompanyCompaniesByParentIdSitesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanySiteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanySiteInfo" } } } } } } }, "/company/companies/{parentId}/sites/{id}/usages": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of Usage Count", "operationId": "getCompanyCompaniesByParentIdSitesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/sites/{id}/usages/list": { "get": { "tags": [ "CompanySites" ], "summary": "Get List of Usage", "operationId": "getCompanyCompaniesByParentIdSitesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/companies/{parentId}/surveys/count": { "get": { "tags": [ "CompanySurveys" ], "summary": "Get Count of", "operationId": "getCompanyCompaniesByParentIdSurveysCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/teams": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get List of CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "post": { "tags": [ "CompanyTeams" ], "summary": "Post CompanyTeam", "operationId": "postCompanyCompaniesByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } }, "required": true }, "responses": { "201": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "/company/companies/{parentId}/teams/count": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get Count of CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/teams/{id}": { "get": { "tags": [ "CompanyTeams" ], "summary": "Get CompanyTeam", "operationId": "getCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } }, "delete": { "tags": [ "CompanyTeams" ], "summary": "Delete CompanyTeam", "operationId": "deleteCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyTeams" ], "summary": "Put CompanyTeam", "operationId": "putCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } }, "required": true }, "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } }, "patch": { "tags": [ "CompanyTeams" ], "summary": "Patch CompanyTeam", "operationId": "patchCompanyCompaniesByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyTeam" } } } } } } }, "/company/companies/{parentId}/tracks": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get List of ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "post": { "tags": [ "CompanyTracks" ], "summary": "Post ContactTrack", "operationId": "postCompanyCompaniesByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } }, "required": true }, "responses": { "201": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "/company/companies/{parentId}/tracks/count": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get Count of ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/tracks/{id}": { "get": { "tags": [ "CompanyTracks" ], "summary": "Get ContactTrack", "operationId": "getCompanyCompaniesByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } }, "delete": { "tags": [ "CompanyTracks" ], "summary": "Delete ContactTrack", "operationId": "deleteCompanyCompaniesByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/companies/{parentId}/typeAssociations": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get List of CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "post": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Post CompanyTypeAssociation", "operationId": "postCompanyCompaniesByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "/company/companies/{parentId}/typeAssociations/count": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get Count of CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companies/{parentId}/typeAssociations/{id}": { "get": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Get CompanyTypeAssociation", "operationId": "getCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } }, "delete": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Delete CompanyTypeAssociation", "operationId": "deleteCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Put CompanyTypeAssociation", "operationId": "putCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } }, "patch": { "tags": [ "CompanyCompanyTypeAssociations" ], "summary": "Patch CompanyTypeAssociation", "operationId": "patchCompanyCompaniesByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyCompanyTypeAssociation.CompanyTypeAssociation" } } } } } } }, "/company/companyPickerItems": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get List of CompanyPickerItem", "operationId": "getCompanyCompanyPickerItems", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } } }, "post": { "tags": [ "CompanyPickerItems" ], "summary": "Post CompanyPickerItem", "operationId": "postCompanyCompanyPickerItems", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "companyPickerItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } }, "required": true }, "responses": { "201": { "description": "CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } } }, "/company/companyPickerItems/clear": { "post": { "tags": [ "CompanyPickerItems" ], "summary": "Post ClearPickerRequest", "operationId": "postCompanyCompanyPickerItemsClear", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "clearPickerRequest", "in": "path", "description": "clearPickerRequest", "required": true, "schema": { "$ref": "#/components/schemas/ClearPickerRequest" } } ], "responses": { "204": { "description": "ClearPickerRequest", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ClearPickerRequest" } } } } } } }, "/company/companyPickerItems/count": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get Count of CompanyPickerItem", "operationId": "getCompanyCompanyPickerItemsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/companyPickerItems/{id}": { "get": { "tags": [ "CompanyPickerItems" ], "summary": "Get CompanyPickerItem", "operationId": "getCompanyCompanyPickerItemsById", "parameters": [ { "name": "id", "in": "path", "description": "companyPickerItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyPickerItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyPickerItem" } } } } } }, "delete": { "tags": [ "CompanyPickerItems" ], "summary": "Delete CompanyPickerItem", "operationId": "deleteCompanyCompanyPickerItemsById", "parameters": [ { "name": "id", "in": "path", "description": "companyPickerItemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/configurations": { "get": { "tags": [ "Configurations" ], "summary": "Get List of Configuration", "operationId": "getCompanyConfigurations", "parameters": [ { "name": "managedIdentifier", "in": "query", "description": "managedIdentifier", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "post": { "tags": [ "Configurations" ], "summary": "Post Configuration", "operationId": "postCompanyConfigurations", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } }, "required": true }, "responses": { "201": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/bulk": { "post": { "tags": [ "Configurations" ], "summary": "Post Configuration", "operationId": "postCompanyConfigurationsBulk", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } }, "required": true }, "responses": { "207": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "delete": { "tags": [ "Configurations" ], "summary": "Delete BulkResult", "operationId": "deleteCompanyConfigurationsBulk", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "put": { "tags": [ "Configurations" ], "summary": "Put Configuration", "operationId": "putCompanyConfigurationsBulk", "parameters": [ { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Configuration", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Company.Configuration" } } } }, "required": true }, "responses": { "207": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/count": { "get": { "tags": [ "Configurations" ], "summary": "Get Count of Configuration", "operationId": "getCompanyConfigurationsCount", "parameters": [ { "name": "managedIdentifier", "in": "query", "description": "managedIdentifier", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/statuses": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of ConfigurationStatus", "operationId": "getCompanyConfigurationsStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "post": { "tags": [ "ConfigurationStatuses" ], "summary": "Post ConfigurationStatus", "operationId": "postCompanyConfigurationsStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "/company/configurations/statuses/count": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get Count of ConfigurationStatus", "operationId": "getCompanyConfigurationsStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/statuses/info": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get List of ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of configurationStatusesInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationStatusInfo" } } } } } } } }, "/company/configurations/statuses/info/count": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get Count of ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/statuses/{id}": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get ConfigurationStatus", "operationId": "getCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } }, "delete": { "tags": [ "ConfigurationStatuses" ], "summary": "Delete ConfigurationStatus", "operationId": "deleteCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationStatuses" ], "summary": "Put ConfigurationStatus", "operationId": "putCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } }, "patch": { "tags": [ "ConfigurationStatuses" ], "summary": "Patch ConfigurationStatus", "operationId": "patchCompanyConfigurationsStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationStatus" } } } } } } }, "/company/configurations/statuses/{id}/info": { "get": { "tags": [ "ConfigurationStatusInfos" ], "summary": "Get ConfigurationStatusInfos", "operationId": "getCompanyConfigurationsStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ConfigurationStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationStatusInfo" } } } } } } }, "/company/configurations/statuses/{id}/usages": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of Usage Count", "operationId": "getCompanyConfigurationsStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/statuses/{id}/usages/list": { "get": { "tags": [ "ConfigurationStatuses" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of ConfigurationType", "operationId": "getCompanyConfigurationsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "post": { "tags": [ "ConfigurationTypes" ], "summary": "Post ConfigurationType", "operationId": "postCompanyConfigurationsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/copy": { "post": { "tags": [ "ConfigurationTypes" ], "summary": "Post Board", "operationId": "postCompanyConfigurationsTypesCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeCopy" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/count": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get Count of ConfigurationType", "operationId": "getCompanyConfigurationsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "post": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Post ConfigurationTypeQuestionValue", "operationId": "postCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValues", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/count": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get Count of ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get ConfigurationTypeQuestionValue", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } }, "delete": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Delete ConfigurationTypeQuestionValue", "operationId": "deleteCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Put ConfigurationTypeQuestionValue", "operationId": "putCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestionValue", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } }, "patch": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Patch ConfigurationTypeQuestionValue", "operationId": "patchCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesById", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestionValue", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestionValue" } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/usages": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{grandparentId}/questions/{parentId}/values/{id}/usages/list": { "get": { "tags": [ "ConfigurationTypeQuestionValues" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByGrandparentIdQuestionsByParentIdValuesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "valueId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{id}": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get ConfigurationType", "operationId": "getCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } }, "delete": { "tags": [ "ConfigurationTypes" ], "summary": "Delete ConfigurationType", "operationId": "deleteCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypes" ], "summary": "Put ConfigurationType", "operationId": "putCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } }, "patch": { "tags": [ "ConfigurationTypes" ], "summary": "Patch ConfigurationType", "operationId": "patchCompanyConfigurationsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationType" } } } } } } }, "/company/configurations/types/{id}/info": { "get": { "tags": [ "ConfigurationTypeInfos" ], "summary": "Get ConfigurationTypeInfos", "operationId": "getCompanyConfigurationsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ConfigurationTypeInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeInfo" } } } } } } }, "/company/configurations/types/{id}/usages": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of Usage Count", "operationId": "getCompanyConfigurationsTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{id}/usages/list": { "get": { "tags": [ "ConfigurationTypes" ], "summary": "Get List of Usage", "operationId": "getCompanyConfigurationsTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/configurations/types/{parentId}/questions": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get List of ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "post": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Post ConfigurationTypeQuestion", "operationId": "postCompanyConfigurationsTypesByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "/company/configurations/types/{parentId}/questions/count": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get Count of ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/configurations/types/{parentId}/questions/{id}": { "get": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Get ConfigurationTypeQuestion", "operationId": "getCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } }, "delete": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Delete ConfigurationTypeQuestion", "operationId": "deleteCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Put ConfigurationTypeQuestion", "operationId": "putCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configurationTypeQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } }, "patch": { "tags": [ "ConfigurationTypeQuestions" ], "summary": "Patch ConfigurationTypeQuestion", "operationId": "patchCompanyConfigurationsTypesByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ConfigurationTypeQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTypeQuestion" } } } } } } }, "/company/configurations/{id}": { "get": { "tags": [ "Configurations" ], "summary": "Get Configuration", "operationId": "getCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "delete": { "tags": [ "Configurations" ], "summary": "Delete Configuration", "operationId": "deleteCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Configurations" ], "summary": "Put Configuration", "operationId": "putCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } }, "patch": { "tags": [ "Configurations" ], "summary": "Patch Configuration", "operationId": "patchCompanyConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "managedInformation", "in": "query", "description": "managedInformation", "schema": { "$ref": "#/components/schemas/ManagedInformation" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/{id}/changeType": { "patch": { "tags": [ "Configurations" ], "summary": "Patch Configuration", "operationId": "patchCompanyConfigurationsByIdChangeType", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Configuration", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Company.Configuration" } } } } } } }, "/company/configurations/{id}/quickAccess/count": { "get": { "tags": [ "Configurations" ], "summary": "Get Configuration Tab Count", "operationId": "getCompanyConfigurationsByIdQuickAccessCount", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationTabsCount" } } } } } } }, "/company/contacts": { "get": { "tags": [ "Contacts" ], "summary": "Get List of ApiContact", "operationId": "getCompanyContacts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Contact" } } } } } } }, "post": { "tags": [ "Contacts" ], "summary": "Post ApiContact", "operationId": "postCompanyContacts", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "required": true }, "responses": { "201": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/count": { "get": { "tags": [ "Contacts" ], "summary": "Get Count of Usage", "operationId": "getCompanyContactsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/default": { "get": { "tags": [ "Contacts" ], "summary": "Get ApiContact", "operationId": "getCompanyContactsDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "companyId", "in": "path", "description": "companyId", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/departments": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of ContactDepartment", "operationId": "getCompanyContactsDepartments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "post": { "tags": [ "ContactDepartments" ], "summary": "Post ContactDepartment", "operationId": "postCompanyContactsDepartments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactDepartment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } }, "required": true }, "responses": { "201": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "/company/contacts/departments/count": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get Count of ContactDepartment", "operationId": "getCompanyContactsDepartmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/departments/info": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get List of ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of contactDepartmentInfos", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactDepartmentInfo" } } } } } } } }, "/company/contacts/departments/info/count": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get Count of ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/departments/{id}": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get ContactDepartment", "operationId": "getCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } }, "delete": { "tags": [ "ContactDepartments" ], "summary": "Delete Usage", "operationId": "deleteCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactDepartments" ], "summary": "Put ContactDepartment", "operationId": "putCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactDepartment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } }, "required": true }, "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } }, "patch": { "tags": [ "ContactDepartments" ], "summary": "Patch ContactDepartment", "operationId": "patchCompanyContactsDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactDepartment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactDepartment" } } } } } } }, "/company/contacts/departments/{id}/info": { "get": { "tags": [ "ContactDepartmentInfos" ], "summary": "Get ContactDepartmentInfos", "operationId": "getCompanyContactsDepartmentsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ContactDepartmentInfo", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactDepartmentInfo" } } } } } } }, "/company/contacts/departments/{id}/usages": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of Usage Count", "operationId": "getCompanyContactsDepartmentsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/departments/{id}/usages/list": { "get": { "tags": [ "ContactDepartments" ], "summary": "Get List of Usage", "operationId": "getCompanyContactsDepartmentsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/info": { "get": { "tags": [ "ContactInfos" ], "summary": "Get List of ContactInfos", "operationId": "getCompanyContactsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of contactInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactInfo" } } } } } } } }, "/company/contacts/info/count": { "get": { "tags": [ "ContactInfos" ], "summary": "Get Count of ContactInfos", "operationId": "getCompanyContactsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/relationships": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get List of ContactRelationship", "operationId": "getCompanyContactsRelationships", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "post": { "tags": [ "ContactRelationships" ], "summary": "Post ContactRelationship", "operationId": "postCompanyContactsRelationships", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactRelationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } }, "required": true }, "responses": { "201": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "/company/contacts/relationships/count": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get Count of ContactRelationship", "operationId": "getCompanyContactsRelationshipsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/relationships/{id}": { "get": { "tags": [ "ContactRelationships" ], "summary": "Get ContactRelationship", "operationId": "getCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } }, "delete": { "tags": [ "ContactRelationships" ], "summary": "Delete ContactRelationship", "operationId": "deleteCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactRelationships" ], "summary": "Put ContactRelationship", "operationId": "putCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactRelationship", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } }, "required": true }, "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } }, "patch": { "tags": [ "ContactRelationships" ], "summary": "Patch ContactRelationship", "operationId": "patchCompanyContactsRelationshipsById", "parameters": [ { "name": "id", "in": "path", "description": "relationshipId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactRelationship", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactRelationship" } } } } } } }, "/company/contacts/requestPassword": { "post": { "tags": [ "Contacts" ], "summary": "Post PortalSecurity", "operationId": "postCompanyContactsRequestPassword", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestPasswordRequest" } } }, "required": true }, "responses": { "204": { "description": "Email sent to email address in request." } } } }, "/company/contacts/types": { "get": { "tags": [ "ContactTypes" ], "summary": "Get List of ContactType", "operationId": "getCompanyContactsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "post": { "tags": [ "ContactTypes" ], "summary": "Post ContactType", "operationId": "postCompanyContactsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactType" } } }, "required": true }, "responses": { "201": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "/company/contacts/types/count": { "get": { "tags": [ "ContactTypes" ], "summary": "Get Count of ContactType", "operationId": "getCompanyContactsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/types/count/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get Count of ContactTypeInfo", "operationId": "getCompanyContactsTypesCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/types/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get List of ContactTypeInfo", "operationId": "getCompanyContactsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeInfo" } } } } } } } }, "/company/contacts/types/{id}": { "get": { "tags": [ "ContactTypes" ], "summary": "Get ContactType", "operationId": "getCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } }, "delete": { "tags": [ "ContactTypes" ], "summary": "Delete ContactType", "operationId": "deleteCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactTypes" ], "summary": "Put ContactType", "operationId": "putCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactType" } } }, "required": true }, "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } }, "patch": { "tags": [ "ContactTypes" ], "summary": "Patch ContactType", "operationId": "patchCompanyContactsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactType" } } } } } } }, "/company/contacts/types/{id}/info": { "get": { "tags": [ "ContactTypes" ], "summary": "Get ContactTypeInfo", "operationId": "getCompanyContactsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTypInfoe", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactTypeInfo" } } } } } } }, "/company/contacts/validatePortalCredentials": { "post": { "tags": [ "Contacts" ], "summary": "Post ValidatePortalResponse", "operationId": "postCompanyContactsValidatePortalCredentials", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidatePortalRequest" } } }, "required": true }, "responses": { "200": { "description": "ValidatePortalResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ValidatePortalResponse" } } } } } } }, "/company/contacts/{id}": { "get": { "tags": [ "Contacts" ], "summary": "Get ApiContact", "operationId": "getCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } }, "delete": { "tags": [ "Contacts" ], "summary": "Delete ApiContact", "operationId": "deleteCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "transferContactId", "in": "query", "description": "transferContactId", "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Contacts" ], "summary": "Put ApiContact", "operationId": "putCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Contact" } } }, "required": true }, "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } }, "patch": { "tags": [ "Contacts" ], "summary": "Patch ApiContact", "operationId": "patchCompanyContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Contact" } } } } } } }, "/company/contacts/{id}/image": { "get": { "tags": [ "Contacts" ], "summary": "Get ValidatePortalResponse", "operationId": "getCompanyContactsByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "useDefaultFlag", "in": "path", "description": "useDefaultFlag", "required": true, "schema": { "type": "boolean" } }, { "name": "lastModified", "in": "path", "description": "lastModified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/company/contacts/{id}/info": { "get": { "tags": [ "ContactInfos" ], "summary": "Get ContactInfos", "operationId": "getCompanyContactsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ContactInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactInfo" } } } } } } }, "/company/contacts/{id}/portalSecurity": { "get": { "tags": [ "Contacts" ], "summary": "Get List of PortalSecurity", "operationId": "getCompanyContactsByIdPortalSecurity", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PortalSecurity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PortalSecurity" } } } } } } } }, "/company/contacts/{id}/usages": { "get": { "tags": [ "Contacts" ], "summary": "Get List of Usage Count", "operationId": "getCompanyContactsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/{id}/usages/list": { "get": { "tags": [ "Contacts" ], "summary": "Get List of Usage", "operationId": "getCompanyContactsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/company/contacts/{parentId}/communications": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get List of ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunications", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "post": { "tags": [ "ContactCommunications" ], "summary": "Post ContactCommunication", "operationId": "postCompanyContactsByParentIdCommunications", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactCommunication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } }, "required": true }, "responses": { "201": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "/company/contacts/{parentId}/communications/count": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get Count of ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunicationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/communications/{id}": { "get": { "tags": [ "ContactCommunications" ], "summary": "Get ContactCommunication", "operationId": "getCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } }, "delete": { "tags": [ "ContactCommunications" ], "summary": "Delete ContactCommunication", "operationId": "deleteCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactCommunications" ], "summary": "Put ContactCommunication", "operationId": "putCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactCommunication", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } }, "required": true }, "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } }, "patch": { "tags": [ "ContactCommunications" ], "summary": "Patch ContactCommunication", "operationId": "patchCompanyContactsByParentIdCommunicationsById", "parameters": [ { "name": "id", "in": "path", "description": "communicationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactCommunication", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactCommunication" } } } } } } }, "/company/contacts/{parentId}/groups": { "get": { "tags": [ "ContactGroups" ], "summary": "Get List of ContactGroup", "operationId": "getCompanyContactsByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "post": { "tags": [ "ContactGroups" ], "summary": "Post ContactGroup", "operationId": "postCompanyContactsByParentIdGroups", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } }, "required": true }, "responses": { "201": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "/company/contacts/{parentId}/groups/count": { "get": { "tags": [ "ContactGroups" ], "summary": "Get Count of ContactGroup", "operationId": "getCompanyContactsByParentIdGroupsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/groups/{id}": { "get": { "tags": [ "ContactGroups" ], "summary": "Get ContactGroup", "operationId": "getCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } }, "delete": { "tags": [ "ContactGroups" ], "summary": "Delete ContactGroup", "operationId": "deleteCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactGroups" ], "summary": "Put ContactGroup", "operationId": "putCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactGroup", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } }, "required": true }, "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } }, "patch": { "tags": [ "ContactGroups" ], "summary": "Patch ContactGroup", "operationId": "patchCompanyContactsByParentIdGroupsById", "parameters": [ { "name": "id", "in": "path", "description": "groupId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactGroup", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactGroup" } } } } } } }, "/company/contacts/{parentId}/notes": { "get": { "tags": [ "ContactNotes" ], "summary": "Get List of ContactNote", "operationId": "getCompanyContactsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "post": { "tags": [ "ContactNotes" ], "summary": "Post ContactNote", "operationId": "postCompanyContactsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNote" } } }, "required": true }, "responses": { "201": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "/company/contacts/{parentId}/notes/count": { "get": { "tags": [ "ContactNotes" ], "summary": "Get Count of ContactNote", "operationId": "getCompanyContactsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/notes/{id}": { "get": { "tags": [ "ContactNotes" ], "summary": "Get ContactNote", "operationId": "getCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } }, "delete": { "tags": [ "ContactNotes" ], "summary": "Delete ContactNote", "operationId": "deleteCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactNotes" ], "summary": "Put ContactNote", "operationId": "putCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactNote" } } }, "required": true }, "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } }, "patch": { "tags": [ "ContactNotes" ], "summary": "Patch ContactNote", "operationId": "patchCompanyContactsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactNote" } } } } } } }, "/company/contacts/{parentId}/tracks": { "get": { "tags": [ "ContactTracks" ], "summary": "Get List of ContactTrack", "operationId": "getCompanyContactsByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "post": { "tags": [ "ContactTracks" ], "summary": "Post ContactTrack", "operationId": "postCompanyContactsByParentIdTracks", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } }, "required": true }, "responses": { "201": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } } }, "/company/contacts/{parentId}/tracks/count": { "get": { "tags": [ "ContactTracks" ], "summary": "Get Count of ContactTrack", "operationId": "getCompanyContactsByParentIdTracksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/tracks/{id}": { "get": { "tags": [ "ContactTracks" ], "summary": "Get ContactTrack", "operationId": "getCompanyContactsByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTrack", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactTrack" } } } } } }, "delete": { "tags": [ "ContactTracks" ], "summary": "Delete ContactTrack", "operationId": "deleteCompanyContactsByParentIdTracksById", "parameters": [ { "name": "id", "in": "path", "description": "trackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/company/contacts/{parentId}/typeAssociations": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get List of ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "post": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Post ContactTypeAssociation", "operationId": "postCompanyContactsByParentIdTypeAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } }, "required": true }, "responses": { "201": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "/company/contacts/{parentId}/typeAssociations/count": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get Count of ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/contacts/{parentId}/typeAssociations/{id}": { "get": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Get ContactTypeAssociation", "operationId": "getCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } }, "delete": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Delete ContactTypeAssociation", "operationId": "deleteCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Put ContactTypeAssociation", "operationId": "putCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contactTypeAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } }, "patch": { "tags": [ "ContactContactTypeAssociations" ], "summary": "Patch ContactTypeAssociation", "operationId": "patchCompanyContactsByParentIdTypeAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ContactTypeAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ContactContactTypeAssociation.ContactTypeAssociation" } } } } } } }, "/company/noteTypes": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get List of CompanyNoteType", "operationId": "getCompanyNoteTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "post": { "tags": [ "CompanyNoteTypes" ], "summary": "Post CompanyNoteType", "operationId": "postCompanyNoteTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "noteType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } }, "required": true }, "responses": { "201": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "/company/noteTypes/count": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get Count of CompanyNoteType", "operationId": "getCompanyNoteTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/noteTypes/count/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get Count of CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesCountInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/company/noteTypes/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get List of CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CompanyNoteTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyNoteTypeInfo" } } } } } } } }, "/company/noteTypes/{id}": { "get": { "tags": [ "CompanyNoteTypes" ], "summary": "Get CompanyNoteType", "operationId": "getCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } }, "delete": { "tags": [ "CompanyNoteTypes" ], "summary": "Delete CompanyNoteType", "operationId": "deleteCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CompanyNoteTypes" ], "summary": "Put CompanyNoteType", "operationId": "putCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "noteType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } }, "required": true }, "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } }, "patch": { "tags": [ "CompanyNoteTypes" ], "summary": "Patch CompanyNoteType", "operationId": "patchCompanyNoteTypesById", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CompanyNoteType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNoteType" } } } } } } }, "/company/noteTypes/{id}/info": { "get": { "tags": [ "CompanyNoteTypeInfo" ], "summary": "Get CompanyNoteTypeInfo", "operationId": "getCompanyNoteTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "noteTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CompanyNoteTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CompanyNoteTypeInfo" } } } } } } }, "/finance/agreements": { "get": { "tags": [ "Agreements" ], "summary": "Get List of Agreement", "operationId": "getFinanceAgreements", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "post": { "tags": [ "Agreements" ], "summary": "Post Agreement", "operationId": "postFinanceAgreements", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } }, "required": true }, "responses": { "201": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Count of Agreement", "operationId": "getFinanceAgreementsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of AgreementType", "operationId": "getFinanceAgreementsTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "post": { "tags": [ "AgreementTypes" ], "summary": "Post AgreementType", "operationId": "postFinanceAgreementsTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreementType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementType" } } }, "required": true }, "responses": { "201": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreements/types/count": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get Count of AgreementType", "operationId": "getFinanceAgreementsTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types/info": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of AgreementTypeInfo", "operationId": "getFinanceAgreementsTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementTypeInfo" } } } } } } } }, "/finance/agreements/types/info/count": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get Count of AgreementTypeInfo", "operationId": "getFinanceAgreementsTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/types/{id}": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get AgreementType", "operationId": "getFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } }, "delete": { "tags": [ "AgreementTypes" ], "summary": "Delete AgreementType", "operationId": "deleteFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementTypes" ], "summary": "Put AgreementType", "operationId": "putFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreementType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementType" } } }, "required": true }, "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } }, "patch": { "tags": [ "AgreementTypes" ], "summary": "Patch AgreementType", "operationId": "patchFinanceAgreementsTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreements/types/{id}/info": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get AgreementType", "operationId": "getFinanceAgreementsTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementTypeInfo" } } } } } } }, "/finance/agreements/types/{id}/usages": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of Usage Count", "operationId": "getFinanceAgreementsTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/agreements/types/{id}/usages/list": { "get": { "tags": [ "AgreementTypes" ], "summary": "Get List of Usage", "operationId": "getFinanceAgreementsTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/finance/agreements/types{id}/copy": { "post": { "tags": [ "AgreementType" ], "summary": "Post AgreementType", "operationId": "postFinanceAgreementsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "agreementTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementType" } } } } } } }, "/finance/agreements/{id}": { "get": { "tags": [ "Agreements" ], "summary": "Get Agreement", "operationId": "getFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } }, "delete": { "tags": [ "Agreements" ], "summary": "Delete Agreement", "operationId": "deleteFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Agreements" ], "summary": "Put Agreement", "operationId": "putFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "agreement", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement" } } }, "required": true }, "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } }, "patch": { "tags": [ "Agreements" ], "summary": "Patch Agreement", "operationId": "patchFinanceAgreementsById", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/{id}/applicationParameters/{podId}": { "get": { "tags": [ "Agreements" ], "summary": "Get AgreementApplicationParameters", "operationId": "getFinanceAgreementsByIdApplicationParametersByPodId", "parameters": [ { "name": "id", "in": "path", "description": "agreementHeaderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "podId", "in": "path", "description": "podId", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementApplicationParameters" } } } } } } }, "/finance/agreements/{id}/invoice": { "post": { "tags": [ "Agreements" ], "summary": "Post AgreementInvoice", "operationId": "postFinanceAgreementsByIdInvoice", "parameters": [ { "name": "id", "in": "path", "description": "id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "Agreement", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "integer", "format": "int32" } } } } } } }, "/finance/agreements/{id}/quickAccess/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Agreement Tab Count", "operationId": "getFinanceAgreementsByIdQuickAccessCount", "parameters": [ { "name": "id", "in": "path", "description": "agreementHeaderId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementApplicationParameters", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementTabsCount" } } } } } } }, "/finance/agreements/{id}/recurringParameters/{podId}": { "get": { "tags": [ "Agreements" ], "summary": "Get AgreementRecurringParameters", "operationId": "getFinanceAgreementsByIdRecurringParametersByPodId", "parameters": [ { "name": "id", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "podId", "in": "path", "description": "podId", "required": true, "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementRecurringParameters", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementRecurringParameters" } } } } } } }, "/finance/agreements/{parentId}/additions": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get List of Addition", "operationId": "getFinanceAgreementsByParentIdAdditions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Addition", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Addition" } } } } } } }, "post": { "tags": [ "AgreementAdditions" ], "summary": "Post Addition", "operationId": "postFinanceAgreementsByParentIdAdditions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Addition" } } }, "required": true }, "responses": { "201": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } } }, "/finance/agreements/{parentId}/additions/count": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get Count of Addition", "operationId": "getFinanceAgreementsByParentIdAdditionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/additions/{id}": { "get": { "tags": [ "AgreementAdditions" ], "summary": "Get Addition", "operationId": "getFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } }, "delete": { "tags": [ "AgreementAdditions" ], "summary": "Delete Addition", "operationId": "deleteFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementAdditions" ], "summary": "Put Addition", "operationId": "putFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "addition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Addition" } } }, "required": true }, "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } }, "patch": { "tags": [ "AgreementAdditions" ], "summary": "Patch Addition", "operationId": "patchFinanceAgreementsByParentIdAdditionsById", "parameters": [ { "name": "id", "in": "path", "description": "additionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Addition", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Addition" } } } } } } }, "/finance/agreements/{parentId}/adjustments": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get List of Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustments", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "post": { "tags": [ "AgreementAdjustments" ], "summary": "Post Adjustment", "operationId": "postFinanceAgreementsByParentIdAdjustments", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } }, "required": true }, "responses": { "201": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "/finance/agreements/{parentId}/adjustments/count": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get Count of Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustmentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/adjustments/{id}": { "get": { "tags": [ "AgreementAdjustments" ], "summary": "Get Adjustment", "operationId": "getFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } }, "delete": { "tags": [ "AgreementAdjustments" ], "summary": "Delete Adjustment", "operationId": "deleteFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementAdjustments" ], "summary": "Put Adjustment", "operationId": "putFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "adjustment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } }, "required": true }, "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } }, "patch": { "tags": [ "AgreementAdjustments" ], "summary": "Patch Adjustment", "operationId": "patchFinanceAgreementsByParentIdAdjustmentsById", "parameters": [ { "name": "id", "in": "path", "description": "adjustmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Adjustment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement.Adjustment" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get List of BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "post": { "tags": [ "AgreementBoardDefaults" ], "summary": "Post BoardDefault", "operationId": "postFinanceAgreementsByParentIdBoardDefaults", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } }, "required": true }, "responses": { "201": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults/count": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get Count of BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaultsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/boardDefaults/{id}": { "get": { "tags": [ "AgreementBoardDefaults" ], "summary": "Get BoardDefault", "operationId": "getFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } }, "delete": { "tags": [ "AgreementBoardDefaults" ], "summary": "Delete BoardDefault", "operationId": "deleteFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementBoardDefaults" ], "summary": "Put BoardDefault", "operationId": "putFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardDefault", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } }, "required": true }, "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } }, "patch": { "tags": [ "AgreementBoardDefaults" ], "summary": "Patch BoardDefault", "operationId": "patchFinanceAgreementsByParentIdBoardDefaultsById", "parameters": [ { "name": "id", "in": "path", "description": "boardDefaultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardDefault", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardDefault" } } } } } } }, "/finance/agreements/{parentId}/configurations": { "get": { "tags": [ "Agreements" ], "summary": "Get List of ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "Agreements" ], "summary": "Post ConfigurationReference", "operationId": "postFinanceAgreementsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/finance/agreements/{parentId}/configurations/count": { "get": { "tags": [ "Agreements" ], "summary": "Get Count of ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/configurations/{id}": { "get": { "tags": [ "Agreements" ], "summary": "Get ConfigurationReference", "operationId": "getFinanceAgreementsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "Agreements" ], "summary": "Delete ConfigurationReference", "operationId": "deleteFinanceAgreementsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/copy": { "post": { "tags": [ "Agreements" ], "summary": "Post CopyAgreementAction", "operationId": "postFinanceAgreementsByParentIdCopy", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "CopyAgreementAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Agreement" } } } } } } }, "/finance/agreements/{parentId}/sites": { "get": { "tags": [ "AgreementSites" ], "summary": "Get List of AgreementSite", "operationId": "getFinanceAgreementsByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "post": { "tags": [ "AgreementSites" ], "summary": "Post AgreementSite", "operationId": "postFinanceAgreementsByParentIdSites", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } }, "required": true }, "responses": { "201": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "/finance/agreements/{parentId}/sites/count": { "get": { "tags": [ "AgreementSites" ], "summary": "Get Count of AgreementSite", "operationId": "getFinanceAgreementsByParentIdSitesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/sites/{id}": { "get": { "tags": [ "AgreementSites" ], "summary": "Get AgreementSite", "operationId": "getFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } }, "delete": { "tags": [ "AgreementSites" ], "summary": "Delete AgreementSite", "operationId": "deleteFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementSites" ], "summary": "Put AgreementSite", "operationId": "putFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "site", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } }, "required": true }, "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } }, "patch": { "tags": [ "AgreementSites" ], "summary": "Patch AgreementSite", "operationId": "patchFinanceAgreementsByParentIdSitesById", "parameters": [ { "name": "id", "in": "path", "description": "siteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementSite", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementSite" } } } } } } }, "/finance/agreements/{parentId}/workRoleExclusions": { "get": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Get List of AgreementWorkRoleExclusion", "operationId": "getFinanceAgreementsByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } } } } } }, "post": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Post AgreementWorkRoleExclusion", "operationId": "postFinanceAgreementsByParentIdWorkRoleExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkRoleExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkRoleExclusion" } } } } } } }, "/finance/agreements/{parentId}/workRoleExclusions/count": { "get": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Get Count of AgreementWorkRoleExclusion", "operationId": "getFinanceAgreementsByParentIdWorkRoleExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workRoleExclusions/{id}": { "delete": { "tags": [ "AgreementWorkRoleExclusions" ], "summary": "Delete AgreementWorkRoleExclusion", "operationId": "deleteFinanceAgreementsByParentIdWorkRoleExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/workTypeExclusions": { "get": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Get List of AgreementWorkTypeExclusion", "operationId": "getFinanceAgreementsByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } } } } } }, "post": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Post AgreementWorkTypeExclusion", "operationId": "postFinanceAgreementsByParentIdWorkTypeExclusions", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workTypeExclusion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkTypeExclusion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkTypeExclusion" } } } } } } }, "/finance/agreements/{parentId}/workTypeExclusions/count": { "get": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Get Count of AgreementWorkTypeExclusion", "operationId": "getFinanceAgreementsByParentIdWorkTypeExclusionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workTypeExclusions/{id}": { "delete": { "tags": [ "AgreementWorkTypeExclusions" ], "summary": "Delete AgreementWorkTypeExclusion", "operationId": "deleteFinanceAgreementsByParentIdWorkTypeExclusionsById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeExclusionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/finance/agreements/{parentId}/workroles": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get List of AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "post": { "tags": [ "AgreementWorkRoles" ], "summary": "Post AgreementWorkRole", "operationId": "postFinanceAgreementsByParentIdWorkroles", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "/finance/agreements/{parentId}/workroles/count": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get Count of AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkrolesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/workroles/{id}": { "get": { "tags": [ "AgreementWorkRoles" ], "summary": "Get AgreementWorkRole", "operationId": "getFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } }, "delete": { "tags": [ "AgreementWorkRoles" ], "summary": "Delete AgreementWorkRole", "operationId": "deleteFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementWorkRoles" ], "summary": "Put AgreementWorkRole", "operationId": "putFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } }, "patch": { "tags": [ "AgreementWorkRoles" ], "summary": "Patch AgreementWorkRole", "operationId": "patchFinanceAgreementsByParentIdWorkrolesById", "parameters": [ { "name": "id", "in": "path", "description": "workroleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkRole" } } } } } } }, "/finance/agreements/{parentId}/worktypes": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get List of AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "post": { "tags": [ "AgreementWorkTypes" ], "summary": "Post AgreementWorkType", "operationId": "postFinanceAgreementsByParentIdWorktypes", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } }, "required": true }, "responses": { "201": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "/finance/agreements/{parentId}/worktypes/count": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get Count of AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/finance/agreements/{parentId}/worktypes/{id}": { "get": { "tags": [ "AgreementWorkTypes" ], "summary": "Get AgreementWorkType", "operationId": "getFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } }, "delete": { "tags": [ "AgreementWorkTypes" ], "summary": "Delete AgreementWorkType", "operationId": "deleteFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "AgreementWorkTypes" ], "summary": "Put AgreementWorkType", "operationId": "putFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } }, "patch": { "tags": [ "AgreementWorkTypes" ], "summary": "Patch AgreementWorkType", "operationId": "patchFinanceAgreementsByParentIdWorktypesById", "parameters": [ { "name": "id", "in": "path", "description": "worktypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "agreementId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "AgreementWorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/AgreementWorkType" } } } } } } }, "/project/boards/{grandparentId}/teams/{parentId}/members": { "get": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Get List of ProjectBoardTeamMember", "operationId": "getProjectBoardsByGrandparentIdTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "post": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Post ProjectBoardTeamMember", "operationId": "postProjectBoardsByGrandparentIdTeamsByParentIdMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "/project/boards/{grandparentId}/teams/{parentId}/members/{id}": { "get": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Get ProjectBoardTeamMember", "operationId": "getProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } }, "delete": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Delete ProjectBoardTeamMember", "operationId": "deleteProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Put ProjectBoardTeamMember", "operationId": "putProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } }, "patch": { "tags": [ "ProjectBoardTeamMembers" ], "summary": "Patch ProjectBoardTeamMember", "operationId": "patchProjectBoardsByGrandparentIdTeamsByParentIdMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamMember" } } } } } } }, "/project/boards/{parentId}/kanbanSettings": { "get": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Get List of ProjectBoardKanbanSettings", "operationId": "getProjectBoardsByParentIdKanbanSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "post": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Post ProjectBoardKanbanSetting", "operationId": "postProjectBoardsByParentIdKanbanSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "kanbanSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "/project/boards/{parentId}/kanbanSettings/{id}": { "get": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Get ProjectBoardKanbanSetting", "operationId": "getProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } }, "delete": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Delete ProjectBoardKanbanSetting", "operationId": "deleteProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Put ProjectBoardKanbanSetting", "operationId": "putProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Kanban", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } }, "patch": { "tags": [ "ProjectBoardKanbanSettings" ], "summary": "Patch ProjectBoardKanbanSetting", "operationId": "patchProjectBoardsByParentIdKanbanSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "KanbanId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardKanbanSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardKanbanSetting" } } } } } } }, "/project/boards/{parentId}/teams": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get List of ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "post": { "tags": [ "ProjectBoardTeams" ], "summary": "Post ProjectBoardTeam", "operationId": "postProjectBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } }, "required": true }, "responses": { "201": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "/project/boards/{parentId}/teams/count": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get Count of ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/boards/{parentId}/teams/info": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get List of ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectBoardTeamInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardTeamInfo" } } } } } } } }, "/project/boards/{parentId}/teams/{id}": { "get": { "tags": [ "ProjectBoardTeams" ], "summary": "Get ProjectBoardTeam", "operationId": "getProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } }, "delete": { "tags": [ "ProjectBoardTeams" ], "summary": "Delete ProjectBoardTeam", "operationId": "deleteProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectBoardTeams" ], "summary": "Put ProjectBoardTeam", "operationId": "putProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "team", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } }, "patch": { "tags": [ "ProjectBoardTeams" ], "summary": "Patch ProjectBoardTeam", "operationId": "patchProjectBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectBoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeam" } } } } } } }, "/project/boards/{parentId}/teams/{id}/info": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectBoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectBoardTeamInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectBoardTeamInfo" } } } } } } }, "/project/boards/{parentId}/teams/{id}/info/count": { "get": { "tags": [ "ProjectBoardTeamInfos" ], "summary": "Get Count of ProjectBoardTeamInfos", "operationId": "getProjectBoardsByParentIdTeamsByIdInfoCount", "parameters": [ { "name": "id", "in": "path", "description": "ProjectBoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "parentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/phaseStatuses": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of PhaseStatus", "operationId": "getProjectPhaseStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "post": { "tags": [ "PhaseStatuses" ], "summary": "Post PhaseStatus", "operationId": "postProjectPhaseStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "phaseStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } }, "required": true }, "responses": { "201": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "/project/phaseStatuses/count": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get Count of PhaseStatus", "operationId": "getProjectPhaseStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/phaseStatuses/info": { "get": { "tags": [ "PhaseStatusInfos" ], "summary": "Get List of PhaseStatusInfos", "operationId": "getProjectPhaseStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of phaseStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PhaseStatusInfo" } } } } } } } }, "/project/phaseStatuses/{id}": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get PhaseStatus", "operationId": "getProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } }, "delete": { "tags": [ "PhaseStatuses" ], "summary": "Delete PhaseStatus", "operationId": "deleteProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "PhaseStatuses" ], "summary": "Put PhaseStatus", "operationId": "putProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "phaseStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } }, "required": true }, "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } }, "patch": { "tags": [ "PhaseStatuses" ], "summary": "Patch PhaseStatus", "operationId": "patchProjectPhaseStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "PhaseStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PhaseStatus" } } } } } } }, "/project/phaseStatuses/{id}/info": { "get": { "tags": [ "PhaseStatusInfos" ], "summary": "Get PhaseStatusInfos", "operationId": "getProjectPhaseStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "PhaseStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PhaseStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PhaseStatusInfo" } } } } } } }, "/project/phaseStatuses/{id}/usages": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of Usage Count", "operationId": "getProjectPhaseStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/phaseStatuses/{id}/usages/list": { "get": { "tags": [ "PhaseStatuses" ], "summary": "Get List of Usage", "operationId": "getProjectPhaseStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "phaseStatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/projects": { "get": { "tags": [ "Projects" ], "summary": "Get List of ApiProject", "operationId": "getProjectProjects", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Project" } } } } } } }, "post": { "tags": [ "Projects" ], "summary": "Post ApiProject", "operationId": "postProjectProjects", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "required": true }, "responses": { "201": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/project/projects/count": { "get": { "tags": [ "Projects" ], "summary": "Get Count of ApiProject", "operationId": "getProjectProjectsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{id}": { "get": { "tags": [ "Projects" ], "summary": "Get ApiProject", "operationId": "getProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Project" } } } } } }, "delete": { "tags": [ "Projects" ], "summary": "Delete ApiProject", "operationId": "deleteProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Projects" ], "summary": "Put ApiProject", "operationId": "putProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "project", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Project" } } }, "required": true }, "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Project" } } } } } }, "patch": { "tags": [ "Projects" ], "summary": "Patch ApiProject", "operationId": "patchProjectProjectsById", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiProject", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Project" } } } } } } }, "/project/projects/{id}/projectRecap": { "get": { "tags": [ "Projects" ], "summary": "Get ProjectRecap", "operationId": "getProjectProjectsByIdProjectRecap", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectRecap", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectRecap" } } } } } } }, "/project/projects/{id}/projectWorkplan": { "get": { "tags": [ "Projects" ], "summary": "Get ProjectWorkplan", "operationId": "getProjectProjectsByIdProjectWorkplan", "parameters": [ { "name": "id", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/applyTemplate/{id}": { "post": { "tags": [ "Projects" ], "summary": "Post ApplyTemplate", "operationId": "postProjectProjectsByParentIdApplyTemplateById", "parameters": [ { "name": "id", "in": "path", "description": "templateProjectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/applyTemplates": { "post": { "tags": [ "Projects" ], "summary": "Post ApplyTemplates", "operationId": "postProjectProjectsByParentIdApplyTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of Project Templates", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTemplate" } } } }, "required": true }, "responses": { "201": { "description": "ProjectWorkplan", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectWorkplan" } } } } } } }, "/project/projects/{parentId}/contacts": { "get": { "tags": [ "ProjectContacts" ], "summary": "Get List of ProjectContact", "operationId": "getProjectProjectsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectContact" } } } } } } }, "post": { "tags": [ "ProjectContacts" ], "summary": "Post ProjectContact", "operationId": "postProjectProjectsByParentIdContacts", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } }, "required": true }, "responses": { "201": { "description": "ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } } } } } }, "/project/projects/{parentId}/contacts/{id}": { "get": { "tags": [ "ProjectContacts" ], "summary": "Get ProjectContact", "operationId": "getProjectProjectsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectContact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectContact" } } } } } }, "delete": { "tags": [ "ProjectContacts" ], "summary": "Delete ProjectContact", "operationId": "deleteProjectProjectsByParentIdContactsById", "parameters": [ { "name": "id", "in": "path", "description": "contactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/project/projects/{parentId}/notes": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get List of ProjectNote", "operationId": "getProjectProjectsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "post": { "tags": [ "ProjectNotes" ], "summary": "Post ProjectNote", "operationId": "postProjectProjectsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } }, "required": true }, "responses": { "201": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "/project/projects/{parentId}/notes/count": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get Count of ProjectNote", "operationId": "getProjectProjectsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{parentId}/notes/{id}": { "get": { "tags": [ "ProjectNotes" ], "summary": "Get ProjectNote", "operationId": "getProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } }, "delete": { "tags": [ "ProjectNotes" ], "summary": "Delete ProjectNote", "operationId": "deleteProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectNotes" ], "summary": "Put ProjectNote", "operationId": "putProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } }, "required": true }, "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } }, "patch": { "tags": [ "ProjectNotes" ], "summary": "Patch ProjectNote", "operationId": "patchProjectProjectsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectNote" } } } } } } }, "/project/projects/{parentId}/phases": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get List of ProjectPhase", "operationId": "getProjectProjectsByParentIdPhases", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "post": { "tags": [ "ProjectPhases" ], "summary": "Post ProjectPhase", "operationId": "postProjectProjectsByParentIdPhases", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectPhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } }, "required": true }, "responses": { "201": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "/project/projects/{parentId}/phases/count": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get Count of ProjectPhase", "operationId": "getProjectProjectsByParentIdPhasesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{parentId}/phases/{id}": { "get": { "tags": [ "ProjectPhases" ], "summary": "Get ProjectPhase", "operationId": "getProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } }, "delete": { "tags": [ "ProjectPhases" ], "summary": "Delete ProjectPhase", "operationId": "deleteProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectPhases" ], "summary": "Put ProjectPhase", "operationId": "putProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectPhase", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } }, "required": true }, "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } }, "patch": { "tags": [ "ProjectPhases" ], "summary": "Patch ProjectPhase", "operationId": "patchProjectProjectsByParentIdPhasesById", "parameters": [ { "name": "id", "in": "path", "description": "phasId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectPhase", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectPhase" } } } } } } }, "/project/projects/{parentId}/teamMembers": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get List of ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "post": { "tags": [ "ProjectsTeamMembers" ], "summary": "Post ProjectTeamMember", "operationId": "postProjectProjectsByParentIdTeamMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } }, "required": true }, "responses": { "201": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "/project/projects/{parentId}/teamMembers/count": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get Count of ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/projects/{parentId}/teamMembers/{id}": { "get": { "tags": [ "ProjectsTeamMembers" ], "summary": "Get ProjectTeamMember", "operationId": "getProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } }, "delete": { "tags": [ "ProjectsTeamMembers" ], "summary": "Delete ProjectTeamMember", "operationId": "deleteProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectsTeamMembers" ], "summary": "Put ProjectTeamMember", "operationId": "putProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } }, "required": true }, "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } }, "patch": { "tags": [ "ProjectsTeamMembers" ], "summary": "Patch ProjectTeamMember", "operationId": "patchProjectProjectsByParentIdTeamMembersById", "parameters": [ { "name": "id", "in": "path", "description": "teamMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "projectId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTeamMember" } } } } } } }, "/project/statuses": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get List of ProjectStatus", "operationId": "getProjectStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "post": { "tags": [ "ProjectStatuses" ], "summary": "Post ProjectStatus", "operationId": "postProjectStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "required": true }, "responses": { "201": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "/project/statuses/count": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get Count of ProjectStatus", "operationId": "getProjectStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/statuses/info": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get List of ProjectStatusesInfo", "operationId": "getProjectStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of projectStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectStatusInfo" } } } } } } } }, "/project/statuses/info/count": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get Count of ProjectStatusInfo", "operationId": "getProjectStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/statuses/{id}": { "get": { "tags": [ "ProjectStatuses" ], "summary": "Get ProjectStatus", "operationId": "getProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } }, "delete": { "tags": [ "ProjectStatuses" ], "summary": "Delete ProjectStatus", "operationId": "deleteProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectStatuses" ], "summary": "Put ProjectStatus", "operationId": "putProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "projectStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } }, "required": true }, "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } }, "patch": { "tags": [ "ProjectStatuses" ], "summary": "Patch ProjectStatus", "operationId": "patchProjectStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectStatus" } } } } } } }, "/project/statuses/{id}/info": { "get": { "tags": [ "ProjectStatusesInfo" ], "summary": "Get ProjectStatusesInfo", "operationId": "getProjectStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ProjectStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectStatusInfo" } } } } } } }, "/project/statuses/{id}/usages": { "get": { "tags": [ "Statuses" ], "summary": "Get List of Usage Count", "operationId": "getProjectStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/statuses/{id}/usages/list": { "get": { "tags": [ "Statuses" ], "summary": "Get List of Usage", "operationId": "getProjectStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/project/ticketNote/{id}/markAs/": { "post": { "tags": [ "ProjectTicketNotes" ], "summary": "Post ProjectTicketNote", "operationId": "postProjectTicketNoteByIdMarkAs", "parameters": [ { "name": "id", "in": "path", "description": "ticketNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicketNote" } } }, "required": true }, "responses": { "default": { "description": "Responses cannot be located for this operation." } } } }, "/project/tickets": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ProjectTicket", "operationId": "getProjectTickets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "post": { "tags": [ "ProjectTickets" ], "summary": "Post ProjectTicket", "operationId": "postProjectTickets", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } }, "required": true }, "responses": { "201": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "/project/tickets/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ProjectTicket", "operationId": "getProjectTicketsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/search": { "post": { "tags": [ "ProjectTickets" ], "summary": "Post List of ProjectTicket", "operationId": "postProjectTicketsSearch", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "filterValues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterValues" } } }, "required": true }, "responses": { "200": { "description": "List of ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } } }, "/project/tickets/{id}": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get ProjectTicket", "operationId": "getProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } }, "delete": { "tags": [ "ProjectTickets" ], "summary": "Delete ProjectTicket", "operationId": "deleteProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ProjectTickets" ], "summary": "Put ProjectTicket", "operationId": "putProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } }, "required": true }, "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } }, "patch": { "tags": [ "ProjectTickets" ], "summary": "Patch ProjectTicket", "operationId": "patchProjectTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ProjectTicket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ProjectTicket" } } } } } } }, "/project/tickets/{parentId}/activities": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ActivityReference\r\n Gets activities associated to the ticket\r\n Please use the /sales/activities?conditions=ticket/id={id} endpoint", "operationId": "getProjectTicketsByParentIdActivities", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityReference" } } } } } } } }, "/project/tickets/{parentId}/activities/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ActivityReference\r\n Gets count of activities associated to the ticket\r\n Please use the /sales/activities/count?conditions=ticket/id={id} endpoint", "operationId": "getProjectTicketsByParentIdActivitiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/allNotes": { "get": { "tags": [ "ProjectTicketNotes" ], "summary": "Get List of ProjectTicketNote", "operationId": "getProjectTicketsByParentIdAllNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProjectTicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectTicketNote" } } } } } } } }, "/project/tickets/{parentId}/configurations": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "ProjectTickets" ], "summary": "Post ConfigurationReference", "operationId": "postProjectTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/project/tickets/{parentId}/configurations/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/configurations/{id}": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get ConfigurationReference", "operationId": "getProjectTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "ProjectTickets" ], "summary": "Delete ConfigurationReference", "operationId": "deleteProjectTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/project/tickets/{parentId}/convert": { "post": { "tags": [ "ProjectTickets" ], "summary": "Post SuccessResponse", "operationId": "postProjectTicketsByParentIdConvert", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertItem" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/project/tickets/{parentId}/documents": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of DocumentReference\r\n Gets the documents associated to the ticket\r\n Please use the /system/documents?recordType=Ticket&recordId={id} endpoint", "operationId": "getProjectTicketsByParentIdDocuments", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } } } } }, "/project/tickets/{parentId}/documents/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of DocumentReference", "operationId": "getProjectTicketsByParentIdDocumentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/notes": { "get": { "tags": [ "TicketNotes" ], "summary": "Get List of TicketNote", "operationId": "getProjectTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "post": { "tags": [ "TicketNotes" ], "summary": "Post TicketNote", "operationId": "postProjectTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketNote" } } }, "required": true }, "responses": { "201": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "/project/tickets/{parentId}/notes/count": { "get": { "tags": [ "TicketNotes" ], "summary": "Get Count of TicketNote", "operationId": "getProjectTicketsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/notes/{id}": { "get": { "tags": [ "TicketNotes" ], "summary": "Get TicketNote", "operationId": "getProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } }, "delete": { "tags": [ "TicketNotes" ], "summary": "Delete TicketNote", "operationId": "deleteProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketNotes" ], "summary": "Put TicketNote", "operationId": "putProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketNote" } } }, "required": true }, "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } }, "patch": { "tags": [ "TicketNotes" ], "summary": "Patch TicketNote", "operationId": "patchProjectTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketNote" } } } } } } }, "/project/tickets/{parentId}/products": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" } } } } } } } }, "/project/tickets/{parentId}/products/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdProductsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/scheduleentries": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of ScheduleEntryReference\r\n Gets the schedule entries associated to the ticket\r\n Please use the /schedule/entries?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getProjectTicketsByParentIdScheduleentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntryReference" } } } } } } } }, "/project/tickets/{parentId}/scheduleentries/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of ScheduleEntryReference\r\n Gets the schedule entries count associated to the ticket\r\n Please use the /schedule/entries/count?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getProjectTicketsByParentIdScheduleentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/tasks": { "get": { "tags": [ "TicketTasks" ], "summary": "Get List of TicketTask", "operationId": "getProjectTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "post": { "tags": [ "TicketTasks" ], "summary": "Post TicketTask", "operationId": "postProjectTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketTask" } } }, "required": true }, "responses": { "201": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "/project/tickets/{parentId}/tasks/count": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Count of TicketTask", "operationId": "getProjectTicketsByParentIdTasksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/project/tickets/{parentId}/tasks/{id}": { "get": { "tags": [ "TicketTasks" ], "summary": "Get TicketTask", "operationId": "getProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } }, "delete": { "tags": [ "TicketTasks" ], "summary": "Delete TicketTask", "operationId": "deleteProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketTasks" ], "summary": "Put TicketTask", "operationId": "putProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketTask" } } }, "required": true }, "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } }, "patch": { "tags": [ "TicketTasks" ], "summary": "Patch TicketTask", "operationId": "patchProjectTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketTask" } } } } } } }, "/project/tickets/{parentId}/timeentries": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get List of TimeEntryReference\r\n Gets time entries associated to the ticket\r\n Please use the /time/entries?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdTimeentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryReference" } } } } } } } }, "/project/tickets/{parentId}/timeentries/count": { "get": { "tags": [ "ProjectTickets" ], "summary": "Get Count of TimeEntryReference\r\n Gets time entries count associated to the ticket\r\n Please use the /time/entries/count?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getProjectTicketsByParentIdTimeentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities": { "get": { "tags": [ "Activities" ], "summary": "Get List of Activity", "operationId": "getSalesActivities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Activity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Activity" } } } } } } }, "post": { "tags": [ "Activities" ], "summary": "Post Activity", "operationId": "postSalesActivities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "201": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/sales/activities/count": { "get": { "tags": [ "Activities" ], "summary": "Get Count of Activity", "operationId": "getSalesActivitiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/statuses": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get List of ActivityStatus", "operationId": "getSalesActivitiesStatuses", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "post": { "tags": [ "ActivityStatuses" ], "summary": "Post ActivityStatus", "operationId": "postSalesActivitiesStatuses", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } }, "required": true }, "responses": { "201": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "/sales/activities/statuses/count": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get Count of ActivityStatus", "operationId": "getSalesActivitiesStatusesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/statuses/info": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get List of ActivityStatusInfos", "operationId": "getSalesActivitiesStatusesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of activityStatusInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityStatusInfo" } } } } } } } }, "/sales/activities/statuses/info/count": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get Count of ActivityStatus", "operationId": "getSalesActivitiesStatusesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/statuses/{id}": { "get": { "tags": [ "ActivityStatuses" ], "summary": "Get ActivityStatus", "operationId": "getSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } }, "delete": { "tags": [ "ActivityStatuses" ], "summary": "Delete ActivityStatus", "operationId": "deleteSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ActivityStatuses" ], "summary": "Put ActivityStatus", "operationId": "putSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } }, "required": true }, "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } }, "patch": { "tags": [ "ActivityStatuses" ], "summary": "Patch ActivityStatus", "operationId": "patchSalesActivitiesStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ActivityStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityStatus" } } } } } } }, "/sales/activities/statuses/{id}/info": { "get": { "tags": [ "ActivityStatusInfos" ], "summary": "Get ActivityStatusInfos", "operationId": "getSalesActivitiesStatusesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ActivityStatusInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityStatusInfo" } } } } } } }, "/sales/activities/types": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of ActivityType", "operationId": "getSalesActivitiesTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "post": { "tags": [ "ActivityTypes" ], "summary": "Post ActivityType", "operationId": "postSalesActivitiesTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityType" } } }, "required": true }, "responses": { "201": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "/sales/activities/types/count": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get Count of ActivityType", "operationId": "getSalesActivitiesTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/sales/activities/types/{id}": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get ActivityType", "operationId": "getSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } }, "delete": { "tags": [ "ActivityTypes" ], "summary": "Delete ActivityType", "operationId": "deleteSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ActivityTypes" ], "summary": "Put ActivityType", "operationId": "putSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activityType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ActivityType" } } }, "required": true }, "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } }, "patch": { "tags": [ "ActivityTypes" ], "summary": "Patch ActivityType", "operationId": "patchSalesActivitiesTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ActivityType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ActivityType" } } } } } } }, "/sales/activities/types/{id}/usages": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of Usage Count", "operationId": "getSalesActivitiesTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/activities/types/{id}/usages/list": { "get": { "tags": [ "ActivityTypes" ], "summary": "Get List of Usage", "operationId": "getSalesActivitiesTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/sales/activities/{id}": { "get": { "tags": [ "Activities" ], "summary": "Get Activity", "operationId": "getSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "delete": { "tags": [ "Activities" ], "summary": "Delete Activity", "operationId": "deleteSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Activities" ], "summary": "Put Activity", "operationId": "putSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "activity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Activity" } } }, "required": true }, "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } }, "patch": { "tags": [ "Activities" ], "summary": "Patch Activity", "operationId": "patchSalesActivitiesById", "parameters": [ { "name": "id", "in": "path", "description": "activityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Activity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Activity" } } } } } } }, "/schedule/entries": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get List of ScheduleEntry", "operationId": "getScheduleEntries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "post": { "tags": [ "ScheduleEntries" ], "summary": "Post ScheduleEntry", "operationId": "postScheduleEntries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } }, "required": true }, "responses": { "201": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "/schedule/entries/count": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get Count of ScheduleEntry", "operationId": "getScheduleEntriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/entries/{id}": { "get": { "tags": [ "ScheduleEntries" ], "summary": "Get ScheduleEntry", "operationId": "getScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } }, "delete": { "tags": [ "ScheduleEntries" ], "summary": "Delete ScheduleEntry", "operationId": "deleteScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ScheduleEntries" ], "summary": "Put ScheduleEntry", "operationId": "putScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "scheduleEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } }, "required": true }, "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } }, "patch": { "tags": [ "ScheduleEntries" ], "summary": "Patch ScheduleEntry", "operationId": "patchScheduleEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ScheduleEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ScheduleEntry" } } } } } } }, "/schedule/entries/{id}/{notifyResource}": { "delete": { "tags": [ "ScheduleEntries" ], "summary": "Delete ScheduleEntry", "operationId": "deleteScheduleEntriesByIdByNotifyResource", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "notifyResource", "in": "path", "description": "notifyResource", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/schedule/entries/{parentId}/details": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get List of ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetails", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleDetail", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleDetail" } } } } } } } }, "/schedule/entries/{parentId}/details/count": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get Count of ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetailsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/schedule/entries/{parentId}/details/{id}": { "get": { "tags": [ "ScheduleDetails" ], "summary": "Get ScheduleDetail", "operationId": "getScheduleEntriesByParentIdDetailsById", "parameters": [ { "name": "id", "in": "path", "description": "detailId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ScheduleDetail", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ScheduleDetail" } } } } } } }, "/service/SLAs": { "get": { "tags": [ "SLAs" ], "summary": "Get List of SLA", "operationId": "getServiceSLAs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SLA", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLA" } } } } } } }, "post": { "tags": [ "SLAs" ], "summary": "Post SLA", "operationId": "postServiceSLAs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLA" } } }, "required": true }, "responses": { "201": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } } }, "/service/SLAs/count": { "get": { "tags": [ "SLAs" ], "summary": "Get Count of SLA", "operationId": "getServiceSLAsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/SLAs/info/count": { "get": { "tags": [ "SLAInfos" ], "summary": "Get Count of SLAInfos", "operationId": "getServiceSLAsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/SLAs/{id}": { "get": { "tags": [ "SLAs" ], "summary": "Get SLA", "operationId": "getServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } }, "delete": { "tags": [ "SLAs" ], "summary": "Delete SLA", "operationId": "deleteServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SLAs" ], "summary": "Put SLA", "operationId": "putServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLA", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLA" } } }, "required": true }, "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } }, "patch": { "tags": [ "SLAs" ], "summary": "Patch SLA", "operationId": "patchServiceSLAsById", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SLA", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLA" } } } } } } }, "/service/SLAs/{id}/usages": { "get": { "tags": [ "SLAs" ], "summary": "Get List of Usage", "operationId": "getServiceSLAsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/SLAs/{id}/usages/list": { "get": { "tags": [ "SLAs" ], "summary": "Get List of Usage", "operationId": "getServiceSLAsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/SLAs/{parentId}/priorities": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get List of SLAPriority", "operationId": "getServiceSLAsByParentIdPriorities", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "post": { "tags": [ "SLAPriorities" ], "summary": "Post SLAPriority", "operationId": "postServiceSLAsByParentIdPriorities", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLAPriority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } }, "required": true }, "responses": { "201": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "/service/SLAs/{parentId}/priorities/count": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get Count of SLAPriority", "operationId": "getServiceSLAsByParentIdPrioritiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/SLAs/{parentId}/priorities/{id}": { "get": { "tags": [ "SLAPriorities" ], "summary": "Get SLAPriority", "operationId": "getServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } }, "delete": { "tags": [ "SLAPriorities" ], "summary": "Delete SLAPriority", "operationId": "deleteServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SLAPriorities" ], "summary": "Put SLAPriority", "operationId": "putServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "sLAPriority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } }, "required": true }, "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } }, "patch": { "tags": [ "SLAPriorities" ], "summary": "Patch SLAPriority", "operationId": "patchServiceSLAsByParentIdPrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "SLAId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SLAPriority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLAPriority" } } } } } } }, "/service/boards": { "get": { "tags": [ "Boards" ], "summary": "Get List of Board", "operationId": "getServiceBoards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Board" } } } } } } }, "post": { "tags": [ "Boards" ], "summary": "Post Board", "operationId": "postServiceBoards", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "board", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "required": true }, "responses": { "201": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/copy": { "post": { "tags": [ "Boards" ], "summary": "Post Board", "operationId": "postServiceBoardsCopy", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "copy", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardCopy" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/count": { "get": { "tags": [ "Boards" ], "summary": "Get Count of Board", "operationId": "getServiceBoardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get List of BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations/count": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get Count of BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{grandparentId}/items/{parentId}/associations/{id}": { "get": { "tags": [ "BoardItemAssociations" ], "summary": "Get BoardItemAssociation", "operationId": "getServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } }, "put": { "tags": [ "BoardItemAssociations" ], "summary": "Put BoardItemAssociation", "operationId": "putServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "itemAssociation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } }, "required": true }, "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } }, "patch": { "tags": [ "BoardItemAssociations" ], "summary": "Patch BoardItemAssociation", "operationId": "patchServiceBoardsByGrandparentIdItemsByParentIdAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "associationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItemAssociation" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get List of BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "post": { "tags": [ "BoardStatusNotifications" ], "summary": "Post BoardStatusNotification", "operationId": "postServiceBoardsByGrandparentIdStatusesByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } }, "required": true }, "responses": { "201": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications/count": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get Count of BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{grandparentId}/statuses/{parentId}/notifications/{id}": { "get": { "tags": [ "BoardStatusNotifications" ], "summary": "Get BoardStatusNotification", "operationId": "getServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } }, "delete": { "tags": [ "BoardStatusNotifications" ], "summary": "Delete BoardStatusNotification", "operationId": "deleteServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardStatusNotifications" ], "summary": "Put BoardStatusNotification", "operationId": "putServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatusNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } }, "required": true }, "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } }, "patch": { "tags": [ "BoardStatusNotifications" ], "summary": "Patch BoardStatusNotification", "operationId": "patchServiceBoardsByGrandparentIdStatusesByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardStatusNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatusNotification" } } } } } } }, "/service/boards/{id}": { "get": { "tags": [ "Boards" ], "summary": "Get Board", "operationId": "getServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Board" } } } } } }, "delete": { "tags": [ "Boards" ], "summary": "Delete Board", "operationId": "deleteServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Boards" ], "summary": "Put Board", "operationId": "putServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "board", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Board" } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Board" } } } } } }, "patch": { "tags": [ "Boards" ], "summary": "Patch Board", "operationId": "patchServiceBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Board", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Board" } } } } } } }, "/service/boards/{id}/usages": { "get": { "tags": [ "Boards" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{id}/usages/list": { "get": { "tags": [ "Boards" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/autoAssignResources": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get List of BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResources", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "post": { "tags": [ "BoardAutoAssignResources" ], "summary": "Post BoardAutoAssignResource", "operationId": "postServiceBoardsByParentIdAutoAssignResources", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoAssignResource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } }, "required": true }, "responses": { "201": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "/service/boards/{parentId}/autoAssignResources/count": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get Count of BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResourcesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/autoAssignResources/{id}": { "get": { "tags": [ "BoardAutoAssignResources" ], "summary": "Get BoardAutoAssignResource", "operationId": "getServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } }, "delete": { "tags": [ "BoardAutoAssignResources" ], "summary": "Delete BoardAutoAssignResource", "operationId": "deleteServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardAutoAssignResources" ], "summary": "Put BoardAutoAssignResource", "operationId": "putServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoAssignResource", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } }, "required": true }, "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } }, "patch": { "tags": [ "BoardAutoAssignResources" ], "summary": "Patch BoardAutoAssignResource", "operationId": "patchServiceBoardsByParentIdAutoAssignResourcesById", "parameters": [ { "name": "id", "in": "path", "description": "autoAssignResourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardAutoAssignResource", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoAssignResource" } } } } } } }, "/service/boards/{parentId}/autoTemplates": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get List of BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "post": { "tags": [ "BoardAutoTemplates" ], "summary": "Post BoardAutoTemplate", "operationId": "postServiceBoardsByParentIdAutoTemplates", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } }, "required": true }, "responses": { "201": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "/service/boards/{parentId}/autoTemplates/count": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get Count of BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplatesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/autoTemplates/{id}": { "get": { "tags": [ "BoardAutoTemplates" ], "summary": "Get BoardAutoTemplate", "operationId": "getServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } }, "delete": { "tags": [ "BoardAutoTemplates" ], "summary": "Delete BoardAutoTemplate", "operationId": "deleteServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardAutoTemplates" ], "summary": "Put BoardAutoTemplate", "operationId": "putServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardAutoTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } }, "required": true }, "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } }, "patch": { "tags": [ "BoardAutoTemplates" ], "summary": "Patch BoardAutoTemplate", "operationId": "patchServiceBoardsByParentIdAutoTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "autoTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardAutoTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardAutoTemplate" } } } } } } }, "/service/boards/{parentId}/excludedMembers": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get List of BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } } }, "post": { "tags": [ "BoardExcludedMembers" ], "summary": "Post BoardExcludedMember", "operationId": "postServiceBoardsByParentIdExcludedMembers", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardExcludedMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } }, "required": true }, "responses": { "201": { "description": "BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } } }, "/service/boards/{parentId}/excludedMembers/count": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get Count of BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/excludedMembers/{id}": { "get": { "tags": [ "BoardExcludedMembers" ], "summary": "Get BoardExcludedMember", "operationId": "getServiceBoardsByParentIdExcludedMembersById", "parameters": [ { "name": "id", "in": "path", "description": "excludedMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardExcludedMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardExcludedMember" } } } } } }, "delete": { "tags": [ "BoardExcludedMembers" ], "summary": "Delete BoardExcludedMember", "operationId": "deleteServiceBoardsByParentIdExcludedMembersById", "parameters": [ { "name": "id", "in": "path", "description": "excludedMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/boards/{parentId}/items": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of BoardItem", "operationId": "getServiceBoardsByParentIdItems", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "post": { "tags": [ "BoardItems" ], "summary": "Post BoardItem", "operationId": "postServiceBoardsByParentIdItems", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItem" } } }, "required": true }, "responses": { "201": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "/service/boards/{parentId}/items/count": { "get": { "tags": [ "BoardItems" ], "summary": "Get Count of Usage", "operationId": "getServiceBoardsByParentIdItemsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/items/{id}": { "get": { "tags": [ "BoardItems" ], "summary": "Get BoardItem", "operationId": "getServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } }, "delete": { "tags": [ "BoardItems" ], "summary": "Delete BoardItem", "operationId": "deleteServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardItems" ], "summary": "Put BoardItem", "operationId": "putServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardItem", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardItem" } } }, "required": true }, "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } }, "patch": { "tags": [ "BoardItems" ], "summary": "Patch BoardItem", "operationId": "patchServiceBoardsByParentIdItemsById", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardItem", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardItem" } } } } } } }, "/service/boards/{parentId}/items/{id}/usages": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdItemsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/items/{id}/usages/list": { "get": { "tags": [ "BoardItems" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdItemsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "itemId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/notifications": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get List of BoardNotification", "operationId": "getServiceBoardsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "post": { "tags": [ "BoardNotifications" ], "summary": "Post BoardNotification", "operationId": "postServiceBoardsByParentIdNotifications", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } }, "required": true }, "responses": { "201": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "/service/boards/{parentId}/notifications/count": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get Count of BoardNotification", "operationId": "getServiceBoardsByParentIdNotificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/notifications/{id}": { "get": { "tags": [ "BoardNotifications" ], "summary": "Get BoardNotification", "operationId": "getServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } }, "delete": { "tags": [ "BoardNotifications" ], "summary": "Delete BoardNotification", "operationId": "deleteServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardNotifications" ], "summary": "Put BoardNotification", "operationId": "putServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardNotification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } }, "required": true }, "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } }, "patch": { "tags": [ "BoardNotifications" ], "summary": "Patch BoardNotification", "operationId": "patchServiceBoardsByParentIdNotificationsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardNotification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardNotification" } } } } } } }, "/service/boards/{parentId}/skillMappings/": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get List of BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "post": { "tags": [ "BoardSkillMappings" ], "summary": "Post BoardSkillMappings", "operationId": "postServiceBoardsByParentIdSkillMappings", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "BoardSkillMapping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } }, "required": true }, "responses": { "201": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "/service/boards/{parentId}/skillMappings/count": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get Count of BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/skillMappings/{id}": { "get": { "tags": [ "BoardSkillMappings" ], "summary": "Get BoardSkillMappings", "operationId": "getServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } }, "delete": { "tags": [ "BoardSkillMappings" ], "summary": "Delete BoardSkillMappings", "operationId": "deleteServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardSkillMappings" ], "summary": "Put BoardSkillMappings", "operationId": "putServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSkillMapping", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } }, "required": true }, "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } }, "patch": { "tags": [ "BoardSkillMappings" ], "summary": "Patch BoardSkillMappings", "operationId": "patchServiceBoardsByParentIdSkillMappingsById", "parameters": [ { "name": "id", "in": "path", "description": "BoardSkillMappingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardSkillMapping", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSkillMapping" } } } } } } }, "/service/boards/{parentId}/statuses": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of BoardStatus", "operationId": "getServiceBoardsByParentIdStatuses", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "post": { "tags": [ "BoardStatuses" ], "summary": "Post BoardStatus", "operationId": "postServiceBoardsByParentIdStatuses", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } }, "required": true }, "responses": { "201": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "/service/boards/{parentId}/statuses/count": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get Count of BoardStatus", "operationId": "getServiceBoardsByParentIdStatusesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/statuses/info": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get List of BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardStatusInfos", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardStatusInfo" } } } } } } } }, "/service/boards/{parentId}/statuses/info/count": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get Count of BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/statuses/{id}": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get BoardStatus", "operationId": "getServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } }, "delete": { "tags": [ "BoardStatuses" ], "summary": "Delete BoardStatus", "operationId": "deleteServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardStatuses" ], "summary": "Put BoardStatus", "operationId": "putServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardStatus", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } }, "required": true }, "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } }, "patch": { "tags": [ "BoardStatuses" ], "summary": "Patch BoardStatus", "operationId": "patchServiceBoardsByParentIdStatusesById", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardStatus", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatus" } } } } } } }, "/service/boards/{parentId}/statuses/{id}/info": { "get": { "tags": [ "BoardStatusInfo" ], "summary": "Get BoardStatusInfos", "operationId": "getServiceBoardsByParentIdStatusesByIdInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "ServiceBoardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "StatusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardStatusInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardStatusInfo" } } } } } } }, "/service/boards/{parentId}/statuses/{id}/usages": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdStatusesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/statuses/{id}/usages/list": { "get": { "tags": [ "BoardStatuses" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdStatusesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "statusId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/subtypes": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "post": { "tags": [ "BoardSubTypes" ], "summary": "Post BoardSubType", "operationId": "postServiceBoardsByParentIdSubtypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } }, "required": true }, "responses": { "201": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "/service/boards/{parentId}/subtypes/count": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get Count of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/subtypes/info": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get List of BoardSubTypeInfos", "operationId": "getServiceBoardsByParentIdSubtypesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of boardSubTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardSubTypeInfo" } } } } } } } }, "/service/boards/{parentId}/subtypes/info/count": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get Count of BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get BoardSubType", "operationId": "getServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } }, "delete": { "tags": [ "BoardSubTypes" ], "summary": "Delete Usage", "operationId": "deleteServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardSubTypes" ], "summary": "Put BoardSubType", "operationId": "putServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardSubType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } }, "required": true }, "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } }, "patch": { "tags": [ "BoardSubTypes" ], "summary": "Patch BoardSubType", "operationId": "patchServiceBoardsByParentIdSubtypesById", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardSubType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSubType" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/info": { "get": { "tags": [ "BoardSubTypeInfos" ], "summary": "Get BoardSubTypeInfos", "operationId": "getServiceBoardsByParentIdSubtypesByIdInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "id", "in": "path", "description": "BoardSubTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardSubTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardSubTypeInfo" } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/usages": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdSubtypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/subtypes/{id}/usages/list": { "get": { "tags": [ "BoardSubTypes" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdSubtypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "subtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/teams": { "get": { "tags": [ "BoardTeams" ], "summary": "Get List of BoardTeam", "operationId": "getServiceBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "post": { "tags": [ "BoardTeams" ], "summary": "Post BoardTeam", "operationId": "postServiceBoardsByParentIdTeams", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "_boardTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } }, "required": true }, "responses": { "201": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "/service/boards/{parentId}/teams/count": { "get": { "tags": [ "BoardTeams" ], "summary": "Get Count of BoardTeam", "operationId": "getServiceBoardsByParentIdTeamsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/teams/info": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get List of BoardTeamInfos", "operationId": "getServiceBoardsByParentIdTeamsInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of boardTeamInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTeamInfo" } } } } } } } }, "/service/boards/{parentId}/teams/info/count": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get Count of BoardTeamInfo", "operationId": "getServiceBoardsByParentIdTeamsInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/teams/{id}": { "get": { "tags": [ "BoardTeams" ], "summary": "Get BoardTeam", "operationId": "getServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } }, "delete": { "tags": [ "BoardTeams" ], "summary": "Delete BoardTeam", "operationId": "deleteServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardTeams" ], "summary": "Put BoardTeam", "operationId": "putServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "_boardTeam", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } }, "required": true }, "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } }, "patch": { "tags": [ "BoardTeams" ], "summary": "Patch BoardTeam", "operationId": "patchServiceBoardsByParentIdTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTeam" } } } } } } }, "/service/boards/{parentId}/teams/{id}/info": { "get": { "tags": [ "BoardTeamInfos" ], "summary": "Get BoardTeamInfos", "operationId": "getServiceBoardsByParentIdTeamsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "BoardTeamInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTeamInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTeamInfo" } } } } } } }, "/service/boards/{parentId}/teams/{id}/usages/list": { "get": { "tags": [ "BoardTeams" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdTeamsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get List of BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociations", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTypeSubTypeItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTypeSubTypeItemAssociation" } } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations/count": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get Count of BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/typeSubTypeItemAssociations/{id}": { "get": { "tags": [ "BoardTypeSubTypeItemAssociation" ], "summary": "Get BoardTypeSubTypeItemAssociation", "operationId": "getServiceBoardsByParentIdTypeSubTypeItemAssociationsById", "parameters": [ { "name": "id", "in": "path", "description": "typeSubTypeItemAssociationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTypeSubTypeItemAssociation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTypeSubTypeItemAssociation" } } } } } } }, "/service/boards/{parentId}/types": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of BoardType", "operationId": "getServiceBoardsByParentIdTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "post": { "tags": [ "BoardTypes" ], "summary": "Post BoardType", "operationId": "postServiceBoardsByParentIdTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardType" } } }, "required": true }, "responses": { "201": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "/service/boards/{parentId}/types/count": { "get": { "tags": [ "BoardTypes" ], "summary": "Get Count of BoardType", "operationId": "getServiceBoardsByParentIdTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/boards/{parentId}/types/{id}": { "get": { "tags": [ "BoardTypes" ], "summary": "Get BoardType", "operationId": "getServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } }, "delete": { "tags": [ "BoardTypes" ], "summary": "Delete BoardType", "operationId": "deleteServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "BoardTypes" ], "summary": "Put BoardType", "operationId": "putServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "boardType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BoardType" } } }, "required": true }, "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } }, "patch": { "tags": [ "BoardTypes" ], "summary": "Patch BoardType", "operationId": "patchServiceBoardsByParentIdTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "BoardType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardType" } } } } } } }, "/service/boards/{parentId}/types/{id}/usages": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of Usage Count", "operationId": "getServiceBoardsByParentIdTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/boards/{parentId}/types/{id}/usages/list": { "get": { "tags": [ "BoardTypes" ], "summary": "Get List of Usage", "operationId": "getServiceBoardsByParentIdTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/codes": { "get": { "tags": [ "Codes" ], "summary": "Get List of Code", "operationId": "getServiceCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Code", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Code" } } } } } } }, "post": { "tags": [ "Codes" ], "summary": "Post Code", "operationId": "postServiceCodes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "201": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Code" } } } } } } }, "/service/codes/count": { "get": { "tags": [ "Codes" ], "summary": "Get Count of Code", "operationId": "getServiceCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/codes/{id}": { "get": { "tags": [ "Codes" ], "summary": "Get Code", "operationId": "getServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Code" } } } } } }, "delete": { "tags": [ "Codes" ], "summary": "Delete Code", "operationId": "deleteServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Codes" ], "summary": "Put Code", "operationId": "putServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "code", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Code" } } }, "required": true }, "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Code" } } } } } }, "patch": { "tags": [ "Codes" ], "summary": "Patch Code", "operationId": "patchServiceCodesById", "parameters": [ { "name": "id", "in": "path", "description": "codeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Code", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Code" } } } } } } }, "/service/emailTemplates": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of ServiceEmailTemplate", "operationId": "getServiceEmailTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "post": { "tags": [ "ServiceEmailTemplates" ], "summary": "Post ServiceEmailTemplate", "operationId": "postServiceEmailTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } }, "required": true }, "responses": { "201": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "/service/emailTemplates/count": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get Count of ServiceEmailTemplate", "operationId": "getServiceEmailTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/emailTemplates/{id}": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get ServiceEmailTemplate", "operationId": "getServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } }, "delete": { "tags": [ "ServiceEmailTemplates" ], "summary": "Delete ServiceEmailTemplate", "operationId": "deleteServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceEmailTemplates" ], "summary": "Put ServiceEmailTemplate", "operationId": "putServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceEmailTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } }, "patch": { "tags": [ "ServiceEmailTemplates" ], "summary": "Patch ServiceEmailTemplate", "operationId": "patchServiceEmailTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceEmailTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceEmailTemplate" } } } } } } }, "/service/emailTemplates/{id}/usages": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of Usage Count", "operationId": "getServiceEmailTemplatesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/emailTemplates/{id}/usages/list": { "get": { "tags": [ "ServiceEmailTemplates" ], "summary": "Get List of Usage", "operationId": "getServiceEmailTemplatesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "emailTemplateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/impacts": { "get": { "tags": [ "Impacts" ], "summary": "Get List of Impact", "operationId": "getServiceImpacts", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Impact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Impact" } } } } } } } }, "/service/impacts/count": { "get": { "tags": [ "Impacts" ], "summary": "Get Count of Impact", "operationId": "getServiceImpactsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/impacts/{id}": { "get": { "tags": [ "Impacts" ], "summary": "Get Impact", "operationId": "getServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } }, "put": { "tags": [ "Impacts" ], "summary": "Put Impact", "operationId": "putServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "impact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Impact" } } }, "required": true }, "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } }, "patch": { "tags": [ "Impacts" ], "summary": "Patch Impact", "operationId": "patchServiceImpactsById", "parameters": [ { "name": "id", "in": "path", "description": "impactId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Impact", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Impact" } } } } } } }, "/service/info/boards": { "get": { "tags": [ "BoardInfos" ], "summary": "Get List of BoardInfo", "operationId": "getServiceInfoBoards", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardInfo" } } } } } } } }, "/service/info/boards/active": { "get": { "tags": [ "BoardInfos" ], "summary": "Get List of active BoardInfo", "operationId": "getServiceInfoBoardsActive", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of active BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardInfo" } } } } } } } }, "/service/info/boards/count": { "get": { "tags": [ "BoardInfos" ], "summary": "Get Count of BoardInfo", "operationId": "getServiceInfoBoardsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/info/boards/{id}": { "get": { "tags": [ "BoardInfos" ], "summary": "Get BoardInfo", "operationId": "getServiceInfoBoardsById", "parameters": [ { "name": "id", "in": "path", "description": "boardId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardInfo" } } } } } } }, "/service/info/boardtypes": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get List of BoardTypeInfo", "operationId": "getServiceInfoBoardtypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of BoardTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BoardTypeInfo" } } } } } } } }, "/service/info/boardtypes/count": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get Count of BoardTypeInfo", "operationId": "getServiceInfoBoardtypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/info/boardtypes/{id}": { "get": { "tags": [ "BoardTypeInfos" ], "summary": "Get BoardTypeInfo", "operationId": "getServiceInfoBoardtypesById", "parameters": [ { "name": "id", "in": "path", "description": "boardtypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "BoardTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BoardTypeInfo" } } } } } } }, "/service/knowledgeBaseArticles": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get List of KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "post": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Post KnowledgeBaseArticle", "operationId": "postServiceKnowledgeBaseArticles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseArticle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "/service/knowledgeBaseArticles/count": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get Count of KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticlesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgeBaseArticles/{id}": { "get": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Get KnowledgeBaseArticle", "operationId": "getServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } }, "delete": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Delete KnowledgeBaseArticle", "operationId": "deleteServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Put KnowledgeBaseArticle", "operationId": "putServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseArticle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } }, "patch": { "tags": [ "KnowledgeBaseArticles" ], "summary": "Patch KnowledgeBaseArticle", "operationId": "patchServiceKnowledgeBaseArticlesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseArticleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseArticle", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseArticle" } } } } } } }, "/service/knowledgeBaseCategories": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get List of KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "post": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Post KnowledgeBaseCategory", "operationId": "postServiceKnowledgeBaseCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "/service/knowledgeBaseCategories/count": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get Count of KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgeBaseCategories/{id}": { "get": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Get KnowledgeBaseCategory", "operationId": "getServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } }, "delete": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Delete KnowledgeBaseCategory", "operationId": "deleteServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Put KnowledgeBaseCategory", "operationId": "putServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } }, "patch": { "tags": [ "KnowledgeBaseCategories" ], "summary": "Patch KnowledgeBaseCategory", "operationId": "patchServiceKnowledgeBaseCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseCategory" } } } } } } }, "/service/knowledgeBaseSubCategories": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategories", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "post": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Post KnowledgeBaseSubCategory", "operationId": "postServiceKnowledgeBaseSubCategories", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSubCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "/service/knowledgeBaseSubCategories/count": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get Count of KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategoriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/knowledgeBaseSubCategories/{id}": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get KnowledgeBaseSubCategory", "operationId": "getServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } }, "delete": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Delete KnowledgeBaseSubCategory", "operationId": "deleteServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Put KnowledgeBaseSubCategory", "operationId": "putServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSubCategory", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } }, "patch": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Patch KnowledgeBaseSubCategory", "operationId": "patchServiceKnowledgeBaseSubCategoriesById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSubCategory", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSubCategory" } } } } } } }, "/service/knowledgeBaseSubCategories/{id}/usages": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of Usage Count", "operationId": "getServiceKnowledgeBaseSubCategoriesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/knowledgeBaseSubCategories/{id}/usages/list": { "get": { "tags": [ "KnowledgeBaseSubCategories" ], "summary": "Get List of Usage", "operationId": "getServiceKnowledgeBaseSubCategoriesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "knowledgeBaseSubCategoryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/knowledgebasesettings": { "get": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Get KnowledgeBaseSettings", "operationId": "getServiceKnowledgebasesettings", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "post": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Post KnowledgeBaseSettings", "operationId": "postServiceKnowledgebasesettings", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } }, "required": true }, "responses": { "201": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } } }, "/service/knowledgebasesettings/{id}": { "get": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Get KnowledgeBaseSettings", "operationId": "getServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "put": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Put KnowledgeBaseSettings", "operationId": "putServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "knowledgeBaseSettings", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } }, "patch": { "tags": [ "KnowledgeBaseSettingses" ], "summary": "Patch KnowledgeBaseSettings", "operationId": "patchServiceKnowledgebasesettingsById", "parameters": [ { "name": "id", "in": "path", "description": "knowledgebasesettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "KnowledgeBaseSettings", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/KnowledgeBaseSettings" } } } } } } }, "/service/locations": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get List of ServiceLocation", "operationId": "getServiceLocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "post": { "tags": [ "ServiceLocations" ], "summary": "Post ServiceLocation", "operationId": "postServiceLocations", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } }, "required": true }, "responses": { "201": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "/service/locations/count": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get Count of ServiceLocation", "operationId": "getServiceLocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/locations/info": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get List of ServiceLocationInfos", "operationId": "getServiceLocationsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceLocationInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceLocationInfo" } } } } } } } }, "/service/locations/info/count": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get Count of ServiceLocationInfo", "operationId": "getServiceLocationsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/locations/{id}": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get ServiceLocation", "operationId": "getServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } }, "delete": { "tags": [ "ServiceLocations" ], "summary": "Delete ServiceLocation", "operationId": "deleteServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceLocations" ], "summary": "Put ServiceLocation", "operationId": "putServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } }, "required": true }, "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } }, "patch": { "tags": [ "ServiceLocations" ], "summary": "Patch ServiceLocation", "operationId": "patchServiceLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceLocation" } } } } } } }, "/service/locations/{id}/info": { "get": { "tags": [ "ServiceLocationInfos" ], "summary": "Get ServiceLocationInfos", "operationId": "getServiceLocationsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceLocationInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceLocationInfo" } } } } } } }, "/service/locations/{id}/usages": { "get": { "tags": [ "ServiceLocations" ], "summary": "Get List of Usage Count", "operationId": "getServiceLocationsByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/locations/{id}/usages/list": { "get": { "tags": [ "Locations" ], "summary": "Get List of Usage", "operationId": "getServiceLocationsByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/priorities": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Priority", "operationId": "getServicePriorities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Priority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Priority" } } } } } } }, "post": { "tags": [ "Priorities" ], "summary": "Post Priority", "operationId": "postServicePriorities", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "201": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } } }, "/service/priorities/count": { "get": { "tags": [ "Priorities" ], "summary": "Get Count of Priority", "operationId": "getServicePrioritiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/priorities/{id}": { "get": { "tags": [ "Priorities" ], "summary": "Get Priority", "operationId": "getServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } }, "delete": { "tags": [ "Priorities" ], "summary": "Delete Priority", "operationId": "deleteServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Priorities" ], "summary": "Put Priority", "operationId": "putServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "priority", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Priority" } } }, "required": true }, "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } }, "patch": { "tags": [ "Priorities" ], "summary": "Patch Priority", "operationId": "patchServicePrioritiesById", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Priority", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Priority" } } } } } } }, "/service/priorities/{id}/image": { "get": { "tags": [ "Priorities" ], "summary": "Get Priority", "operationId": "getServicePrioritiesByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "lastModified", "in": "path", "description": "lastModified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/service/priorities/{id}/usages": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Usage Count", "operationId": "getServicePrioritiesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/priorities/{id}/usages/list": { "get": { "tags": [ "Priorities" ], "summary": "Get List of Usage", "operationId": "getServicePrioritiesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "priorityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/priority/info": { "get": { "tags": [ "PriorityInfos" ], "summary": "Get List of PriorityInfos", "operationId": "getServicePriorityInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of priorityInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PriorityInfo" } } } } } } } }, "/service/priority/{id}/info": { "get": { "tags": [ "PriorityInfos" ], "summary": "Get PriorityInfos", "operationId": "getServicePriorityByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "PriorityInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PriorityInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PriorityInfo" } } } } } } }, "/service/severities": { "get": { "tags": [ "Severities" ], "summary": "Get List of Severity", "operationId": "getServiceSeverities", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Severity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Severity" } } } } } } } }, "/service/severities/count": { "get": { "tags": [ "Severities" ], "summary": "Get Count of Severity", "operationId": "getServiceSeveritiesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/severities/{id}": { "get": { "tags": [ "Severities" ], "summary": "Get Severity", "operationId": "getServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } }, "put": { "tags": [ "Severities" ], "summary": "Put Severity", "operationId": "putServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "severity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Severity" } } }, "required": true }, "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } }, "patch": { "tags": [ "Severities" ], "summary": "Patch Severity", "operationId": "patchServiceSeveritiesById", "parameters": [ { "name": "id", "in": "path", "description": "severityId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Severity", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Severity" } } } } } } }, "/service/slas/info": { "get": { "tags": [ "SLAInfos" ], "summary": "Get List of SLAInfos", "operationId": "getServiceSlasInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of sLAInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SLAInfo" } } } } } } } }, "/service/slas/{id}/info": { "get": { "tags": [ "SLAInfos" ], "summary": "Get SLAInfos", "operationId": "getServiceSlasByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SLAInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SLAInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SLAInfo" } } } } } } }, "/service/sources": { "get": { "tags": [ "Sources" ], "summary": "Get List of Source", "operationId": "getServiceSources", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Source", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Source" } } } } } } }, "post": { "tags": [ "Sources" ], "summary": "Post Source", "operationId": "postServiceSources", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "source", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "required": true }, "responses": { "201": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Source" } } } } } } }, "/service/sources/count": { "get": { "tags": [ "Sources" ], "summary": "Get Count of Source", "operationId": "getServiceSourcesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/sources/info": { "get": { "tags": [ "SourceInfos" ], "summary": "Get List of SourceInfos", "operationId": "getServiceSourcesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of sourceInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SourceInfo" } } } } } } } }, "/service/sources/info/count": { "get": { "tags": [ "SourceInfos" ], "summary": "Get Count of SourceInfo", "operationId": "getServiceSourcesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/sources/{id}": { "get": { "tags": [ "Sources" ], "summary": "Get Source", "operationId": "getServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Source" } } } } } }, "delete": { "tags": [ "Sources" ], "summary": "Delete Source", "operationId": "deleteServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Sources" ], "summary": "Put Source", "operationId": "putServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "source", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Source" } } }, "required": true }, "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Source" } } } } } }, "patch": { "tags": [ "Sources" ], "summary": "Patch Source", "operationId": "patchServiceSourcesById", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Source", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Source" } } } } } } }, "/service/sources/{id}/info": { "get": { "tags": [ "SourceInfos" ], "summary": "Get SourceInfos", "operationId": "getServiceSourcesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "SourceInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SourceInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SourceInfo" } } } } } } }, "/service/sources/{id}/usages": { "get": { "tags": [ "Sources" ], "summary": "Get List of Usage Count", "operationId": "getServiceSourcesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/sources/{id}/usages/list": { "get": { "tags": [ "Sources" ], "summary": "Get List of Usage", "operationId": "getServiceSourcesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "sourceId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/surveys": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of ServiceSurvey", "operationId": "getServiceSurveys", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "post": { "tags": [ "ServiceSurveys" ], "summary": "Post ServiceSurvey", "operationId": "postServiceSurveys", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } }, "required": true }, "responses": { "201": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/count": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get Count of ServiceSurvey", "operationId": "getServiceSurveysCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get List of SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "post": { "tags": [ "SurveyOptions" ], "summary": "Post SurveyOption", "operationId": "postServiceSurveysByGrandparentIdQuestionsByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyOption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } }, "required": true }, "responses": { "201": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options/count": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get Count of SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{grandparentId}/questions/{parentId}/options/{id}": { "get": { "tags": [ "SurveyOptions" ], "summary": "Get SurveyOption", "operationId": "getServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } }, "delete": { "tags": [ "SurveyOptions" ], "summary": "Delete SurveyOption", "operationId": "deleteServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyOptions" ], "summary": "Put SurveyOption", "operationId": "putServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyOption", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } }, "required": true }, "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } }, "patch": { "tags": [ "SurveyOptions" ], "summary": "Patch SurveyOption", "operationId": "patchServiceSurveysByGrandparentIdQuestionsByParentIdOptionsById", "parameters": [ { "name": "id", "in": "path", "description": "optionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyOption" } } } } } } }, "/service/surveys/{id}": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get ServiceSurvey", "operationId": "getServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } }, "delete": { "tags": [ "ServiceSurveys" ], "summary": "Delete ServiceSurvey", "operationId": "deleteServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceSurveys" ], "summary": "Put ServiceSurvey", "operationId": "putServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "survey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } }, "required": true }, "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } }, "patch": { "tags": [ "ServiceSurveys" ], "summary": "Patch ServiceSurvey", "operationId": "patchServiceSurveysById", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/{id}/copy": { "post": { "tags": [ "ServiceSurveys" ], "summary": "Post ServiceSurvey", "operationId": "postServiceSurveysByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurvey", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurvey" } } } } } } }, "/service/surveys/{id}/usages": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of Usage", "operationId": "getServiceSurveysByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/surveys/{id}/usages/list": { "get": { "tags": [ "ServiceSurveys" ], "summary": "Get List of Usage", "operationId": "getServiceSurveysByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/service/surveys/{parentId}/questions": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get List of ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "post": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Post ServiceSurveyQuestion", "operationId": "postServiceSurveysByParentIdQuestions", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSurveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } }, "required": true }, "responses": { "201": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/questions/count": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get Count of ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{parentId}/questions/{id}": { "get": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Get ServiceSurveyQuestion", "operationId": "getServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } }, "delete": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Delete ServiceSurveyQuestion", "operationId": "deleteServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Put ServiceSurveyQuestion", "operationId": "putServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceSurveyQuestion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } }, "required": true }, "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } }, "patch": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Patch ServiceSurveyQuestion", "operationId": "patchServiceSurveysByParentIdQuestionsById", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/questions/{id}/copy": { "post": { "tags": [ "ServiceSurveyQuestions" ], "summary": "Post ServiceSurveyQuestion", "operationId": "postServiceSurveysByParentIdQuestionsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "questionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "201": { "description": "ServiceSurveyQuestion", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceSurveyQuestion" } } } } } } }, "/service/surveys/{parentId}/results": { "get": { "tags": [ "SurveyResults" ], "summary": "Get List of SurveyResult", "operationId": "getServiceSurveysByParentIdResults", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "post": { "tags": [ "SurveyResults" ], "summary": "Post SurveyResult", "operationId": "postServiceSurveysByParentIdResults", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } }, "required": true }, "responses": { "201": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "/service/surveys/{parentId}/results/count": { "get": { "tags": [ "SurveyResults" ], "summary": "Get Count of SurveyResult", "operationId": "getServiceSurveysByParentIdResultsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/surveys/{parentId}/results/{id}": { "get": { "tags": [ "SurveyResults" ], "summary": "Get SurveyResult", "operationId": "getServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } }, "delete": { "tags": [ "SurveyResults" ], "summary": "Delete SurveyResult", "operationId": "deleteServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "SurveyResults" ], "summary": "Put SurveyResult", "operationId": "putServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "surveyResult", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } }, "required": true }, "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } }, "patch": { "tags": [ "SurveyResults" ], "summary": "Patch SurveyResult", "operationId": "patchServiceSurveysByParentIdResultsById", "parameters": [ { "name": "id", "in": "path", "description": "resultId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "surveyId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "SurveyResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SurveyResult" } } } } } } }, "/service/teamMembers": { "post": { "tags": [ "TeamMembers" ], "summary": "Post TeamMember", "operationId": "postServiceTeamMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "teamMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TeamMember" } } }, "required": true }, "responses": { "201": { "description": "TeamMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TeamMember" } } } } } } }, "/service/teams": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get List of ServiceTeam", "operationId": "getServiceTeams", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTeam" } } } } } } } }, "/service/teams/count": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get Count of ServiceTeam", "operationId": "getServiceTeamsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/teams/{id}": { "get": { "tags": [ "ServiceTeams" ], "summary": "Get ServiceTeam", "operationId": "getServiceTeamsById", "parameters": [ { "name": "id", "in": "path", "description": "teamId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTeam", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTeam" } } } } } } }, "/service/templates": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get List of ServiceTemplate", "operationId": "getServiceTemplates", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "post": { "tags": [ "ServiceTemplates" ], "summary": "Post ServiceTemplate", "operationId": "postServiceTemplates", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } } }, "/service/templates/count": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get Count of ServiceTemplate", "operationId": "getServiceTemplatesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/templates/info": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get List of ServiceTemplateInfos", "operationId": "getServiceTemplatesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceTemplateInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTemplateInfo" } } } } } } } }, "/service/templates/info/count": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get Count of ServiceTemplateInfo", "operationId": "getServiceTemplatesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/templates/{id}": { "get": { "tags": [ "ServiceTemplates" ], "summary": "Get ServiceTemplate", "operationId": "getServiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "put": { "tags": [ "ServiceTemplates" ], "summary": "Put ServiceTemplate", "operationId": "putServiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ServiceTemplate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "patch": { "tags": [ "ServiceTemplates" ], "summary": "Patch ServiceTemplate", "operationId": "patchServiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplate", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplate" } } } } } }, "delete": { "tags": [ "ServiceTemplates" ], "summary": "Delete ServiceTemplate", "operationId": "deleteServiceTemplatesById", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/templates/{id}/generate": { "post": { "tags": [ "ServiceTemplates" ], "summary": "Post Count of ServiceTemplate", "operationId": "postServiceTemplatesByIdGenerate", "parameters": [ { "name": "id", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "templateGenerate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TemplateGenerate" } } }, "required": true }, "responses": { "200": { "description": "TemplateGeneratedCountsModel", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TemplateGeneratedCountsModel" } } } } } } }, "/service/templates/{id}/info": { "get": { "tags": [ "ServiceTemplateInfos" ], "summary": "Get ServiceTemplateInfos", "operationId": "getServiceTemplatesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceTemplateInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplateInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplateInfo" } } } } } } }, "/service/templates/{parentId}/tasks": { "get": { "tags": [ "ServiceTemplateTasks" ], "summary": "Get List of Tasks", "operationId": "getServiceTemplatesByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Task", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTemplateTask" } } } } } } }, "post": { "tags": [ "ServiceTemplateTasks" ], "summary": "Post Task", "operationId": "postServiceTemplatesByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTemplateTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } }, "required": true }, "responses": { "201": { "description": "ServiceTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } } } } } }, "/service/templates/{parentId}/tasks/count": { "get": { "tags": [ "ServiceTemplateTasks" ], "summary": "Get Count of Tasks", "operationId": "getServiceTemplatesByParentIdTasksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/templates/{parentId}/tasks/{id}": { "get": { "tags": [ "ServiceTemplateTasks" ], "summary": "Get Task", "operationId": "getServiceTemplatesByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } } } } }, "delete": { "tags": [ "ServiceTemplateTasks" ], "summary": "Delete Task", "operationId": "deleteServiceTemplatesByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceTemplateTasks" ], "summary": "Put Task", "operationId": "putServiceTemplatesByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTemplateTask", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } } } } }, "patch": { "tags": [ "ServiceTemplateTasks" ], "summary": "Patch Task", "operationId": "patchServiceTemplatesByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "templateId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTemplateTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTemplateTask" } } } } } } }, "/service/ticketLinks": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get List of ServiceTicketLink", "operationId": "getServiceTicketLinks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "post": { "tags": [ "ServiceTicketLinks" ], "summary": "Post ServiceTicketLink", "operationId": "postServiceTicketLinks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTicketLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } }, "required": true }, "responses": { "201": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "/service/ticketLinks/count": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get Count of ServiceTicketLink", "operationId": "getServiceTicketLinksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/ticketLinks/info": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get List of ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of serviceTicketLinkInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketLinkInfo" } } } } } } } }, "/service/ticketLinks/info/count": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get Count of ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/ticketLinks/{id}": { "get": { "tags": [ "ServiceTicketLinks" ], "summary": "Get ServiceTicketLink", "operationId": "getServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } }, "delete": { "tags": [ "ServiceTicketLinks" ], "summary": "Delete ServiceTicketLink", "operationId": "deleteServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ServiceTicketLinks" ], "summary": "Put ServiceTicketLink", "operationId": "putServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceTicketLink", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } }, "required": true }, "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } }, "patch": { "tags": [ "ServiceTicketLinks" ], "summary": "Patch ServiceTicketLink", "operationId": "patchServiceTicketLinksById", "parameters": [ { "name": "id", "in": "path", "description": "ticketLinkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTicketLink", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTicketLink" } } } } } } }, "/service/ticketLinks/{id}/info": { "get": { "tags": [ "ServiceTicketLinkInfos" ], "summary": "Get ServiceTicketLinkInfos", "operationId": "getServiceTicketLinksByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "ServiceTicketLinkInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTicketLinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTicketLinkInfo" } } } } } } }, "/service/ticketSyncs": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get List of TicketSync", "operationId": "getServiceTicketSyncs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "post": { "tags": [ "TicketSyncs" ], "summary": "Post TicketSync", "operationId": "postServiceTicketSyncs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSync" } } }, "required": true }, "responses": { "201": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "/service/ticketSyncs/count": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get Count of TicketSync", "operationId": "getServiceTicketSyncsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/ticketSyncs/{id}": { "get": { "tags": [ "TicketSyncs" ], "summary": "Get TicketSync", "operationId": "getServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } }, "delete": { "tags": [ "TicketSyncs" ], "summary": "Delete TicketSync", "operationId": "deleteServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketSyncs" ], "summary": "Put TicketSync", "operationId": "putServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticketSync", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketSync" } } }, "required": true }, "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } }, "patch": { "tags": [ "TicketSyncs" ], "summary": "Patch TicketSync", "operationId": "patchServiceTicketSyncsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketSyncId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TicketSync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketSync" } } } } } } }, "/service/tickets": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket\r\n To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "operationId": "getServiceTickets", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Post Ticket", "operationId": "postServiceTickets", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } }, "required": true }, "responses": { "201": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/calculateSla": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket with SLA calculated", "operationId": "getServiceTicketsCalculateSla", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/service/tickets/changelogs": { "get": { "tags": [ "TicketChangeLog" ], "summary": "Get List of Ticket Change Log", "operationId": "getServiceTicketsChangelogs", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TicketChangeLog", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketChangeLog" } } } } } } }, "delete": { "tags": [ "TicketChangeLog" ], "summary": "Delete Ticket Change Logs", "operationId": "deleteServiceTicketsChangelogs", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/tickets/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ConnectWise.Apis.v3_0.v2015_3.Service.Ticket.Ticket", "operationId": "getServiceTicketsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/info": { "get": { "tags": [ "TicketInfos" ], "summary": "Get List of TicketInfos", "operationId": "getServiceTicketsInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ticketInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TicketInfo" } } } } } } } }, "/service/tickets/info/count": { "get": { "tags": [ "TicketInfos" ], "summary": "Get Count of TicketInfo", "operationId": "getServiceTicketsInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/search": { "post": { "tags": [ "Tickets" ], "summary": "Post List of Ticket", "operationId": "postServiceTicketsSearch", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "filterValues", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FilterValues" } } }, "required": true }, "responses": { "200": { "description": "List of Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Ticket" } } } } } } } }, "/service/tickets/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get Ticket", "operationId": "getServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete Ticket", "operationId": "deleteServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Tickets" ], "summary": "Put Ticket", "operationId": "putServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "ticket", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Ticket" } } }, "required": true }, "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } }, "patch": { "tags": [ "Tickets" ], "summary": "Patch Ticket", "operationId": "patchServiceTicketsById", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/{id}/copy": { "post": { "tags": [ "Tickets" ], "summary": "Post TicketCopy", "operationId": "postServiceTicketsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Ticket", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Ticket" } } } } } } }, "/service/tickets/{id}/info": { "get": { "tags": [ "TicketInfos" ], "summary": "Get TicketInfos", "operationId": "getServiceTicketsByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "TicketInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TicketInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TicketInfo" } } } } } } }, "/service/tickets/{parentId}/activities": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ActivityReference\r\n Gets activities associated to the ticket\r\n Please use the /sales/activities?conditions=ticket/id={id} endpoint", "operationId": "getServiceTicketsByParentIdActivities", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ActivityReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ActivityReference" } } } } } } } }, "/service/tickets/{parentId}/activities/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ActivityReference\r\n Gets count of activities associated to the ticket\r\n Please use the /sales/activities/count?conditions=ticket/id={id} endpoint", "operationId": "getServiceTicketsByParentIdActivitiesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/allNotes": { "get": { "tags": [ "ServiceTicketNotes" ], "summary": "Get List of ServiceTicketNote", "operationId": "getServiceTicketsByParentIdAllNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceTicketNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTicketNote" } } } } } } } }, "/service/tickets/{parentId}/attachChildren": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdAttachChildren", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "bundle", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketBundle" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/configurations": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "post": { "tags": [ "Tickets" ], "summary": "Post ConfigurationReference", "operationId": "postServiceTicketsByParentIdConfigurations", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "configuration", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } }, "required": true }, "responses": { "201": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } } }, "/service/tickets/{parentId}/configurations/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/configurations/{id}": { "get": { "tags": [ "Tickets" ], "summary": "Get ConfigurationReference", "operationId": "getServiceTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ConfigurationReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ConfigurationReference" } } } } } }, "delete": { "tags": [ "Tickets" ], "summary": "Delete ConfigurationReference", "operationId": "deleteServiceTicketsByParentIdConfigurationsById", "parameters": [ { "name": "id", "in": "path", "description": "configurationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/service/tickets/{parentId}/convert": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdConvert", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "conversion", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConvertToProject" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/documents": { "get": { "tags": [ "Tickets" ], "summary": "Get List of DocumentReference\r\n Gets the documents associated to the ticket\r\n Please use the /system/documents?recordType=Ticket&recordId={id} endpoint", "operationId": "getServiceTicketsByParentIdDocuments", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentReference" } } } } } } } }, "/service/tickets/{parentId}/documents/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of DocumentReference", "operationId": "getServiceTicketsByParentIdDocumentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/merge": { "post": { "tags": [ "Tickets" ], "summary": "Post SuccessResponse", "operationId": "postServiceTicketsByParentIdMerge", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "merge", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TicketMerge" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/service/tickets/{parentId}/notes": { "get": { "tags": [ "TicketNotes" ], "summary": "Get List of ServiceNote", "operationId": "getServiceTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "post": { "tags": [ "TicketNotes" ], "summary": "Post ServiceNote", "operationId": "postServiceTicketsByParentIdNotes", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } }, "required": true }, "responses": { "201": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "/service/tickets/{parentId}/notes/count": { "get": { "tags": [ "TicketNotes" ], "summary": "Get Count of ServiceNote", "operationId": "getServiceTicketsByParentIdNotesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/notes/{id}": { "get": { "tags": [ "TicketNotes" ], "summary": "Get ServiceNote", "operationId": "getServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } }, "delete": { "tags": [ "TicketNotes" ], "summary": "Delete ServiceNote", "operationId": "deleteServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketNotes" ], "summary": "Put ServiceNote", "operationId": "putServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "serviceNote", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } }, "required": true }, "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } }, "patch": { "tags": [ "TicketNotes" ], "summary": "Patch ServiceNote", "operationId": "patchServiceTicketsByParentIdNotesById", "parameters": [ { "name": "id", "in": "path", "description": "noteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceNote", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceNote" } } } } } } }, "/service/tickets/{parentId}/products": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdProducts", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ProductReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ProductReference" } } } } } } } }, "/service/tickets/{parentId}/products/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ProductReference\r\n Gets the products associated to the ticket\r\n Please use the /procurement/products/count?conditions=chargeToType='Ticket' AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdProductsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/scheduleentries": { "get": { "tags": [ "Tickets" ], "summary": "Get List of ScheduleEntryReference\r\n Gets the schedule entries associated to the ticket\r\n Please use the /schedule/entries?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getServiceTicketsByParentIdScheduleentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ScheduleEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ScheduleEntryReference" } } } } } } } }, "/service/tickets/{parentId}/scheduleentries/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of ScheduleEntryReference\r\n Gets the schedule entries count associated to the ticket\r\n Please use the /schedule/entries/count?conditions=type/id=4 AND objectId={id} endpoint", "operationId": "getServiceTicketsByParentIdScheduleentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/tasks": { "get": { "tags": [ "TicketTasks" ], "summary": "Get List of Task", "operationId": "getServiceTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Task", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "post": { "tags": [ "TicketTasks" ], "summary": "Post Task", "operationId": "postServiceTicketsByParentIdTasks", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } }, "required": true }, "responses": { "201": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "/service/tickets/{parentId}/tasks/count": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Count of Task", "operationId": "getServiceTicketsByParentIdTasksCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/service/tickets/{parentId}/tasks/{id}": { "get": { "tags": [ "TicketTasks" ], "summary": "Get Task", "operationId": "getServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } }, "delete": { "tags": [ "TicketTasks" ], "summary": "Delete Task", "operationId": "deleteServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TicketTasks" ], "summary": "Put Task", "operationId": "putServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "task", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } }, "required": true }, "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } }, "patch": { "tags": [ "TicketTasks" ], "summary": "Patch Task", "operationId": "patchServiceTicketsByParentIdTasksById", "parameters": [ { "name": "id", "in": "path", "description": "taskId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ServiceTask", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ServiceTask" } } } } } } }, "/service/tickets/{parentId}/timeentries": { "get": { "tags": [ "Tickets" ], "summary": "Get List of TimeEntryReference\r\n Gets time entries associated to the ticket\r\n Please use the /time/entries?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdTimeentries", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryReference", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryReference" } } } } } } } }, "/service/tickets/{parentId}/timeentries/count": { "get": { "tags": [ "Tickets" ], "summary": "Get Count of TimeEntryReference\r\n Gets time entries count associated to the ticket\r\n Please use the /time/entries/count?conditions=(chargeToType=\"ServiceTicket\" OR chargeToType=\"ProjectTicket\") AND chargeToId={id} endpoint", "operationId": "getServiceTicketsByParentIdTimeentriesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "ticketId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/apiMembers": { "get": { "tags": [ "ApiMembers" ], "summary": "Get List of ApiMember", "operationId": "getSystemApiMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "post": { "tags": [ "ApiMembers" ], "summary": "Post ApiMember", "operationId": "postSystemApiMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apiMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiMember" } } }, "required": true }, "responses": { "201": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/apiMembers/count": { "get": { "tags": [ "ApiMembers" ], "summary": "Get Count of", "operationId": "getSystemApiMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/apiMembers/default": { "get": { "tags": [ "ApiMembers" ], "summary": "Get ApiMember", "operationId": "getSystemApiMembersDefault", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/apiMembers/{id}": { "get": { "tags": [ "ApiMembers" ], "summary": "Get ApiMember", "operationId": "getSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } }, "put": { "tags": [ "ApiMembers" ], "summary": "Put ApiMember", "operationId": "putSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "apiMember", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApiMember" } } }, "required": true }, "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } }, "patch": { "tags": [ "ApiMembers" ], "summary": "Patch ApiMember", "operationId": "patchSystemApiMembersById", "parameters": [ { "name": "id", "in": "path", "description": "apiMemberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ApiMember", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ApiMember" } } } } } } }, "/system/callbacks": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get List of CallbackEntry", "operationId": "getSystemCallbacks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "post": { "tags": [ "CallbackEntries" ], "summary": "Post CallbackEntry", "operationId": "postSystemCallbacks", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "callbackEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } }, "required": true }, "responses": { "201": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "/system/callbacks/count": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get Count of CallbackEntry", "operationId": "getSystemCallbacksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/callbacks/{id}": { "get": { "tags": [ "CallbackEntries" ], "summary": "Get CallbackEntry", "operationId": "getSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } }, "delete": { "tags": [ "CallbackEntries" ], "summary": "Delete CallbackEntry", "operationId": "deleteSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "CallbackEntries" ], "summary": "Put CallbackEntry", "operationId": "putSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "callbackEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } }, "required": true }, "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } }, "patch": { "tags": [ "CallbackEntries" ], "summary": "Patch CallbackEntry", "operationId": "patchSystemCallbacksById", "parameters": [ { "name": "id", "in": "path", "description": "callbackId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "CallbackEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/CallbackEntry" } } } } } } }, "/system/documents": { "get": { "tags": [ "Documents" ], "summary": "Get List of DocumentInfo", "operationId": "getSystemDocuments", "parameters": [ { "name": "recordType", "in": "query", "description": "recordType", "schema": { "enum": [ "Activity", "Agreement", "Company", "Config", "Configuration", "Contact", "CustomImage", "Document", "Expense", "HTMLTemplate", "Invoice", "Opportunity", "Project", "ProjectActivity", "PurchaseOrder", "Rma", "SalesOrder", "Service", "Ticket", "ProjectTicket", "ServiceTemplate", "StandardServiceTemplate", "SrDetail", "TimeEntry", "JobHeader", "MarketingManagerAudit", "KnowledgeBase", "ToolbarIcon", "Meeting", "MeetingNote", "ProductSetup", "ProjectTemplateTicket", "BillingSetup", "ServiceBoard", "WordTemplate", "Member", "PortalImagePortalLogo", "PortalImageReportLogo", "TopNavigationLogo", "PhaseStatus", "ProjectStatus", "TicketStatus", "Schedule", "Priority", "Unassigned" ], "type": "string" } }, { "name": "recordId", "in": "query", "description": "recordId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "post": { "tags": [ "Documents" ], "summary": "Post DocumentInfo", "operationId": "postSystemDocuments", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "Multipart", "content": { "multipart/form-data": { "schema": { "$ref": "#/components/schemas/DocumentFormData" } } }, "required": true }, "responses": { "201": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "/system/documents/count": { "get": { "tags": [ "Documents" ], "summary": "Get Count of DocumentInfo", "operationId": "getSystemDocumentsCount", "parameters": [ { "name": "recordType", "in": "query", "description": "recordType", "schema": { "enum": [ "Activity", "Agreement", "Company", "Config", "Configuration", "Contact", "CustomImage", "Document", "Expense", "HTMLTemplate", "Invoice", "Opportunity", "Project", "ProjectActivity", "PurchaseOrder", "Rma", "SalesOrder", "Service", "Ticket", "ProjectTicket", "ServiceTemplate", "StandardServiceTemplate", "SrDetail", "TimeEntry", "JobHeader", "MarketingManagerAudit", "KnowledgeBase", "ToolbarIcon", "Meeting", "MeetingNote", "ProductSetup", "ProjectTemplateTicket", "BillingSetup", "ServiceBoard", "WordTemplate", "Member", "PortalImagePortalLogo", "PortalImageReportLogo", "TopNavigationLogo", "PhaseStatus", "ProjectStatus", "TicketStatus", "Schedule", "Priority", "Unassigned" ], "type": "string" } }, { "name": "recordId", "in": "query", "description": "recordId", "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/documents/uploadsample": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsUploadsample", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = text/html" } } } }, "/system/documents/{id}": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } }, "delete": { "tags": [ "Documents" ], "summary": "Delete DocumentInfo", "operationId": "deleteSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "post": { "tags": [ "Documents" ], "summary": "Post DocumentInfo", "operationId": "postSystemDocumentsById", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DocumentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/DocumentInfo" } } } } } } }, "/system/documents/{id}/download": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsByIdDownload", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModified", "in": "query", "description": "lastModified", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/system/documents/{id}/thumbnail": { "get": { "tags": [ "Documents" ], "summary": "Get DocumentInfo", "operationId": "getSystemDocumentsByIdThumbnail", "parameters": [ { "name": "id", "in": "path", "description": "documentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "lastModified", "in": "query", "description": "lastModified", "schema": { "type": "string" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream", "content": { "application/octet-stream": { "schema": { "type": "string", "format": "binary" } } } } } } }, "/system/info": { "get": { "tags": [ "Info" ], "summary": "Get Info", "operationId": "getSystemInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Info", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Info" } } } } } } }, "/system/info/departmentlocations": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get List of DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DepartmentLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentLocationInfo" } } } } } } } }, "/system/info/departmentlocations/count": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get Count of DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/departmentlocations/{id}": { "get": { "tags": [ "DepartmentLocationInfos" ], "summary": "Get DepartmentLocationInfo", "operationId": "getSystemInfoDepartmentlocationsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentlocationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DepartmentLocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/DepartmentLocationInfo" } } } } } } }, "/system/info/departments": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get List of DepartmentInfo", "operationId": "getSystemInfoDepartments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of DepartmentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/DepartmentInfo" } } } } } } } }, "/system/info/departments/count": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get Count of DepartmentInfo", "operationId": "getSystemInfoDepartmentsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/departments/{id}": { "get": { "tags": [ "DepartmentInfos" ], "summary": "Get DepartmentInfo", "operationId": "getSystemInfoDepartmentsById", "parameters": [ { "name": "id", "in": "path", "description": "departmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "DepartmentInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/DepartmentInfo" } } } } } } }, "/system/info/links": { "get": { "tags": [ "LinkInfos" ], "summary": "Get List of LinkInfo", "operationId": "getSystemInfoLinks", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LinkInfo" } } } } } } } }, "/system/info/links/count": { "get": { "tags": [ "LinkInfos" ], "summary": "Get Count of LinkInfo", "operationId": "getSystemInfoLinksCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/links/{id}": { "get": { "tags": [ "LinkInfos" ], "summary": "Get LinkInfo", "operationId": "getSystemInfoLinksById", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LinkInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/LinkInfo" } } } } } } }, "/system/info/links/{id}/resolveurl": { "post": { "tags": [ "LinkInfos" ], "summary": "Post LinkResolveUrlInfo", "operationId": "postSystemInfoLinksByIdResolveurl", "parameters": [ { "name": "id", "in": "path", "description": "linkId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "resolveInfo", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LinkResolveUrlInfo" } } }, "required": true }, "responses": { "201": { "description": "LinkResolveUrlInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/LinkResolveUrlInfo" } } } } } } }, "/system/info/locales": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get List of LocaleInfo", "operationId": "getSystemInfoLocales", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocaleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocaleInfo" } } } } } } } }, "/system/info/locales/count": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get Count of LocaleInfo", "operationId": "getSystemInfoLocalesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/locales/{id}": { "get": { "tags": [ "LocaleInfos" ], "summary": "Get LocaleInfo", "operationId": "getSystemInfoLocalesById", "parameters": [ { "name": "id", "in": "path", "description": "localeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocaleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/LocaleInfo" } } } } } } }, "/system/info/locations": { "get": { "tags": [ "LocationInfos" ], "summary": "Get List of LocationInfo", "operationId": "getSystemInfoLocations", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of LocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/LocationInfo" } } } } } } } }, "/system/info/locations/count": { "get": { "tags": [ "LocationInfos" ], "summary": "Get Count of LocationInfo", "operationId": "getSystemInfoLocationsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/locations/{id}": { "get": { "tags": [ "LocationInfos" ], "summary": "Get LocationInfo", "operationId": "getSystemInfoLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "LocationInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/LocationInfo" } } } } } } }, "/system/info/members": { "get": { "tags": [ "MemberInfos" ], "summary": "Get List of MemberInfo", "operationId": "getSystemInfoMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberInfo" } } } } } } } }, "/system/info/members/count": { "get": { "tags": [ "MemberInfos" ], "summary": "Get Count of MemberInfo", "operationId": "getSystemInfoMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/members/{id}": { "get": { "tags": [ "MemberInfos" ], "summary": "Get MemberInfo", "operationId": "getSystemInfoMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberInfo" } } } } } } }, "/system/info/members/{memberIdentifier:regex(^(types. |(": { "get": { "tags": [ "MemberInfos" ], "summary": "Get MemberInfo", "operationId": "getSystemInfoMembersmemberIdentifierregextypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberInfo" } } } } } } }, "/system/info/personas": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get List of PersonasInfo", "operationId": "getSystemInfoPersonas", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of PersonasInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PersonasInfo" } } } } } } } }, "/system/info/personas/count": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get Count of PersonasInfo", "operationId": "getSystemInfoPersonasCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/personas/{id}": { "get": { "tags": [ "PersonasInfos" ], "summary": "Get PersonasInfo", "operationId": "getSystemInfoPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "PersonasInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/PersonasInfo" } } } } } } }, "/system/info/standardNotes": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get List of StandardNoteInfo", "operationId": "getSystemInfoStandardNotes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of StandardNoteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/StandardNoteInfo" } } } } } } } }, "/system/info/standardNotes/count": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get Count of StandardNoteInfo", "operationId": "getSystemInfoStandardNotesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/info/standardNotes/{id}": { "get": { "tags": [ "StandardNoteInfos" ], "summary": "Get StandardNoteInfo", "operationId": "getSystemInfoStandardNotesById", "parameters": [ { "name": "id", "in": "path", "description": "standardNoteId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "StandardNoteInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/StandardNoteInfo" } } } } } } }, "/system/members": { "get": { "tags": [ "Members" ], "summary": "Get List of Member", "operationId": "getSystemMembers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } } } }, "post": { "tags": [ "Members" ], "summary": "Post Member", "operationId": "postSystemMembers", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } }, "required": true }, "responses": { "201": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/calendarsync": { "get": { "tags": [ "Members" ], "summary": "Get List of Member to be use for calendar sync subscriptions", "operationId": "getSystemMembersCalendarsync", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member for calendar sync", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberForCalSync" } } } } } } } }, "/system/members/count": { "get": { "tags": [ "Members" ], "summary": "Get Count of Usage", "operationId": "getSystemMembersCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/types": { "get": { "tags": [ "MemberTypes" ], "summary": "Get List of MemberType", "operationId": "getSystemMembersTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "post": { "tags": [ "MemberTypes" ], "summary": "Post MemberType", "operationId": "postSystemMembersTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberType" } } }, "required": true }, "responses": { "201": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "/system/members/types/count": { "get": { "tags": [ "MemberTypes" ], "summary": "Get Count of MemberType", "operationId": "getSystemMembersTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/types/info": { "get": { "tags": [ "MemberTypes" ], "summary": "Get List of MemberType", "operationId": "getSystemMembersTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberTypeInfo" } } } } } } } }, "/system/members/types/info/count": { "get": { "tags": [ "MemberTypes" ], "summary": "Get Count of MemberType", "operationId": "getSystemMembersTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/types/{id}": { "get": { "tags": [ "MemberTypes" ], "summary": "Get MemberType", "operationId": "getSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } }, "delete": { "tags": [ "MemberTypes" ], "summary": "Delete MemberType", "operationId": "deleteSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberTypes" ], "summary": "Put MemberType", "operationId": "putSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberType" } } }, "required": true }, "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } }, "patch": { "tags": [ "MemberTypes" ], "summary": "Patch MemberType", "operationId": "patchSystemMembersTypesById", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberType" } } } } } } }, "/system/members/types/{id}/info": { "get": { "tags": [ "MemberTypes" ], "summary": "Get MemberType", "operationId": "getSystemMembersTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "typeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberTypeInfo" } } } } } } }, "/system/members/withSso": { "get": { "tags": [ "Members" ], "summary": "Get List of Member", "operationId": "getSystemMembersWithSso", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Member" } } } } } } } }, "/system/members/{id}": { "get": { "tags": [ "Members" ], "summary": "Get Member", "operationId": "getSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Member" } } } } } }, "put": { "tags": [ "Members" ], "summary": "Put Member", "operationId": "putSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "member", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Member" } } }, "required": true }, "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Member" } } } } } }, "patch": { "tags": [ "Members" ], "summary": "Patch Member", "operationId": "patchSystemMembersById", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/{id}/deactivate": { "post": { "tags": [ "Members" ], "summary": "Post MemberDeactivation", "operationId": "postSystemMembersByIdDeactivate", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDeactivation" } } }, "required": true }, "responses": { "200": { "description": "MemberDeactivation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberDeactivation" } } } } } } }, "/system/members/{id}/image": { "get": { "tags": [ "MemberImages" ], "summary": "Get", "operationId": "getSystemMembersByIdImage", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "useDefaultFlag", "in": "path", "description": "useDefaultFlag", "required": true, "schema": { "type": "boolean" } }, { "name": "lastmodified", "in": "path", "description": "lastmodified", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ContentType = application/octet-stream" } } } }, "/system/members/{id}/linkSsoUser": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdLinkSsoUser", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberLinkSsoUser" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/submit": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdSubmit", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "item", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSsoToken" } } }, "required": true }, "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/unlinkSsoUser": { "post": { "tags": [ "Members" ], "summary": "Post SuccessResponse", "operationId": "postSystemMembersByIdUnlinkSsoUser", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "SuccessResponse", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/SuccessResponse" } } } } } } }, "/system/members/{id}/unusedTimeSheets": { "delete": { "tags": [ "Members" ], "summary": "Delete Member", "operationId": "deleteSystemMembersByIdUnusedTimeSheets", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/members/{id}/usages": { "get": { "tags": [ "Members" ], "summary": "Get List of Usage Count", "operationId": "getSystemMembersByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/members/{id}/usages/list": { "get": { "tags": [ "Members" ], "summary": "Get List of Usage", "operationId": "getSystemMembersByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/system/members/{memberIdentifier:regex(^(types. |(": { "get": { "tags": [ "Members" ], "summary": "Get Member", "operationId": "getSystemMembersmemberIdentifierregextypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } }, { "name": "memberIdentifier", "in": "path", "description": "memberIdentifier", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Member", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Member" } } } } } } }, "/system/members/{memberIdentifier}/tokens": { "post": { "tags": [ "Members" ], "summary": "Post Token", "operationId": "postSystemMembersByMemberIdentifierTokens", "parameters": [ { "name": "memberIdentifier", "in": "path", "description": "memberIdentifier", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Token", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Token" } } } } } } }, "/system/members/{parentId}/accruals": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get List of MemberAccrual", "operationId": "getSystemMembersByParentIdAccruals", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "post": { "tags": [ "MemberAccruals" ], "summary": "Post MemberAccrual", "operationId": "postSystemMembersByParentIdAccruals", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } }, "required": true }, "responses": { "201": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "/system/members/{parentId}/accruals/count": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get Count of MemberAccrual", "operationId": "getSystemMembersByParentIdAccrualsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/accruals/{id}": { "get": { "tags": [ "MemberAccruals" ], "summary": "Get MemberAccrual", "operationId": "getSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } }, "delete": { "tags": [ "MemberAccruals" ], "summary": "Delete MemberAccrual", "operationId": "deleteSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberAccruals" ], "summary": "Put MemberAccrual", "operationId": "putSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberAccrual", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } }, "required": true }, "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } }, "patch": { "tags": [ "MemberAccruals" ], "summary": "Patch MemberAccrual", "operationId": "patchSystemMembersByParentIdAccrualsById", "parameters": [ { "name": "id", "in": "path", "description": "accrualId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberAccrual", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberAccrual" } } } } } } }, "/system/members/{parentId}/certifications": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get List of MemberCertification", "operationId": "getSystemMembersByParentIdCertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "post": { "tags": [ "MemberCertifications" ], "summary": "Post MemberCertification", "operationId": "postSystemMembersByParentIdCertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "201": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/certifications/count": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get Count of MemberCertification", "operationId": "getSystemMembersByParentIdCertificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/certifications/{id}": { "get": { "tags": [ "MemberCertifications" ], "summary": "Get MemberCertification", "operationId": "getSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "delete": { "tags": [ "MemberCertifications" ], "summary": "Delete MemberCertification", "operationId": "deleteSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberCertifications" ], "summary": "Put MemberCertification", "operationId": "putSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "patch": { "tags": [ "MemberCertifications" ], "summary": "Patch MemberCertification", "operationId": "patchSystemMembersByParentIdCertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "certificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/delegations": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get List of MemberDelegation", "operationId": "getSystemMembersByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "post": { "tags": [ "MemberDelegations" ], "summary": "Post MemberDelegation", "operationId": "postSystemMembersByParentIdDelegations", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "201": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/members/{parentId}/delegations/count": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get Count of MemberDelegation", "operationId": "getSystemMembersByParentIdDelegationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/delegations/{id}": { "get": { "tags": [ "MemberDelegations" ], "summary": "Get MemberDelegation", "operationId": "getSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "delete": { "tags": [ "MemberDelegations" ], "summary": "Delete MemberDelegation", "operationId": "deleteSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberDelegations" ], "summary": "Put MemberDelegation", "operationId": "putSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberDelegation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } }, "patch": { "tags": [ "MemberDelegations" ], "summary": "Patch MemberDelegation", "operationId": "patchSystemMembersByParentIdDelegationsById", "parameters": [ { "name": "id", "in": "path", "description": "delegationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberDelegation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberDelegation" } } } } } } }, "/system/members/{parentId}/managedDeviceAccounts": { "get": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Get List of ManagedDeviceAccount", "operationId": "getSystemMembersByParentIdManagedDeviceAccounts", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ManagedDeviceAccount", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDeviceAccount" } } } } } } } }, "/system/members/{parentId}/managedDeviceAccounts/bulk": { "delete": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Delete BulkResult", "operationId": "deleteSystemMembersByParentIdManagedDeviceAccountsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "managedDeviceAccounts", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IdCollection" } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } }, "put": { "tags": [ "ManagedDeviceAccounts" ], "summary": "Put BulkResult", "operationId": "putSystemMembersByParentIdManagedDeviceAccountsBulk", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of ManagedDeviceAccount", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ManagedDeviceAccount" } } } }, "required": true }, "responses": { "207": { "description": "BulkResult", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/BulkResult" } } } } } } }, "/system/members/{parentId}/mycertifications": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get List of MemberCertification", "operationId": "getSystemMembersByParentIdMycertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "post": { "tags": [ "MyMemberCertifications" ], "summary": "Post MemberCertification", "operationId": "postSystemMembersByParentIdMycertifications", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "201": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/mycertifications/count": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get Count of MemberCertification", "operationId": "getSystemMembersByParentIdMycertificationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/mycertifications/{id}": { "get": { "tags": [ "MyMemberCertifications" ], "summary": "Get MemberCertification", "operationId": "getSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "delete": { "tags": [ "MyMemberCertifications" ], "summary": "Delete MemberCertification", "operationId": "deleteSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MyMemberCertifications" ], "summary": "Put MemberCertification", "operationId": "putSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberCertification", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } }, "patch": { "tags": [ "MyMemberCertifications" ], "summary": "Patch MemberCertification", "operationId": "patchSystemMembersByParentIdMycertificationsById", "parameters": [ { "name": "id", "in": "path", "description": "mycertificationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberCertification", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberCertification" } } } } } } }, "/system/members/{parentId}/notificationSettings": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get List of MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "post": { "tags": [ "MemberNotificationSettings" ], "summary": "Post MemberNotificationSetting", "operationId": "postSystemMembersByParentIdNotificationSettings", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberNotificationSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } }, "required": true }, "responses": { "201": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "/system/members/{parentId}/notificationSettings/count": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get Count of MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettingsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/notificationSettings/{id}": { "get": { "tags": [ "MemberNotificationSettings" ], "summary": "Get MemberNotificationSetting", "operationId": "getSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } }, "delete": { "tags": [ "MemberNotificationSettings" ], "summary": "Delete MemberNotificationSetting", "operationId": "deleteSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberNotificationSettings" ], "summary": "Put MemberNotificationSetting", "operationId": "putSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberNotificationSetting", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } }, "required": true }, "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } }, "patch": { "tags": [ "MemberNotificationSettings" ], "summary": "Patch MemberNotificationSetting", "operationId": "patchSystemMembersByParentIdNotificationSettingsById", "parameters": [ { "name": "id", "in": "path", "description": "notificationSettingId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberNotificationSetting", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberNotificationSetting" } } } } } } }, "/system/members/{parentId}/personas": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get List of MemberPersona", "operationId": "getSystemMembersByParentIdPersonas", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "post": { "tags": [ "MemberPersonas" ], "summary": "Post MemberPersona", "operationId": "postSystemMembersByParentIdPersonas", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberPersona", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } }, "required": true }, "responses": { "201": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "/system/members/{parentId}/personas/count": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get Count of MemberPersona", "operationId": "getSystemMembersByParentIdPersonasCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/personas/{id}": { "get": { "tags": [ "MemberPersonas" ], "summary": "Get MemberPersona", "operationId": "getSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } }, "delete": { "tags": [ "MemberPersonas" ], "summary": "Delete MemberPersona", "operationId": "deleteSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberPersonas" ], "summary": "Put MemberPersona", "operationId": "putSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberPersona", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } }, "required": true }, "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } }, "patch": { "tags": [ "MemberPersonas" ], "summary": "Patch MemberPersona", "operationId": "patchSystemMembersByParentIdPersonasById", "parameters": [ { "name": "id", "in": "path", "description": "personaId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberPersona", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberPersona" } } } } } } }, "/system/members/{parentId}/skills": { "get": { "tags": [ "MemberSkills" ], "summary": "Get List of MemberSkill", "operationId": "getSystemMembersByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "post": { "tags": [ "MemberSkills" ], "summary": "Post MemberSkill", "operationId": "postSystemMembersByParentIdSkills", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "201": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/members/{parentId}/skills/count": { "get": { "tags": [ "MemberSkills" ], "summary": "Get Count of MemberSkill", "operationId": "getSystemMembersByParentIdSkillsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/members/{parentId}/skills/{id}": { "get": { "tags": [ "MemberSkills" ], "summary": "Get MemberSkill", "operationId": "getSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "delete": { "tags": [ "MemberSkills" ], "summary": "Delete MemberSkill", "operationId": "deleteSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "MemberSkills" ], "summary": "Put MemberSkill", "operationId": "putSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "memberSkill", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } }, "patch": { "tags": [ "MemberSkills" ], "summary": "Patch MemberSkill", "operationId": "patchSystemMembersByParentIdSkillsById", "parameters": [ { "name": "id", "in": "path", "description": "skillId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "memberId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "MemberSkill", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/MemberSkill" } } } } } } }, "/system/members/{ssoid}/deactivateIamMember": { "post": { "tags": [ "Members" ], "summary": "Delete Member Via IAM", "operationId": "postSystemMembersBySsoidDeactivateIamMember", "parameters": [ { "name": "ssoid", "in": "path", "description": "ssoId", "required": true, "schema": { "type": "string" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/workflowActions/automateParameters": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get List of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsAutomateParameters", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } } }, "/system/workflowActions/automateParameters/{id}": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get List of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "post": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Post WorkflowActionAutomateParameter", "operationId": "postSystemWorkflowActionsByParentIdAutomateParameters", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionAutomateParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } }, "required": true }, "responses": { "201": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters/count": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get Count of WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParametersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflowActions/{parentId}/automateParameters/{id}": { "get": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Get WorkflowActionAutomateParameter", "operationId": "getSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } }, "delete": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Delete WorkflowActionAutomateParameter", "operationId": "deleteSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Put WorkflowActionAutomateParameter", "operationId": "putSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionAutomateParameter", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } }, "patch": { "tags": [ "WorkflowActionAutomateParameters" ], "summary": "Patch WorkflowActionAutomateParameter", "operationId": "patchSystemWorkflowActionsByParentIdAutomateParametersById", "parameters": [ { "name": "id", "in": "path", "description": "automateParameterId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowActionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionAutomateParameter", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionAutomateParameter" } } } } } } }, "/system/workflows": { "get": { "tags": [ "Workflows" ], "summary": "Get List of Workflow", "operationId": "getSystemWorkflows", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "post": { "tags": [ "Workflows" ], "summary": "Post Workflow", "operationId": "postSystemWorkflows", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "required": true }, "responses": { "201": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/attachments": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get List of WorkflowAttachment", "operationId": "getSystemWorkflowsAttachments", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/attachments/{id}": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get WorkflowAttachment", "operationId": "getSystemWorkflowsAttachmentsById", "parameters": [ { "name": "id", "in": "path", "description": "attachmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/count": { "get": { "tags": [ "Workflows" ], "summary": "Get Count of Workflow", "operationId": "getSystemWorkflowsCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/events": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get List of WorkflowEvent", "operationId": "getSystemWorkflowsEvents", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } } }, "/system/workflows/events/actions": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get List of WorkflowAction", "operationId": "getSystemWorkflowsEventsActions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } } }, "/system/workflows/events/actions/{id}": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get WorkflowAction", "operationId": "getSystemWorkflowsEventsActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/events/{id}": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get WorkflowEvent", "operationId": "getSystemWorkflowsEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/notifyTypes": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyType", "operationId": "getSystemWorkflowsNotifyTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/notifyTypes/{id}": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyType", "operationId": "getSystemWorkflowsNotifyTypesById", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/tableTypes": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get List of WorkflowTableType", "operationId": "getSystemWorkflowsTableTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTableType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTableType" } } } } } } } }, "/system/workflows/tableTypes/count": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get Count of WorkflowTableType", "operationId": "getSystemWorkflowsTableTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/tableTypes/info": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get List of WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTableTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTableTypeInfo" } } } } } } } }, "/system/workflows/tableTypes/info/count": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get Count of WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/tableTypes/{id}": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get WorkflowTableType", "operationId": "getSystemWorkflowsTableTypesById", "parameters": [ { "name": "id", "in": "path", "description": "tableTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowTableType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowTableType" } } } } } } }, "/system/workflows/tableTypes/{id}/info": { "get": { "tags": [ "WorkflowTableTypes" ], "summary": "Get WorkflowTableTypeInfo", "operationId": "getSystemWorkflowsTableTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "tableTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowTableTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowTableTypeInfo" } } } } } } }, "/system/workflows/triggers": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get List of WorkflowTrigger", "operationId": "getSystemWorkflowsTriggers", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTrigger", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } } } } } } } }, "/system/workflows/triggers/options": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get List of WorkflowTriggerOption", "operationId": "getSystemWorkflowsTriggersOptions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTriggerOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTriggerOption" } } } } } } } }, "/system/workflows/userdefinedfields/actions/{parentId}": { "delete": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Delete WorkflowActionUserDefinedField", "operationId": "deleteSystemWorkflowsUserdefinedfieldsActionsByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } } }, "/system/workflows/userdefinedfields/events/actions": { "get": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Get List of WorkflowActionUserDefinedField", "operationId": "getSystemWorkflowsUserdefinedfieldsEventsActions", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } } }, "/system/workflows/userdefinedfields/events/{grandparentId}": { "post": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Post WorkflowActionUserDefinedField", "operationId": "postSystemWorkflowsUserdefinedfieldsEventsByGrandparentId", "parameters": [ { "name": "grandparentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionUserDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } }, "required": true }, "responses": { "201": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } }, "/system/workflows/userdefinedfields/events/{grandparentId}/actions/{parentId}": { "get": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Get List of WorkflowActionUserDefinedField", "operationId": "getSystemWorkflowsUserdefinedfieldsEventsByGrandparentIdActionsByParentId", "parameters": [ { "name": "parentId", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "evnetId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } } }, "/system/workflows/userdefinedfields/{id}": { "put": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Put WorkflowActionUserDefinedField", "operationId": "putSystemWorkflowsUserdefinedfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowActionUserDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowActionUserDefinedField", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } }, "patch": { "tags": [ "WorkflowActionUserDefinedFields" ], "summary": "Patch WorkflowActionUserDefinedField", "operationId": "patchSystemWorkflowsUserdefinedfieldsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowActionUserDefinedFieldId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowActionUserDefinedField", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowActionUserDefinedField" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get List of WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "post": { "tags": [ "WorkflowActions" ], "summary": "Post WorkflowAction", "operationId": "postSystemWorkflowsByGrandparentIdEventsByParentIdActions", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } }, "required": true }, "responses": { "201": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions/count": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get Count of WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{grandparentId}/events/{parentId}/actions/{id}": { "get": { "tags": [ "WorkflowActions" ], "summary": "Get WorkflowAction", "operationId": "getSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } }, "delete": { "tags": [ "WorkflowActions" ], "summary": "Delete WorkflowAction", "operationId": "deleteSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowActions" ], "summary": "Put WorkflowAction", "operationId": "putSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowAction", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } }, "required": true }, "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } }, "patch": { "tags": [ "WorkflowActions" ], "summary": "Patch WorkflowAction", "operationId": "patchSystemWorkflowsByGrandparentIdEventsByParentIdActionsById", "parameters": [ { "name": "id", "in": "path", "description": "actionId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowAction", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAction" } } } } } } }, "/system/workflows/{grandparentId}/triggers/{parentId}/options": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get List of WorkflowTriggerOption", "operationId": "getSystemWorkflowsByGrandparentIdTriggersByParentIdOptions", "parameters": [ { "name": "parentId", "in": "path", "description": "triggerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTriggerOption", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTriggerOption" } } } } } } } }, "/system/workflows/{grandparentId}/triggers/{parentId}/options/count": { "get": { "tags": [ "WorkflowTriggerOptions" ], "summary": "Get Count of WorkflowTriggerOption", "operationId": "getSystemWorkflowsByGrandparentIdTriggersByParentIdOptionsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "triggerId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "grandparentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{id}": { "get": { "tags": [ "Workflows" ], "summary": "Get Workflow", "operationId": "getSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } }, "delete": { "tags": [ "Workflows" ], "summary": "Delete Workflow", "operationId": "deleteSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "Workflows" ], "summary": "Put Workflow", "operationId": "putSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflow", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Workflow" } } }, "required": true }, "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } }, "patch": { "tags": [ "Workflows" ], "summary": "Patch Workflow", "operationId": "patchSystemWorkflowsById", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/{id}/copy": { "post": { "tags": [ "Workflows" ], "summary": "Post Workflow", "operationId": "postSystemWorkflowsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Workflow", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Workflow" } } } } } } }, "/system/workflows/{parentId}/attachments": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get List of WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachments", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } } }, "/system/workflows/{parentId}/attachments/count": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get Count of WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachmentsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/attachments/{id}": { "get": { "tags": [ "WorkflowAttachments" ], "summary": "Get WorkflowAttachment", "operationId": "getSystemWorkflowsByParentIdAttachmentsById", "parameters": [ { "name": "id", "in": "path", "description": "attachmentId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowAttachment", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowAttachment" } } } } } } }, "/system/workflows/{parentId}/events": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get List of WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEvents", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "post": { "tags": [ "WorkflowEvents" ], "summary": "Post WorkflowEvent", "operationId": "postSystemWorkflowsByParentIdEvents", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowEvent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } }, "required": true }, "responses": { "201": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/count": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get Count of WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEventsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/events/{id}": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get WorkflowEvent", "operationId": "getSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } }, "delete": { "tags": [ "WorkflowEvents" ], "summary": "Delete WorkflowEvent", "operationId": "deleteSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkflowEvents" ], "summary": "Put WorkflowEvent", "operationId": "putSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workflowEvent", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } }, "required": true }, "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } }, "patch": { "tags": [ "WorkflowEvents" ], "summary": "Patch WorkflowEvent", "operationId": "patchSystemWorkflowsByParentIdEventsById", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/{id}/copy": { "post": { "tags": [ "WorkflowEvents" ], "summary": "Post WorkflowEvent", "operationId": "postSystemWorkflowsByParentIdEventsByIdCopy", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowEvent", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowEvent" } } } } } } }, "/system/workflows/{parentId}/events/{id}/test": { "get": { "tags": [ "WorkflowEvents" ], "summary": "Get workflow test results", "operationId": "getSystemWorkflowsByParentIdEventsByIdTest", "parameters": [ { "name": "id", "in": "path", "description": "eventId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of test results", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "object" } } } } } } } } }, "/system/workflows/{parentId}/notifyTypes": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } } }, "/system/workflows/{parentId}/notifyTypes/count": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get Count of WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/info": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get List of WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesInfo", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowNotifyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowNotifyTypeInfo" } } } } } } } }, "/system/workflows/{parentId}/notifyTypes/info/count": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get Count of WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesInfoCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/{id}": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyType", "operationId": "getSystemWorkflowsByParentIdNotifyTypesById", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowNotifyType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowNotifyType" } } } } } } }, "/system/workflows/{parentId}/notifyTypes/{id}/info": { "get": { "tags": [ "WorkflowNotifyTypes" ], "summary": "Get WorkflowNotifyTypeInfo", "operationId": "getSystemWorkflowsByParentIdNotifyTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "notifyTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkflowNotifyTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkflowNotifyTypeInfo" } } } } } } }, "/system/workflows/{parentId}/triggers": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get List of WorkflowTrigger", "operationId": "getSystemWorkflowsByParentIdTriggers", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkflowTrigger", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkflowTrigger" } } } } } } } }, "/system/workflows/{parentId}/triggers/count": { "get": { "tags": [ "WorkflowTriggers" ], "summary": "Get Count of WorkflowTrigger", "operationId": "getSystemWorkflowsByParentIdTriggersCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workflowId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of ChargeCode", "operationId": "getTimeChargeCodes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "post": { "tags": [ "ChargeCodes" ], "summary": "Post ChargeCode", "operationId": "postTimeChargeCodes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } }, "required": true }, "responses": { "201": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "/time/chargeCodes/count": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get Count of ChargeCode", "operationId": "getTimeChargeCodesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes/info": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of ChargeCodeInfo", "operationId": "getTimeChargeCodesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCodeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCodeInfo" } } } } } } } }, "/time/chargeCodes/info/count": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get Count of ChargeCodeInfo", "operationId": "getTimeChargeCodesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes/{id}": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get ChargeCode", "operationId": "getTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } }, "delete": { "tags": [ "ChargeCodes" ], "summary": "Delete ChargeCode", "operationId": "deleteTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ChargeCodes" ], "summary": "Put ChargeCode", "operationId": "putTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCode", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } }, "required": true }, "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } }, "patch": { "tags": [ "ChargeCodes" ], "summary": "Patch ChargeCode", "operationId": "patchTimeChargeCodesById", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ChargeCode", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCode" } } } } } } }, "/time/chargeCodes/{id}/info": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get ChargeCodeInfo", "operationId": "getTimeChargeCodesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCodeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCodeInfo" } } } } } } }, "/time/chargeCodes/{id}/usages": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of Usage Count", "operationId": "getTimeChargeCodesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/chargeCodes/{id}/usages/list": { "get": { "tags": [ "ChargeCodes" ], "summary": "Get List of Usage", "operationId": "getTimeChargeCodesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get List of ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "post": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Post ChargeCodeExpenseType", "operationId": "postTimeChargeCodesByParentIdExpenseTypes", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCodeExpenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } }, "required": true }, "responses": { "201": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes/count": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get Count of ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypesCount", "parameters": [ { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/chargeCodes/{parentId}/expenseTypes/{id}": { "get": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Get ChargeCodeExpenseType", "operationId": "getTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } }, "delete": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Delete ChargeCodeExpenseType", "operationId": "deleteTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Put ChargeCodeExpenseType", "operationId": "putTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "chargeCodeExpenseType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } }, "required": true }, "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } }, "patch": { "tags": [ "ChargeCodeExpenseTypes" ], "summary": "Patch ChargeCodeExpenseType", "operationId": "patchTimeChargeCodesByParentIdExpenseTypesById", "parameters": [ { "name": "id", "in": "path", "description": "expenseTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "chargeCodeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "ChargeCodeExpenseType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/ChargeCodeExpenseType" } } } } } } }, "/time/entries": { "get": { "tags": [ "TimeEntries" ], "summary": "Get List of TimeEntry", "operationId": "getTimeEntries", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "post": { "tags": [ "TimeEntries" ], "summary": "Post TimeEntry", "operationId": "postTimeEntries", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "201": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/entries/count": { "get": { "tags": [ "TimeEntries" ], "summary": "Get Count of TimeEntry", "operationId": "getTimeEntriesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/entries/defaults": { "post": { "tags": [ "TimeEntries" ], "summary": "Post TimeEntry", "operationId": "postTimeEntriesDefaults", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/entries/{id}": { "get": { "tags": [ "TimeEntries" ], "summary": "Get TimeEntry", "operationId": "getTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "delete": { "tags": [ "TimeEntries" ], "summary": "Delete TimeEntry", "operationId": "deleteTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "TimeEntries" ], "summary": "Put TimeEntry", "operationId": "putTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntry", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } }, "patch": { "tags": [ "TimeEntries" ], "summary": "Patch TimeEntry", "operationId": "patchTimeEntriesById", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "TimeEntry", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntry" } } } } } } }, "/time/entries/{id}/cancelReject": { "post": { "tags": [ "TimeEntries" ], "summary": "Cancel the Rejection of a Time Entry", "operationId": "postTimeEntriesByIdCancelReject", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntryTierUpdate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryTierUpdate" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/time/entries/{id}/detach": { "post": { "tags": [ "TimeEntries" ], "summary": "Detch TimeEntry", "operationId": "postTimeEntriesByIdDetach", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeEntry" } } } }, "/time/entries/{id}/reject": { "post": { "tags": [ "TimeEntries" ], "summary": "Reject a Time Entry", "operationId": "postTimeEntriesByIdReject", "parameters": [ { "name": "id", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "timeEntryTierUpdate", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TimeEntryTierReject" } } }, "required": true }, "responses": { "204": { "description": "No Content" } } } }, "/time/entries/{parentId}/audits": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get List of TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAudits", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of TimeEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/TimeEntryAudit" } } } } } } } }, "/time/entries/{parentId}/audits/count": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get Count of TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAuditsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/entries/{parentId}/audits/{id}": { "get": { "tags": [ "TimeEntryAudits" ], "summary": "Get TimeEntryAudit", "operationId": "getTimeEntriesByParentIdAuditsById", "parameters": [ { "name": "id", "in": "path", "description": "auditId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "entryId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "TimeEntryAudit", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/TimeEntryAudit" } } } } } } }, "/time/workRoles": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of WorkRole", "operationId": "getTimeWorkRoles", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "post": { "tags": [ "WorkRoles" ], "summary": "Post WorkRole", "operationId": "postTimeWorkRoles", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRole" } } }, "required": true }, "responses": { "201": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "/time/workRoles/count": { "get": { "tags": [ "WorkRoles" ], "summary": "Get Count of WorkRole", "operationId": "getTimeWorkRolesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workRoles/info": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of WorkRoleInfo", "operationId": "getTimeWorkRolesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRoleInfo" } } } } } } } }, "/time/workRoles/info/count": { "get": { "tags": [ "WorkRoles" ], "summary": "Get Count of WorkRoleInfo", "operationId": "getTimeWorkRolesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workRoles/{id}": { "get": { "tags": [ "WorkRoles" ], "summary": "Get WorkRole", "operationId": "getTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } }, "delete": { "tags": [ "WorkRoles" ], "summary": "Delete Usage", "operationId": "deleteTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkRoles" ], "summary": "Put WorkRole", "operationId": "putTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRole", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRole" } } }, "required": true }, "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } }, "patch": { "tags": [ "WorkRoles" ], "summary": "Patch WorkRole", "operationId": "patchTimeWorkRolesById", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkRole", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRole" } } } } } } }, "/time/workRoles/{id}/info": { "get": { "tags": [ "WorkRoles" ], "summary": "Get WorkRoleInfo", "operationId": "getTimeWorkRolesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRoleInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRoleInfo" } } } } } } }, "/time/workRoles/{id}/usages": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of Usage Count", "operationId": "getTimeWorkRolesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workRoles/{id}/usages/list": { "get": { "tags": [ "WorkRoles" ], "summary": "Get List of Usage", "operationId": "getTimeWorkRolesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workRoles/{parentId}/locations": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get List of WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "post": { "tags": [ "WorkRoleLocations" ], "summary": "Post WorkRoleLocation", "operationId": "postTimeWorkRolesByParentIdLocations", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } }, "required": true }, "responses": { "201": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "/time/workRoles/{parentId}/locations/count": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get Count of WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocationsCount", "parameters": [ { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workRoles/{parentId}/locations/{id}": { "get": { "tags": [ "WorkRoleLocations" ], "summary": "Get WorkRoleLocation", "operationId": "getTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } }, "delete": { "tags": [ "WorkRoleLocations" ], "summary": "Delete WorkRoleLocation", "operationId": "deleteTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkRoleLocations" ], "summary": "Put WorkRoleLocation", "operationId": "putTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workRoleLocation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } }, "required": true }, "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } }, "patch": { "tags": [ "WorkRoleLocations" ], "summary": "Patch WorkRoleLocation", "operationId": "patchTimeWorkRolesByParentIdLocationsById", "parameters": [ { "name": "id", "in": "path", "description": "locationId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "parentId", "in": "path", "description": "workRoleId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkRoleLocation", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkRoleLocation" } } } } } } }, "/time/workTypes": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of WorkType", "operationId": "getTimeWorkTypes", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "post": { "tags": [ "WorkTypes" ], "summary": "Post WorkType", "operationId": "postTimeWorkTypes", "parameters": [ { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkType" } } }, "required": true }, "responses": { "201": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "/time/workTypes/count": { "get": { "tags": [ "WorkTypes" ], "summary": "Get Count of WorkType", "operationId": "getTimeWorkTypesCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workTypes/info": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get List of WorkTypeInfos", "operationId": "getTimeWorkTypesInfo", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of workTypeInfoses", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/WorkTypeInfo" } } } } } } } }, "/time/workTypes/info/count": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get Count of WorkTypeInfos", "operationId": "getTimeWorkTypesInfoCount", "parameters": [ { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Count", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/Count" } } } } } } }, "/time/workTypes/{id}": { "get": { "tags": [ "WorkTypes" ], "summary": "Get WorkType", "operationId": "getTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } }, "delete": { "tags": [ "WorkTypes" ], "summary": "Delete WorkType", "operationId": "deleteTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "No Content" } } }, "put": { "tags": [ "WorkTypes" ], "summary": "Put WorkType", "operationId": "putTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "workType", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WorkType" } } }, "required": true }, "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } }, "patch": { "tags": [ "WorkTypes" ], "summary": "Patch WorkType", "operationId": "patchTimeWorkTypesById", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "requestBody": { "description": "List of PatchOperation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/PatchOperation" } } } }, "required": true }, "responses": { "200": { "description": "WorkType", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkType" } } } } } } }, "/time/workTypes/{id}/info": { "get": { "tags": [ "WorkTypeInfos" ], "summary": "Get WorkTypeInfos", "operationId": "getTimeWorkTypesByIdInfo", "parameters": [ { "name": "id", "in": "path", "description": "WorkTypeInfoId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "WorkTypeInfo", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "$ref": "#/components/schemas/WorkTypeInfo" } } } } } } }, "/time/workTypes/{id}/usages": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of Usage Count", "operationId": "getTimeWorkTypesByIdUsages", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } }, "/time/workTypes/{id}/usages/list": { "get": { "tags": [ "WorkTypes" ], "summary": "Get List of Usage", "operationId": "getTimeWorkTypesByIdUsagesList", "parameters": [ { "name": "id", "in": "path", "description": "workTypeId", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "conditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "childConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "customFieldConditions", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "orderBy", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "fields", "in": "query", "description": "", "schema": { "type": "string" } }, { "name": "page", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageSize", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "pageId", "in": "query", "description": "", "schema": { "type": "integer", "format": "int32", "nullable": true } }, { "name": "clientId", "in": "header", "description": "", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "List of Usage", "content": { "application/vnd.connectwise.com+json; version=2025.16": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Usage" } } } } } } } } }, "components": { "schemas": { "Activity": { "required": [ "name", "assignTo" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/ActivityTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "email": { "type": "string", "description": " Max length: 250;" }, "status": { "$ref": "#/components/schemas/ActivityStatusReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "campaign": { "$ref": "#/components/schemas/CampaignReference" }, "notes": { "type": "string" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "assignedBy": { "$ref": "#/components/schemas/MemberReference" }, "assignTo": { "$ref": "#/components/schemas/MemberReference" }, "scheduleStatus": { "$ref": "#/components/schemas/ScheduleStatusReference" }, "reminder": { "$ref": "#/components/schemas/ReminderReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "notifyFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ActivityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "spawnFollowupFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ActivityStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ActivityType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "points": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "emailFlag": { "type": "boolean", "nullable": true }, "memoFlag": { "type": "boolean", "nullable": true }, "historyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ActivityTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Addition": { "required": [ "product", "billCustomer" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "product": { "$ref": "#/components/schemas/IvItemReference" }, "quantity": { "type": "number", "format": "double", "nullable": true }, "lessIncluded": { "type": "number", "format": "double", "nullable": true }, "unitPrice": { "type": "number", "format": "double", "nullable": true }, "unitCost": { "type": "number", "format": "double", "nullable": true }, "billCustomer": { "enum": [ "Billable", "DoNotBill", "NoCharge" ], "type": "string", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "cancelledDate": { "type": "string", "format": "date-time" }, "taxableFlag": { "type": "boolean", "nullable": true }, "serialNumber": { "type": "string", "description": " Max length: 50;" }, "invoiceDescription": { "type": "string", "description": " Max length: 6000;" }, "purchaseItemFlag": { "type": "boolean", "nullable": true }, "specialOrderFlag": { "type": "boolean", "nullable": true }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "billedQuantity": { "type": "number", "format": "double", "nullable": true }, "uom": { "type": "string" }, "extPrice": { "type": "number", "format": "double", "nullable": true }, "extCost": { "type": "number", "format": "double", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "margin": { "type": "number", "format": "double", "nullable": true }, "prorateCost": { "type": "number", "format": "double", "nullable": true }, "proratePrice": { "type": "number", "format": "double", "nullable": true }, "extendedProrateCost": { "type": "number", "format": "double", "nullable": true }, "extendedProratePrice": { "type": "number", "format": "double", "nullable": true }, "prorateCurrentPeriodFlag": { "type": "boolean", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreementStatus": { "enum": [ "Active", "Cancelled", "Expired", "Inactive" ], "type": "string", "nullable": true }, "invoiceGrouping": { "$ref": "#/components/schemas/InvoiceGroupingReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Agreement": { "required": [ "name", "type", "company", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/AgreementTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "subContractCompany": { "$ref": "#/components/schemas/CompanyReference" }, "subContractContact": { "$ref": "#/components/schemas/ContactReference" }, "parentAgreement": { "$ref": "#/components/schemas/AgreementReference" }, "customerPO": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "noEndingDateFlag": { "type": "boolean", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "cancelledFlag": { "type": "boolean", "nullable": true }, "dateCancelled": { "type": "string", "format": "date-time" }, "reasonCancelled": { "type": "string", "description": " Max length: 100;" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "workOrder": { "type": "string", "description": " Max length: 20;" }, "internalNotes": { "type": "string" }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "applicationLimit": { "type": "number", "format": "double", "nullable": true }, "applicationCycle": { "enum": [ "Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear" ], "type": "string", "nullable": true }, "applicationUnlimitedFlag": { "type": "boolean", "nullable": true }, "oneTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementTime": { "type": "boolean", "nullable": true }, "coverAgreementProduct": { "type": "boolean", "nullable": true }, "coverAgreementExpense": { "type": "boolean", "nullable": true }, "coverSalesTax": { "type": "boolean", "nullable": true }, "carryOverUnused": { "type": "boolean", "nullable": true }, "allowOverruns": { "type": "boolean", "nullable": true }, "expiredDays": { "type": "integer", "format": "int32", "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "expireWhenZero": { "type": "boolean", "nullable": true }, "chargeToFirm": { "type": "boolean", "nullable": true }, "employeeCompRate": { "enum": [ "Actual", "Hourly" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "employeeCompNotExceed": { "enum": [ "Billing", "Amount", "Percent" ], "type": "string", "nullable": true }, "compHourlyRate": { "type": "number", "format": "double", "nullable": true }, "compLimitAmount": { "type": "number", "format": "double", "nullable": true }, "billingCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "billOneTimeFlag": { "type": "boolean", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoicingCycle": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "billAmount": { "type": "number", "format": "double", "nullable": true }, "taxable": { "type": "boolean", "nullable": true }, "prorateFirstBill": { "type": "number", "format": "double", "nullable": true }, "billStartDate": { "type": "string", "format": "date-time" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "restrictDownPayment": { "type": "boolean", "nullable": true }, "prorateFlag": { "type": "boolean", "nullable": true }, "invoiceProratedAdditionsFlag": { "type": "boolean", "nullable": true }, "invoiceDescription": { "type": "string" }, "topComment": { "type": "boolean", "nullable": true }, "bottomComment": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "projectType": { "$ref": "#/components/schemas/ProjectTypeReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billableTimeInvoice": { "type": "boolean", "nullable": true }, "billableExpenseInvoice": { "type": "boolean", "nullable": true }, "billableProductInvoice": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "periodType": { "enum": [ "Current", "Future", "Both", "Undefined" ], "type": "string", "nullable": true }, "autoInvoiceFlag": { "type": "boolean", "nullable": true }, "nextInvoiceDate": { "type": "string" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "agreementStatus": { "enum": [ "Active", "Cancelled", "Expired", "Inactive" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Agreement.Adjustment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "amount": { "type": "number", "format": "double", "nullable": true }, "description": { "type": "string", "description": " Max length: 1000;" }, "effectiveDate": { "type": "string", "format": "date-time" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "AgreementApplicationAviablePer": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationBillingCycle": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationLimit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementApplicationParameters": { "type": "object", "properties": { "applicationUnit": { "$ref": "#/components/schemas/AgreementApplicationUnit" }, "applicationLimit": { "$ref": "#/components/schemas/AgreementApplicationLimit" }, "applicationLimitAmount": { "type": "number", "format": "double" }, "availablePer": { "$ref": "#/components/schemas/AgreementApplicationAviablePer" }, "coversTimeFlag": { "type": "boolean" }, "coversExpensesFlag": { "type": "boolean" }, "coversProductsFlag": { "type": "boolean" }, "coversTaxFlag": { "type": "boolean" }, "carryoverUnusedFlag": { "type": "boolean" }, "carryOverDays": { "type": "integer", "format": "int32", "nullable": true }, "allowOverrunsFlag": { "type": "boolean" }, "overrunLimit": { "type": "integer", "format": "int32", "nullable": true }, "agreementExpiresFlag": { "type": "boolean" }, "chargeAdjustmentsFlag": { "type": "boolean" }, "prepayFlag": { "type": "boolean" }, "agrBillingCycle": { "$ref": "#/components/schemas/AgreementApplicationBillingCycle" }, "userDefinedFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldValueModel" } } } }, "AgreementApplicationUnit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "AgreementRecurringParameters": { "type": "object", "properties": { "billingCycle": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "cycleBase": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "aGRAmount": { "type": "number", "format": "double", "nullable": true }, "taxable": { "type": "boolean" }, "childrenAmount": { "type": "number", "format": "double" }, "additionsAmount": { "type": "number", "format": "double" }, "totalAmount": { "type": "number", "format": "double" }, "aGRProrate": { "type": "number", "format": "double", "nullable": true }, "billStartDate": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "terms": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "prorateFlag": { "type": "boolean" }, "invoiceProratedAdditionsFlag": { "type": "boolean" }, "restrictDownpayment": { "type": "boolean" }, "currency": { "$ref": "#/components/schemas/GenericNameIdDTO" }, "autoInvoiceFlag": { "type": "boolean" }, "userDefinedFieldValues": { "type": "array", "items": { "$ref": "#/components/schemas/UserDefinedFieldValueModel" } } } }, "AgreementReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "type": { "type": "string" }, "chargeFirmFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementSite": { "required": [ "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "AgreementTabsCount": { "type": "object" }, "AgreementType": { "required": [ "name", "employeeCompRate", "employeeCompNotExceed", "invoicingCycle", "billTime", "billExpenses", "billProducts" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "prefixSuffixOption": { "enum": [ "Prefix", "Suffix" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "prePaymentFlag": { "type": "boolean", "nullable": true }, "invoicePreSuffix": { "type": "string", "description": " Max length: 5;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "applicationLimit": { "type": "number", "format": "double", "nullable": true }, "applicationCycle": { "enum": [ "Contract2Weeks", "Contract4Weeks", "ContractYear", "CalendarMonth", "CalendarQuarter", "CalendarWeek", "ContractQuarter", "CalendarYear" ], "type": "string", "nullable": true }, "applicationUnlimitedFlag": { "type": "boolean", "nullable": true }, "oneTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementTimeFlag": { "type": "boolean", "nullable": true }, "coverAgreementProductFlag": { "type": "boolean", "nullable": true }, "coverAgreementExpenseFlag": { "type": "boolean", "nullable": true }, "coverSalesTaxFlag": { "type": "boolean", "nullable": true }, "carryOverUnusedFlag": { "type": "boolean", "nullable": true }, "allowOverrunsFlag": { "type": "boolean", "nullable": true }, "expiredDays": { "type": "integer", "format": "int32", "nullable": true }, "limit": { "type": "integer", "format": "int32", "nullable": true }, "expireWhenZero": { "type": "boolean", "nullable": true }, "chargeToFirmFlag": { "type": "boolean", "nullable": true }, "employeeCompRate": { "enum": [ "Actual", "Hourly" ], "type": "string", "nullable": true }, "employeeCompNotExceed": { "enum": [ "Billing", "Amount", "Percent" ], "type": "string", "nullable": true }, "compHourlyRate": { "type": "number", "format": "double", "nullable": true }, "compLimitAmount": { "type": "number", "format": "double", "nullable": true }, "billingCycle": { "$ref": "#/components/schemas/BillingCycleReference" }, "billOneTimeFlag": { "type": "boolean", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoicingCycle": { "enum": [ "ContractYear", "CalendarYear" ], "type": "string", "nullable": true }, "billAmount": { "type": "number", "format": "double", "nullable": true }, "taxableFlag": { "type": "boolean", "nullable": true }, "restrictDownPaymentFlag": { "type": "boolean", "nullable": true }, "invoiceDescription": { "type": "string", "description": " Max length: 4000;" }, "topCommentFlag": { "type": "boolean", "nullable": true }, "bottomCommentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "projectType": { "$ref": "#/components/schemas/ProjectTypeReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billableTimeInvoiceFlag": { "type": "boolean", "nullable": true }, "billableExpenseInvoiceFlag": { "type": "boolean", "nullable": true }, "billableProductInvoiceFlag": { "type": "boolean", "nullable": true }, "copyWorkRolesFlag": { "type": "boolean", "nullable": true }, "copyWorkTypesFlag": { "type": "boolean", "nullable": true }, "exclusionWorkRoleIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllWorkRoleExclusions": { "type": "boolean", "nullable": true }, "removeAllWorkRoleExclusions": { "type": "boolean", "nullable": true }, "exclusionWorkTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllWorkTypeExclusions": { "type": "boolean", "nullable": true }, "removeAllWorkTypeExclusions": { "type": "boolean", "nullable": true }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "prorateFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplateReference" }, "autoInvoiceFlag": { "type": "boolean", "nullable": true }, "invoiceProratedAdditionsFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "AgreementTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "applicationUnits": { "enum": [ "Amount", "Hours", "Incidents" ], "type": "string", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkRole": { "required": [ "rateType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "limitTo": { "type": "number", "format": "double", "nullable": true }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkRoleExclusion": { "required": [ "workRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkType": { "required": [ "rateType", "billTime" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "hoursMax": { "type": "number", "format": "double", "nullable": true }, "hoursMin": { "type": "number", "format": "double", "nullable": true }, "roundBillHours": { "type": "number", "format": "double", "nullable": true }, "overageRate": { "type": "number", "format": "double", "nullable": true }, "overageRateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "agreementLimit": { "type": "number", "format": "double", "nullable": true }, "site": { "$ref": "#/components/schemas/SiteReference" }, "effectiveDate": { "type": "string", "format": "date-time" }, "endingDate": { "type": "string", "format": "date-time" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AgreementWorkTypeExclusion": { "required": [ "workType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ApiMember": { "required": [ "identifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "name": { "type": "string", "description": " Max length: 30; Required On Updates;" }, "emailAddress": { "type": "string", "description": " Max length: 250;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string", "format": "date-time" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "securityRole": { "$ref": "#/components/schemas/SecurityRoleReference" }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "notes": { "type": "string" }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "blockPriceFlag": { "type": "boolean", "nullable": true }, "blockCostFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "AutomateScriptReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingCycleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingDeliveryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingTermsReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BillingUnitReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Board": { "required": [ "name", "location", "department" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "signOffTemplate": { "$ref": "#/components/schemas/ServiceSignoffReference" }, "sendToContactFlag": { "type": "boolean", "nullable": true }, "contactTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "sendToResourceFlag": { "type": "boolean", "nullable": true }, "resourceTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "projectFlag": { "type": "boolean", "nullable": true }, "showDependenciesFlag": { "type": "boolean", "description": "This field only shows if it is Project Board.", "nullable": true }, "showEstimatesFlag": { "type": "boolean", "description": "This field only shows if it is Project Board.", "nullable": true }, "boardIcon": { "$ref": "#/components/schemas/DocumentReference" }, "billTicketsAfterClosedFlag": { "type": "boolean", "nullable": true }, "billTicketSeparatelyFlag": { "type": "boolean", "nullable": true }, "billUnapprovedTimeExpenseFlag": { "type": "boolean", "nullable": true }, "overrideBillingSetupFlag": { "type": "boolean", "nullable": true }, "dispatchMember": { "$ref": "#/components/schemas/MemberReference" }, "serviceManagerMember": { "$ref": "#/components/schemas/MemberReference" }, "dutyManagerMember": { "$ref": "#/components/schemas/MemberReference" }, "oncallMember": { "$ref": "#/components/schemas/MemberReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpense": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProduct": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "autoCloseStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "autoAssignNewTicketsFlag": { "type": "boolean", "nullable": true }, "autoAssignNewECTicketsFlag": { "type": "boolean", "nullable": true }, "autoAssignNewPortalTicketsFlag": { "type": "boolean", "nullable": true }, "discussionsLockedFlag": { "type": "boolean", "nullable": true }, "timeEntryLockedFlag": { "type": "boolean", "nullable": true }, "notifyEmailFrom": { "type": "string", "description": " Max length: 50;" }, "notifyEmailFromName": { "type": "string", "description": " Max length: 60;" }, "closedLoopDiscussionsFlag": { "type": "boolean", "nullable": true }, "closedLoopResolutionFlag": { "type": "boolean", "nullable": true }, "closedLoopInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "timeEntryDiscussionFlag": { "type": "boolean", "nullable": true }, "timeEntryResolutionFlag": { "type": "boolean", "nullable": true }, "timeEntryInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "problemSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "resolutionSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "internalAnalysisSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "emailConnectorAllowReopenClosedFlag": { "type": "boolean", "nullable": true }, "emailConnectorReopenStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "emailConnectorReopenResourcesFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorNewTicketNoMatchFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorNeverReopenByDaysFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorReopenDaysLimit": { "type": "integer", "description": "This field can only be set when emailConnectorNeverReopenByDaysFlag and emailConnectorAllowReopenClosed are both true\n This field is required when emailConnectorNeverReopenByDaysFlag is true.", "format": "int32", "nullable": true }, "emailConnectorNeverReopenByDaysClosedFlag": { "type": "boolean", "description": "This field can only be set when emailConnectorAllowReopenClosed is true.", "nullable": true }, "emailConnectorReopenDaysClosedLimit": { "type": "integer", "description": "This field can only be set when emailConnectorNeverReopenByDaysClosedFlag and emailConnectorAllowReopenClosed are both true\n This field is required when emailConnectorNeverReopenByDaysClosedFlag is true.", "format": "int32", "nullable": true }, "useMemberDisplayNameFlag": { "type": "boolean", "nullable": true }, "sendToCCFlag": { "type": "boolean", "nullable": true }, "autoAssignTicketOwnerFlag": { "type": "boolean", "nullable": true }, "autoAssignLimitFlag": { "type": "boolean", "nullable": true }, "autoAssignLimitAmount": { "type": "integer", "description": "This field can only be set when autoAssignLimitFlag is true", "format": "int32", "nullable": true }, "closedLoopAllFlag": { "type": "boolean", "nullable": true }, "percentageCalculation": { "enum": [ "ActualHours", "Manual", "ClosedPhases", "ClosedTickets" ], "type": "string", "nullable": true }, "allSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "markFirstNoteIssueFlag": { "type": "boolean", "nullable": true }, "restrictBoardByDefaultFlag": { "type": "boolean", "nullable": true }, "sendToBundledFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "BoardAutoAssignResource": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardAutoTemplate": { "required": [ "type", "subtype", "item", "serviceTemplate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subtype": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "summarySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "discussionSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "internalAnalysisSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "resolutionSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "tasksSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "documentsSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "resourcesSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "budgetHoursSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "financeInformationSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "sendNotesAsEmailSetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "impactUrgencySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "templatePrioritySetting": { "enum": [ "Append", "Overwrite", "Ignore" ], "type": "string", "nullable": true }, "autoApplyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardCopy": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" } } }, "BoardDefault": { "required": [ "board" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "agreementId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardExcludedMember": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "memberId": { "type": "integer", "format": "int32" }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedLoopDiscussionsFlag": { "type": "boolean", "nullable": true }, "closedLoopInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "closedLoopResolutionFlag": { "type": "boolean", "nullable": true }, "closedLoopAllFlag": { "type": "boolean", "nullable": true }, "overrideBillingSetupFlag": { "type": "boolean", "nullable": true }, "billTicketsAfterClosedFlag": { "type": "boolean", "nullable": true }, "billUnapprovedTimeExpenseFlag": { "type": "boolean", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpense": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProduct": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "problemSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "internalAnalysisSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "resolutionSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "allSort": { "enum": [ "Ascending", "Descending" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardItem": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardItemAssociation": { "required": [ "id" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "subTypeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "If addAllSubTypesFlag and removeAllSubTypesFlag are both false, this field is required." }, "addAllSubTypesFlag": { "type": "boolean", "nullable": true }, "removeAllSubTypesFlag": { "type": "boolean", "nullable": true }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardSkillMapping": { "required": [ "type", "skillCategory", "skill" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "skillCategory": { "$ref": "#/components/schemas/SkillCategoryReference" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "displayOnBoard": { "type": "boolean", "nullable": true }, "inactive": { "type": "boolean", "nullable": true }, "closedStatus": { "type": "boolean", "nullable": true }, "timeEntryNotAllowed": { "type": "boolean", "nullable": true }, "roundRobinCatchall": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "escalationStatus": { "enum": [ "NotResponded", "Responded", "ResolutionPlan", "Resolved", "NoEscalation" ], "type": "string", "nullable": true }, "customerPortalDescription": { "type": "string", "description": " Max length: 500;" }, "customerPortalFlag": { "type": "boolean", "nullable": true }, "emailTemplate": { "$ref": "#/components/schemas/ServiceEmailTemplateReference" }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "saveTimeAsNote": { "type": "boolean", "nullable": true }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardStatusNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": "Service Status Notification email must be entered if the notify type is \"Email Address\". Max length: 255;" }, "workflowStep": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardSubType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "typeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "addAllTypesFlag": { "type": "boolean", "nullable": true }, "removeAllTypesFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardSubTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "typeAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTeam": { "required": [ "name", "teamLeader" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "teamLeader": { "$ref": "#/components/schemas/MemberReference" }, "members": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "defaultFlag": { "type": "boolean", "nullable": true }, "notifyOnTicketDelete": { "type": "boolean", "nullable": true }, "defaultRoundRobinFlag": { "type": "boolean", "nullable": true }, "roundRobinFlag": { "type": "boolean", "nullable": true }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardTeamInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "category": { "enum": [ "Reactive", "Proactive" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "requestForChangeFlag": { "type": "boolean", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "skillCategory": { "$ref": "#/components/schemas/SkillCategoryReference" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "BoardTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BoardTypeSubTypeItemAssociation": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "BulkResult": { "type": "object", "properties": { "payload": { "type": "array", "items": { "$ref": "#/components/schemas/ResultInfo" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CalendarReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CallbackEntry": { "required": [ "url", "objectId", "type", "level" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 100;" }, "url": { "type": "string", "description": " Required Reference" }, "objectId": { "type": "integer", "description": " Required Reference", "format": "int32", "nullable": true }, "type": { "type": "string", "description": " Required Reference" }, "level": { "type": "string", "description": " Required Reference" }, "memberId": { "type": "integer", "format": "int32", "nullable": true }, "payloadVersion": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "isSoapCallbackFlag": { "type": "boolean", "nullable": true }, "isSelfSuppressedFlag": { "type": "boolean", "nullable": true }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CampaignReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CertificationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCode": { "required": [ "name", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "expenseEntryFlag": { "type": "boolean", "nullable": true }, "allowAllExpenseTypeFlag": { "type": "boolean", "nullable": true }, "timeEntryFlag": { "type": "boolean", "nullable": true }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "expenseTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ChargeCodeExpenseType": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ExpenseTypeReference" }, "chargeCode": { "$ref": "#/components/schemas/ChargeCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCodeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "expenseEntryFlag": { "type": "boolean", "nullable": true }, "allowAllExpenseTypeFlag": { "type": "boolean", "nullable": true }, "timeEntryFlag": { "type": "boolean", "nullable": true }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "expenseTypeIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ChargeCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ClearPickerRequest": { "type": "object", "properties": { "member": { "$ref": "#/components/schemas/MemberReference" }, "type": { "enum": [ "Company", "Vendor" ], "type": "string", "nullable": true } } }, "Code": { "required": [ "name", "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "description": { "type": "string" }, "boardId": { "type": "integer", "format": "int32", "nullable": true }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CommunicationType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "phoneFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "faxFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "emailFlag": { "type": "boolean", "description": "Gets or sets at least one flag is required to be true -- phone, fax, or email.", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "exchangeXref": { "type": "string", "description": " Max length: 50;" }, "iphoneXref": { "type": "string", "description": " Max length: 50;" }, "androidXref": { "type": "string", "description": " Max length: 50;" }, "googleXref": { "type": "string", "description": " Max length: 50;" }, "disabled": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "CommunicationTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "phoneFlag": { "type": "boolean", "nullable": true }, "faxFlag": { "type": "boolean", "nullable": true }, "emailFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CommunicationTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "coreEntityId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Company": { "required": [ "identifier", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 156;" }, "name": { "type": "string", "description": " Max length: 156;" }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "addressLine1": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "addressLine2": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "city": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "state": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 50;" }, "zip": { "type": "string", "description": "Gets or sets at least one address field is required -- addressLine1, addressLine2, city, state, zip and/or country. Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "faxNumber": { "type": "string", "description": " Max length: 30;" }, "website": { "type": "string", "description": " Max length: 255;" }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "market": { "$ref": "#/components/schemas/MarketDescriptionReference" }, "accountNumber": { "type": "string" }, "defaultContact": { "$ref": "#/components/schemas/ContactReference" }, "dateAcquired": { "type": "string", "format": "date-time" }, "sicCode": { "$ref": "#/components/schemas/SicCodeReference" }, "parentCompany": { "$ref": "#/components/schemas/CompanyReference" }, "annualRevenue": { "type": "number", "format": "double", "nullable": true }, "creditLimit": { "type": "number", "format": "double", "nullable": true }, "additionalDebt": { "type": "number", "format": "double", "nullable": true }, "numberOfEmployees": { "type": "integer", "format": "int32", "nullable": true }, "yearEstablished": { "type": "integer", "format": "int32", "nullable": true }, "revenueYear": { "type": "integer", "format": "int32", "nullable": true }, "ownershipType": { "$ref": "#/components/schemas/OwnershipTypeReference" }, "timeZoneSetup": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "leadSource": { "type": "string", "description": " Max length: 50;" }, "leadFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "userDefinedField1": { "type": "string", "description": " Max length: 50;" }, "userDefinedField2": { "type": "string", "description": " Max length: 50;" }, "userDefinedField3": { "type": "string", "description": " Max length: 50;" }, "userDefinedField4": { "type": "string", "description": " Max length: 50;" }, "userDefinedField5": { "type": "string", "description": " Max length: 50;" }, "userDefinedField6": { "type": "string", "description": " Max length: 50;" }, "userDefinedField7": { "type": "string", "description": " Max length: 50;" }, "userDefinedField8": { "type": "string", "description": " Max length: 50;" }, "userDefinedField9": { "type": "string", "description": " Max length: 50;" }, "userDefinedField10": { "type": "string", "description": " Max length: 50;" }, "vendorIdentifier": { "type": "string" }, "taxIdentifier": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "pricingSchedule": { "$ref": "#/components/schemas/PricingScheduleReference" }, "companyEntityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billingSite": { "$ref": "#/components/schemas/SiteReference" }, "billingContact": { "$ref": "#/components/schemas/ContactReference" }, "invoiceDeliveryMethod": { "$ref": "#/components/schemas/BillingDeliveryReference" }, "emailTemplate": { "$ref": "#/components/schemas/EmailTemplateReference" }, "invoiceToEmailAddress": { "type": "string" }, "invoiceCCEmailAddress": { "type": "string" }, "deletedFlag": { "type": "boolean", "nullable": true }, "dateDeleted": { "type": "string", "format": "date-time" }, "deletedBy": { "type": "string" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "territoryManager": { "$ref": "#/components/schemas/MemberReference" }, "resellerIdentifier": { "type": "string" }, "isVendorFlag": { "type": "boolean", "nullable": true }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeReference" }, "description": "Gets or sets integrer array of Company_Type_Recids to be assigned to company that can be passed in only during new company creation (post)\n To update existing companies type, use the /company/companyTypeAssociations or /company/companies/{ID}/typeAssociations endpoints." }, "site": { "$ref": "#/components/schemas/SiteReference" }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "Company.Configuration": { "required": [ "name", "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "type": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "status": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "deviceIdentifier": { "type": "string", "description": " Max length: 100;" }, "serialNumber": { "type": "string", "description": " Max length: 250;" }, "modelNumber": { "type": "string", "description": " Max length: 50;" }, "tagNumber": { "type": "string", "description": " Max length: 50;" }, "purchaseDate": { "type": "string", "format": "date-time" }, "installationDate": { "type": "string", "format": "date-time" }, "installedBy": { "$ref": "#/components/schemas/MemberReference" }, "warrantyExpirationDate": { "type": "string", "format": "date-time" }, "vendorNotes": { "type": "string" }, "notes": { "type": "string" }, "macAddress": { "type": "string", "description": " Max length: 25;" }, "lastLoginName": { "type": "string", "description": " Max length: 100;" }, "billFlag": { "type": "boolean", "nullable": true }, "backupSuccesses": { "type": "integer", "format": "int32", "nullable": true }, "backupIncomplete": { "type": "integer", "format": "int32", "nullable": true }, "backupFailed": { "type": "integer", "format": "int32", "nullable": true }, "backupRestores": { "type": "integer", "format": "int32", "nullable": true }, "lastBackupDate": { "type": "string", "format": "date-time" }, "backupServerName": { "type": "string", "description": " Max length: 50;" }, "backupBillableSpaceGb": { "type": "number", "format": "double", "nullable": true }, "backupProtectedDeviceList": { "type": "string" }, "backupYear": { "type": "integer", "format": "int32", "nullable": true }, "backupMonth": { "type": "integer", "format": "int32", "nullable": true }, "ipAddress": { "type": "string", "description": " Max length: 50;" }, "defaultGateway": { "type": "string", "description": " Max length: 50;" }, "osType": { "type": "string", "description": " Max length: 250;" }, "osInfo": { "type": "string", "description": " Max length: 250;" }, "cpuSpeed": { "type": "string", "description": " Max length: 100;" }, "ram": { "type": "string", "description": " Max length: 25;" }, "localHardDrives": { "type": "string" }, "parentConfigurationId": { "type": "integer", "format": "int32", "nullable": true }, "vendor": { "$ref": "#/components/schemas/CompanyReference" }, "manufacturer": { "$ref": "#/components/schemas/ManufacturerReference" }, "questions": { "type": "array", "items": { "$ref": "#/components/schemas/ConfigurationQuestion" } }, "activeFlag": { "type": "boolean", "nullable": true }, "managementLink": { "type": "string", "description": " Max length: 1000;" }, "remoteLink": { "type": "string", "description": " Max length: 1000;" }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "displayVendorFlag": { "type": "boolean", "nullable": true }, "companyLocationId": { "type": "integer", "format": "int32", "nullable": true }, "showRemoteFlag": { "type": "boolean", "nullable": true }, "showAutomateFlag": { "type": "boolean", "nullable": true }, "needsRenewalFlag": { "type": "boolean", "nullable": true }, "manufacturerPartNumber": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "CompanyCompanyTypeAssociation.CompanyTypeAssociation": { "required": [ "type", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CompanyTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyCustomNote": { "required": [ "customNote", "status" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "customNote": { "type": "string", "description": " Max length: 1500;" }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyGroup": { "required": [ "group" ], "type": "object", "properties": { "id": { "type": "integer", "description": " Required On Updates;", "format": "int32" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "defaultContactFlag": { "type": "boolean", "nullable": true }, "allContactsFlag": { "type": "boolean", "nullable": true }, "removeAllContactsFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "contactIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultContact": { "$ref": "#/components/schemas/ContactReference" }, "phoneNumber": { "type": "string" }, "city": { "type": "string" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "isVendorFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billingSite": { "$ref": "#/components/schemas/SiteReference" }, "billingContact": { "$ref": "#/components/schemas/ContactReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "deletedFlag": { "type": "boolean", "nullable": true }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/CompanyTypeReference" } }, "status": { "$ref": "#/components/schemas/CompanyStatusReference" }, "noServiceFlag": { "type": "boolean", "nullable": true }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "state": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "leadFlag": { "type": "boolean", "nullable": true }, "faxNumber": { "type": "string" }, "vendorIdentifier": { "type": "string" }, "taxIdentifier": { "type": "string" }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyManagementSummary": { "required": [ "groupIdentifier" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "managementSolution": { "$ref": "#/components/schemas/ManagementSolutionReference" }, "groupIdentifier": { "type": "string", "description": " Max length: 100;" }, "deviceType": { "enum": [ "WorkstationsAndServers", "BackupStats", "Servers", "Workstations" ], "type": "string", "description": "Gets or sets deviceType is required if the managementSolution is Legacy.", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "snmpMachines": { "type": "integer", "format": "int32", "nullable": true }, "totalWorkstations": { "type": "integer", "format": "int32", "nullable": true }, "totalServers": { "type": "integer", "format": "int32", "nullable": true }, "totalWindowsServers": { "type": "integer", "format": "int32", "nullable": true }, "totalWindowsWorkstations": { "type": "integer", "format": "int32", "nullable": true }, "totalManagedMachines": { "type": "integer", "format": "int32", "nullable": true }, "serversOffline": { "type": "integer", "format": "int32", "nullable": true }, "serversDiskSpaceLow": { "type": "integer", "format": "int32", "nullable": true }, "failedBackupJobs": { "type": "integer", "format": "int32", "nullable": true }, "totalNotifications": { "type": "integer", "format": "int32", "nullable": true }, "successfulBackupJobs": { "type": "integer", "format": "int32", "nullable": true }, "serverAvailability": { "type": "integer", "format": "int32", "nullable": true }, "virusesRemoved": { "type": "integer", "format": "int32", "nullable": true }, "spywareItemsRemoved": { "type": "integer", "format": "int32", "nullable": true }, "windowsPatchesInstalled": { "type": "integer", "format": "int32", "nullable": true }, "diskCleanups": { "type": "integer", "format": "int32", "nullable": true }, "diskDefragmentations": { "type": "integer", "format": "int32", "nullable": true }, "fullyPatchedMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingOneTwoPatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingThreeFivePatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingMoreFivePatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "missingUnscannedPatchesMachines": { "type": "integer", "format": "int32", "nullable": true }, "alertsGenerated": { "type": "string" }, "internetConnectivity": { "type": "number", "format": "double", "nullable": true }, "diskSpaceCleanedMb": { "type": "integer", "format": "int32", "nullable": true }, "missingSecurityPatches": { "type": "string" }, "cpuUtilization": { "type": "number", "format": "double", "nullable": true }, "memoryUtilization": { "type": "number", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyMerge": { "required": [ "toCompanyId" ], "type": "object", "properties": { "toCompanyId": { "type": "integer", "format": "int32" }, "name": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "identifier": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "status": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "type": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "primaryAddress": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "primaryContact": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "phone": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "fax": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "website": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "market": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "territory": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "revenue": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "revenueYear": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "numberOfEmployees": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "sicCode": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "dateAcquired": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "timeZone": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "sourceList": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField1": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField2": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField3": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField4": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField5": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField6": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField7": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField8": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField9": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "userDefinedField10": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingAddress": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingContact": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "taxCode": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "accountNumber": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "billingTerms": { "enum": [ "From", "To" ], "type": "string", "nullable": true }, "notes": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "sites": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "activities": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "opportunities": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "services": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "projects": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "contacts": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true }, "documents": { "enum": [ "Discard", "Merge" ], "type": "string", "nullable": true } } }, "CompanyNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyNoteType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "importFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "CompanyNoteTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyPickerItem": { "required": [ "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyStatus": { "$ref": "#/components/schemas/CompanyStatusReference" }, "companyType": { "$ref": "#/components/schemas/CompanyTypeReference" }, "companySite": { "$ref": "#/components/schemas/SiteReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "companyCountry": { "$ref": "#/components/schemas/CountryReference" }, "vendorPickerFlag": { "type": "boolean", "description": "Gets or sets if true, this record was created by the vendor picker component. Otherwise, the record was created by the company picker component.", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyServiceTemplate": { "type": "object", "properties": { "parentTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "subtype": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "assignedNotifyFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "summary": { "type": "string" }, "problem": { "type": "string" }, "hoursBudget": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "internalAnalysis": { "type": "string" }, "resolution": { "type": "string" }, "timeBillableFlag": { "type": "boolean", "nullable": true }, "expenseBillableFlag": { "type": "boolean", "nullable": true }, "productBillableFlag": { "type": "boolean", "nullable": true }, "purchaseOrderNumber": { "type": "string" }, "reference": { "type": "string" }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "billComplete_Flag": { "type": "boolean", "nullable": true }, "billServiceSeparatelyFlag": { "type": "boolean", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "billUnapprovedTimeAndExpensesFlag": { "type": "boolean", "nullable": true }, "overrideFlag": { "type": "boolean", "nullable": true }, "timeInvoiceFlag": { "type": "boolean", "nullable": true }, "expenseInvoiceFlag": { "type": "boolean", "nullable": true }, "productInvoiceFlag": { "type": "boolean", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "severity": { "enum": [ "Low", "Medium", "High" ], "type": "string", "nullable": true }, "impact": { "enum": [ "Low", "Medium", "High" ], "type": "string", "nullable": true }, "assignedBy": { "$ref": "#/components/schemas/MemberReference" }, "scheduleDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "serviceDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "attachScheduleToNewServiceFlag": { "type": "boolean", "nullable": true }, "templateFlag": { "type": "boolean", "nullable": true }, "emailContactFlag": { "type": "boolean", "nullable": true }, "emailResourceFlag": { "type": "boolean", "nullable": true }, "emailCCFlag": { "type": "boolean", "nullable": true }, "emailCC": { "type": "string" }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanySite": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 156;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateReference": { "$ref": "#/components/schemas/StateReference" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "addressFormat": { "type": "string" }, "phoneNumber": { "type": "string", "description": " Max length: 30;" }, "phoneNumberExt": { "type": "string", "description": " Max length: 30;" }, "faxNumber": { "type": "string", "description": " Max length: 30;" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "entityType": { "$ref": "#/components/schemas/EntityTypeReference" }, "expenseReimbursement": { "type": "number", "format": "double", "nullable": true }, "primaryAddressFlag": { "type": "boolean", "nullable": true }, "defaultShippingFlag": { "type": "boolean", "nullable": true }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "defaultMailingFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "billSeparateFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "territory": { "$ref": "#/components/schemas/SystemLocationReference" }, "invoiceTemplate": { "$ref": "#/components/schemas/InvoiceTemplateReference" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "CompanySiteInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "stateReference": { "$ref": "#/components/schemas/StateReference" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "addressFormat": { "type": "string" }, "phoneNumber": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultShippingFlag": { "type": "boolean", "nullable": true }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "primaryAddressFlag": { "type": "boolean", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "phoneNumberExt": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "notifyFlag": { "type": "boolean", "nullable": true }, "disallowSavingFlag": { "type": "boolean", "nullable": true }, "notificationMessage": { "type": "string", "description": " Max length: 500;" }, "customNoteFlag": { "type": "boolean", "nullable": true }, "cancelOpenTracksFlag": { "type": "boolean", "nullable": true }, "track": { "$ref": "#/components/schemas/TrackReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "CompanyStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyTeam": { "required": [ "teamRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "teamRole": { "$ref": "#/components/schemas/TeamRoleReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "accountManagerFlag": { "type": "boolean", "nullable": true }, "techFlag": { "type": "boolean", "nullable": true }, "salesFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "vendorFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string", "description": " Max length: 150;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "CompanyTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "isVendor": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CompanyTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationQuestion": { "type": "object", "properties": { "answerId": { "type": "integer", "format": "int32", "nullable": true }, "questionId": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string" }, "answer": { "type": "object" }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "fieldType": { "enum": [ "TextArea", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true } } }, "ConfigurationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "deviceIdentifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationStatus": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ConfigurationStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTabsCount": { "type": "object" }, "ConfigurationType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ConfigurationTypeCopy": { "required": [ "id", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" } } }, "ConfigurationTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "systemFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestion": { "required": [ "fieldType", "entryType", "sequenceNumber", "question" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "fieldType": { "enum": [ "TextArea", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "Text", "Password" ], "type": "string", "nullable": true }, "entryType": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "sequenceNumber": { "type": "number", "format": "double", "nullable": true }, "question": { "type": "string", "description": " Max length: 1000;" }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true } } }, "ConfigurationTypeQuestionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "question": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConfigurationTypeQuestionValue": { "required": [ "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "question": { "$ref": "#/components/schemas/ConfigurationTypeQuestionReference" }, "value": { "type": "string", "description": " Max length: 1000;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "ConfigurationTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Contact": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "zip": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "relationship": { "$ref": "#/components/schemas/RelationshipReference" }, "relationshipOverride": { "type": "string" }, "department": { "$ref": "#/components/schemas/ContactDepartmentReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "defaultMergeContactId": { "type": "integer", "format": "int32", "nullable": true }, "securityIdentifier": { "type": "string" }, "managerContact": { "$ref": "#/components/schemas/ContactReference" }, "assistantContact": { "$ref": "#/components/schemas/ContactReference" }, "title": { "type": "string" }, "school": { "type": "string" }, "nickName": { "type": "string" }, "marriedFlag": { "type": "boolean", "nullable": true }, "childrenFlag": { "type": "boolean", "nullable": true }, "children": { "type": "string" }, "significantOther": { "type": "string" }, "portalPassword": { "type": "string" }, "portalSecurityLevel": { "type": "integer", "format": "int32", "nullable": true }, "disablePortalLoginFlag": { "type": "boolean", "nullable": true }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "gender": { "enum": [ "Female", "Male" ], "type": "string", "nullable": true }, "birthDay": { "type": "string" }, "anniversary": { "type": "string" }, "presence": { "enum": [ "NoAgent", "Online", "DoNotDisturb", "Away", "Offline" ], "type": "string", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "defaultPhoneType": { "type": "string" }, "defaultPhoneNbr": { "type": "string" }, "defaultPhoneExtension": { "type": "string" }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "userDefinedField1": { "type": "string", "description": " Max length: 50;" }, "userDefinedField2": { "type": "string", "description": " Max length: 50;" }, "userDefinedField3": { "type": "string", "description": " Max length: 50;" }, "userDefinedField4": { "type": "string", "description": " Max length: 50;" }, "userDefinedField5": { "type": "string", "description": " Max length: 50;" }, "userDefinedField6": { "type": "string", "description": " Max length: 50;" }, "userDefinedField7": { "type": "string", "description": " Max length: 50;" }, "userDefinedField8": { "type": "string", "description": " Max length: 50;" }, "userDefinedField9": { "type": "string", "description": " Max length: 50;" }, "userDefinedField10": { "type": "string", "description": " Max length: 50;" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "communicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunicationItem" } }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeReference" } }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "ignoreDuplicates": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "typeIds": { "type": "array", "items": { "type": "integer", "format": "int32" }, "description": "Gets or sets integrer array of Contact_Type_Recids to be assigned to contact that can be passed in only during new contact creation (post)\n To update existing contacts type, use the /company/contactTypeAssociations or /company/contacts/{ID}/typeAssociations endpoints." } } }, "ContactCommunication": { "required": [ "type", "value" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "type": { "$ref": "#/components/schemas/CommunicationTypeReference" }, "value": { "type": "string", "description": " Max length: 250;" }, "extension": { "type": "string", "description": " Max length: 15;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "communicationType": { "enum": [ "Email", "Fax", "Phone" ], "type": "string", "nullable": true }, "domain": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactCommunicationItem": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/CommunicationTypeReference" }, "value": { "type": "string" }, "extension": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "domain": { "type": "string" }, "communicationType": { "enum": [ "Email", "Fax", "Phone" ], "type": "string", "nullable": true } } }, "ContactContactTypeAssociation.ContactTypeAssociation": { "required": [ "type", "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "$ref": "#/components/schemas/ContactTypeReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactDepartment": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ContactDepartmentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactDepartmentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactGroup": { "required": [ "group" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "description": { "type": "string", "description": " Max length: 50;" }, "unsubscribeFlag": { "type": "boolean", "nullable": true }, "companyUnsubcribedEmailMessage": { "type": "string" }, "companyGroupUnsubscribedEmailMessage": { "type": "string" }, "contactUnsubscribedEmailMessage": { "type": "string" }, "contactGroupUnsubscribedEmailMessage": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "communicationItems": { "type": "array", "items": { "$ref": "#/components/schemas/ContactCommunicationItem" } }, "defaultPhoneNbr": { "type": "string" }, "defaultPhoneType": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "title": { "type": "string" }, "types": { "type": "array", "items": { "$ref": "#/components/schemas/ContactTypeReference" } }, "addressLine1": { "type": "string" }, "addressLine2": { "type": "string" }, "city": { "type": "string" }, "state": { "type": "string" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "zip": { "type": "string" }, "department": { "$ref": "#/components/schemas/ContactDepartmentReference" }, "defaultBillingFlag": { "type": "boolean", "nullable": true }, "facebookUrl": { "type": "string" }, "twitterUrl": { "type": "string" }, "linkedInUrl": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "contactId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactRelationship": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ContactTrack": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "trackId": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "actionTaken": { "type": "integer", "format": "int32", "nullable": true }, "actionRemaining": { "type": "integer", "format": "int32", "nullable": true }, "startedBy": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactType": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string", "description": " Max length: 150;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ContactTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "description": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "serviceAlertFlag": { "type": "boolean", "nullable": true }, "serviceAlertMessage": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ContactTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ConvertItem": { "required": [ "recordType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" } } }, "ConvertToProject": { "required": [ "phase", "wbsCode" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" } } }, "CorporateStructureLevelReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Count": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" } } }, "CountryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CurrencyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "symbol": { "type": "string" }, "currencyCode": { "type": "string" }, "decimalSeparator": { "type": "string" }, "numberOfDecimals": { "type": "integer", "format": "int32" }, "thousandsSeparator": { "type": "string" }, "negativeParenthesesFlag": { "type": "boolean" }, "displaySymbolFlag": { "type": "boolean" }, "currencyIdentifier": { "type": "string" }, "displayIdFlag": { "type": "boolean" }, "rightAlign": { "type": "boolean" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "CustomFieldValue": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "caption": { "type": "string" }, "type": { "enum": [ "TextArea", "Button", "Currency", "Date", "Hyperlink", "IPAddress", "Checkbox", "Number", "Percent", "PhoneNumber", "Text", "Password" ], "type": "string", "nullable": true }, "entryMethod": { "enum": [ "Date", "EntryField", "List", "Option" ], "type": "string", "nullable": true }, "numberOfDecimals": { "type": "integer", "format": "int32", "nullable": true }, "value": { "type": "object" }, "connectWiseId": { "type": "string" }, "rowNum": { "type": "integer", "format": "int32", "nullable": true }, "userDefinedFieldRecId": { "type": "integer", "format": "int32", "nullable": true }, "podId": { "type": "string" } } }, "DepartmentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DepartmentLocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DirectionalSyncReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentFormData": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" }, "recordId": { "type": "integer", "format": "int32" }, "recordType": { "type": "string" }, "title": { "type": "string" }, "url": { "type": "string" }, "privateFlag": { "type": "boolean" }, "readOnlyFlay": { "type": "boolean" }, "isAvatar": { "type": "boolean" } } }, "DocumentInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "fileName": { "type": "string" }, "serverFileName": { "type": "string" }, "owner": { "type": "string" }, "linkFlag": { "type": "boolean", "nullable": true }, "imageFlag": { "type": "boolean", "nullable": true }, "publicFlag": { "type": "boolean", "nullable": true }, "htmlTemplateFlag": { "type": "boolean", "nullable": true }, "readOnlyFlag": { "type": "boolean", "nullable": true }, "size": { "type": "integer", "format": "int32", "nullable": true }, "urlFlag": { "type": "boolean", "nullable": true }, "createdOnDate": { "type": "string" }, "documentType": { "$ref": "#/components/schemas/DocumentTypeReference" }, "guid": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "guidSecondary": { "type": "string", "format": "uuid", "example": "00000000-0000-0000-0000-000000000000" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "DocumentTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "EntityTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ExpenseTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "FilterValues": { "type": "object", "properties": { "conditions": { "type": "string" }, "orderBy": { "type": "string" }, "childconditions": { "type": "string" }, "customfieldconditions": { "type": "string" } } }, "GenericBoardTeamReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "isProjectTeamFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "GenericIdIdentifierReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" } } }, "GenericNameIdDTO": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "tag": { "type": "string" }, "name": { "type": "string" } } }, "GroupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IdCollection": { "type": "object", "properties": { "ids": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "Impact": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "description": " Max length: 200;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Info": { "type": "object", "properties": { "version": { "type": "string" }, "isCloud": { "type": "boolean" }, "serverTimeZone": { "type": "string" }, "licenseBits": { "type": "array", "items": { "$ref": "#/components/schemas/LicenseBit" } }, "cloudRegion": { "type": "string" }, "maxWorkFlowRecordsAllowed": { "type": "integer", "format": "int32" } } }, "IntegratorLoginReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceGroupingReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "description": { "type": "string" }, "showPriceFlag": { "type": "boolean" }, "showSubItemsFlag": { "type": "boolean" }, "groupParentChildAdditionsFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "billingType": { "type": "string" }, "applyToType": { "type": "string" }, "invoiceDate": { "type": "string" }, "chargeFirmFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "InvoiceTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "description": "Gets or sets invoice Template Setup Id.", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "IvItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "serializedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KBCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseArticle": { "required": [ "title", "issue", "resolution" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "title": { "type": "string" }, "issue": { "type": "string" }, "resolution": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "categoryId": { "type": "integer", "format": "int32", "nullable": true }, "subCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "dateCreated": { "type": "string" }, "createdBy": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "KnowledgeBaseCategory": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "approver": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "KnowledgeBaseSettings": { "required": [ "requireApproval" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "requireApproval": { "type": "boolean", "nullable": true }, "defaultApprover": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "KnowledgeBaseSubCategory": { "required": [ "name", "category" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "category": { "$ref": "#/components/schemas/KBCategoryReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "LdapConfigurationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "server": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LicenseBit": { "type": "object", "properties": { "name": { "type": "string" }, "activeFlag": { "type": "boolean" } } }, "LinkInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "screenLink": { "enum": [ "Company", "Contact", "Service", "Invoice", "PurchaseOrder", "SalesOrder" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "LinkResolveUrlInfo": { "required": [ "referenceId" ], "type": "object", "properties": { "referenceId": { "type": "integer", "format": "int32", "nullable": true }, "url": { "type": "string" } } }, "LocaleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "localeCode": { "type": "string" } } }, "LocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "location_flag": { "type": "boolean" }, "structureLevel": { "$ref": "#/components/schemas/CorporateStructureLevelReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDeviceAccount": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "username": { "type": "string" }, "password": { "type": "string" }, "managedDevicesIntegration": { "$ref": "#/components/schemas/ManagedDevicesIntegrationReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedDevicesIntegrationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagedInformation": { "type": "object", "properties": { "managementSolutionName": { "type": "string" }, "managedIdentifier": { "type": "string" }, "type": { "type": "string" }, "level": { "type": "string" }, "childConfigurationsMatchingOn": { "type": "string" }, "inactivateConfigurationsMatchingOn": { "type": "string" }, "inactiveConfigurationStatusId": { "type": "integer", "format": "int32" } } }, "ManagementReportNotification": { "required": [ "notifyWho" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "email": { "type": "string", "description": " Max length: 50;" }, "globalFlag": { "type": "boolean", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "ManagementReportSetup": { "required": [ "scheduledReportDisabledFlag" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scheduledReportDisabledFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManagementSolutionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "setupName": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ManufacturerReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MarketDescriptionReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Member": { "required": [ "identifier", "licenseClass", "firstName", "lastName", "hireDate", "defaultEmail", "defaultPhone", "securityRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string", "description": " Max length: 15;" }, "password": { "type": "string", "description": "ConditionallyRequired. API Member will get random password generated Max length: 60;" }, "disableOnlineFlag": { "type": "boolean", "nullable": true }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "notes": { "type": "string" }, "employeeIdentifer": { "type": "string", "description": " Max length: 10;" }, "vendorNumber": { "type": "string" }, "enableMobileGpsFlag": { "type": "boolean", "nullable": true }, "inactiveDate": { "type": "string", "format": "date-time" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "lastLogin": { "type": "string" }, "clientId": { "type": "string" }, "token": { "type": "string" }, "firstName": { "type": "string", "description": " Max length: 30;" }, "middleInitial": { "type": "string", "description": " Max length: 1;" }, "lastName": { "type": "string", "description": " Max length: 30;" }, "hireDate": { "type": "string", "format": "date-time" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "officeEmail": { "type": "string", "description": " Max length: 250;" }, "mobileEmail": { "type": "string", "description": " Max length: 250;" }, "homeEmail": { "type": "string", "description": " Max length: 250;" }, "defaultEmail": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "primaryEmail": { "type": "string", "description": " Max length: 250;" }, "officePhone": { "type": "string", "description": " Max length: 15;" }, "officeExtension": { "type": "string", "description": " Max length: 10;" }, "mobilePhone": { "type": "string", "description": " Max length: 15;" }, "mobileExtension": { "type": "string", "description": " Max length: 10;" }, "homePhone": { "type": "string", "description": " Max length: 15;" }, "homeExtension": { "type": "string", "description": " Max length: 10;" }, "defaultPhone": { "enum": [ "Office", "Mobile", "Home" ], "type": "string", "nullable": true }, "securityRole": { "$ref": "#/components/schemas/SecurityRoleReference" }, "office365": { "$ref": "#/components/schemas/MemberOffice365" }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true }, "authenticationServiceType": { "enum": [ "AuthAnvil", "GoogleAuthenticator", "Email" ], "type": "string", "nullable": true }, "timebasedOneTimePasswordActivated": { "type": "boolean", "nullable": true }, "enableLdapAuthenticationFlag": { "type": "boolean", "nullable": true }, "ldapConfiguration": { "$ref": "#/components/schemas/LdapConfigurationReference" }, "ldapUserName": { "type": "string", "description": " Max length: 50;" }, "directionalSync": { "$ref": "#/components/schemas/DirectionalSyncReference" }, "ssoSettings": { "$ref": "#/components/schemas/MemberSsoSettingsReference" }, "signature": { "type": "string" }, "phoneIntegrationType": { "enum": [ "TAPI", "SKYPE", "TEL", "CALLTO", "NONE" ], "type": "string", "nullable": true }, "useBrowserLanguageFlag": { "type": "boolean", "nullable": true }, "title": { "type": "string" }, "reportCard": { "$ref": "#/components/schemas/ReportCardReference" }, "enableMobileFlag": { "type": "boolean", "nullable": true }, "type": { "$ref": "#/components/schemas/MemberTypeReference" }, "timeZone": { "$ref": "#/components/schemas/TimeZoneSetupReference" }, "partnerPortalFlag": { "type": "boolean", "nullable": true }, "stsUserAdminUrl": { "type": "string" }, "toastNotificationFlag": { "type": "boolean", "nullable": true }, "memberPersonas": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "adminFlag": { "type": "boolean", "nullable": true }, "structureLevel": { "$ref": "#/components/schemas/StructureReference" }, "securityLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "defaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "reportsTo": { "$ref": "#/components/schemas/MemberReference" }, "restrictLocationFlag": { "type": "boolean", "nullable": true }, "restrictDepartmentFlag": { "type": "boolean", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "billableForecast": { "type": "number", "format": "double", "nullable": true }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "includeInUtilizationReportingFlag": { "type": "boolean", "nullable": true }, "requireExpenseEntryFlag": { "type": "boolean", "nullable": true }, "requireTimeSheetEntryFlag": { "type": "boolean", "nullable": true }, "requireStartAndEndTimeOnTimeEntryFlag": { "type": "boolean", "nullable": true }, "allowInCellEntryOnTimeSheet": { "type": "boolean", "nullable": true }, "enterTimeAgainstCompanyFlag": { "type": "boolean", "nullable": true }, "allowExpensesEnteredAgainstCompaniesFlag": { "type": "boolean", "nullable": true }, "timeReminderEmailFlag": { "type": "boolean", "nullable": true }, "daysTolerance": { "type": "integer", "format": "int32", "nullable": true }, "minimumHours": { "type": "number", "format": "double", "nullable": true }, "timeSheetStartDate": { "type": "string" }, "serviceDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "serviceDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "serviceDefaultBoard": { "$ref": "#/components/schemas/BoardReference" }, "restrictServiceDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictServiceDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedServiceBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "teams": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serviceBoardTeamIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "projectDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "projectDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "projectDefaultBoard": { "$ref": "#/components/schemas/ProjectBoardReference" }, "restrictProjectDefaultLocationFlag": { "type": "boolean", "nullable": true }, "restrictProjectDefaultDepartmentFlag": { "type": "boolean", "nullable": true }, "excludedProjectBoardIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "scheduleDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "scheduleDefaultDepartment": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "scheduleCapacity": { "type": "number", "format": "double", "nullable": true }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "restrictScheduleFlag": { "type": "boolean", "nullable": true }, "hideMemberInDispatchPortalFlag": { "type": "boolean", "nullable": true }, "calendar": { "$ref": "#/components/schemas/CalendarReference" }, "salesDefaultLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "restrictDefaultSalesTerritoryFlag": { "type": "boolean", "nullable": true }, "warehouse": { "$ref": "#/components/schemas/WarehouseReference" }, "warehouseBin": { "$ref": "#/components/schemas/WarehouseBinReference" }, "restrictDefaultWarehouseFlag": { "type": "boolean", "nullable": true }, "restrictDefaultWarehouseBinFlag": { "type": "boolean", "nullable": true }, "companyActivityTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceTimeTabFormat": { "enum": [ "SummaryList", "DetailList" ], "type": "string", "nullable": true }, "invoiceScreenDefaultTabFormat": { "enum": [ "ShowInvoicingTab", "ShowAgreementInvoicingTab" ], "type": "string", "nullable": true }, "invoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "agreementInvoicingDisplayOptions": { "enum": [ "RemainOnInvoicingScreen", "ShowRecentInvoices" ], "type": "string", "nullable": true }, "autoStartStopwatch": { "type": "boolean", "nullable": true }, "autoPopupQuickNotesWithStopwatch": { "type": "boolean", "nullable": true }, "globalSearchDefaultTicketFilter": { "enum": [ "OpenRecords", "ClosedRecords", "AllRecords" ], "type": "string", "nullable": true }, "globalSearchDefaultSort": { "enum": [ "None", "LastUpdatedDesc", "LastUpdatedAsc", "CreatedDesc", "CreatedAsc" ], "type": "string", "nullable": true }, "phoneSource": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "copyPodLayouts": { "type": "boolean" }, "copySharedDefaultViews": { "type": "boolean" }, "copyColumnLayoutsAndFilters": { "type": "boolean" }, "fromMemberRecId": { "type": "integer", "format": "int32" }, "fromMemberTemplateRecId": { "type": "integer", "format": "int32" }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "MemberAccrual": { "required": [ "accrualType", "year", "hours", "reason" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "accrualType": { "enum": [ "Holiday", "PTO", "Sick", "Vacation" ], "type": "string", "nullable": true }, "year": { "type": "integer", "format": "int32", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "reason": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberCertification": { "required": [ "certification" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "certification": { "$ref": "#/components/schemas/CertificationReference" }, "percentComplete": { "type": "integer", "format": "int32", "nullable": true }, "dateReceived": { "type": "string", "format": "date-time" }, "dateExpires": { "type": "string", "format": "date-time" }, "certificationNumber": { "type": "string", "description": " Max length: 50;" }, "notes": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberDeactivation": { "type": "object", "properties": { "activity": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceTeam": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "companyTeam": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDeactivationCompanyTeam" }, "description": "A list of customers for which the member holds a team role" }, "workflowEmail": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceStatusWorkflow": { "type": "array", "items": { "$ref": "#/components/schemas/MemberDeactivationStatusWorkflow" } }, "ticketTemplate": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "opportunity": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "salesTeam": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectTimeApprover": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "projectExpenseApprover": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "knowledgeBaseArticle": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyPresident": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyCOO": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyController": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyDispatch": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyServiceManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "myCompanyDutyManagerRole": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "departmentManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "dispatchMember": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "serviceManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "dutyManager": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "sendFromEmailNotify": { "$ref": "#/components/schemas/MemberDeactivationItem" }, "deleteOpenTimeSheetsFlag": { "type": "boolean", "description": "By default, this is set to false\n If there is any open timesheets, system will return error message\n that there is open timesheets still attached to this member\n If user would like to delete member with open timesheets, they can set this boolean to TRUE\n System will delete member and any associated open timesheets", "nullable": true } } }, "MemberDeactivationCompanyTeam": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "reAssignToContact": { "$ref": "#/components/schemas/ContactReference" }, "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDeactivationItem": { "type": "object", "properties": { "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDeactivationStatusWorkflow": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "count": { "type": "integer", "format": "int32" }, "reAssignToMember": { "$ref": "#/components/schemas/MemberReference" } } }, "MemberDelegation": { "required": [ "delegationType", "delegatedTo", "dateStart", "dateEnd" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "delegationType": { "enum": [ "Approval", "Project" ], "type": "string", "nullable": true }, "delegatedTo": { "$ref": "#/components/schemas/MemberReference" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberForCalSync": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "memberId": { "type": "string" }, "office365Id": { "type": "string" }, "mapiName": { "type": "string" }, "calendarSyncIntegrationFlag": { "type": "boolean", "nullable": true } } }, "MemberInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "firstName": { "type": "string" }, "middleInitial": { "type": "string" }, "lastName": { "type": "string" }, "fullName": { "type": "string" }, "defaultEmail": { "type": "string" }, "photo": { "$ref": "#/components/schemas/DocumentReference" }, "licenseClass": { "enum": [ "A", "C", "F", "X" ], "type": "string", "description": "F = Full Member, A = API Member, C = StreamlineIT Member, X = Subcontractor Member", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberLinkSsoUser": { "type": "object", "properties": { "ssoUserId": { "type": "string", "description": " Max length: 100;" } } }, "MemberNotificationSetting": { "required": [ "notificationType", "notificationTrigger" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notificationType": { "enum": [ "Email", "Push" ], "type": "string", "nullable": true }, "notificationTrigger": { "enum": [ "ActivityStatusReq", "CustomerUpdated", "ExpenseReport", "TicketStatusChange", "TicketStatusRequest", "TimeNagApprover", "TimeNagMember", "TimeSheet", "WorkflowRules" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberOffice365": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } } }, "MemberPersona": { "required": [ "name", "personaId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "jobRolePercentage": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "description": " Max length: 20;" }, "personaId": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "dailyCapacity": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSkill": { "required": [ "skill", "skillLevel" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "skill": { "$ref": "#/components/schemas/SkillReference" }, "skillLevel": { "enum": [ "Beginner", "Intermediate", "Advanced", "Expert" ], "type": "string", "nullable": true }, "certifiedFlag": { "type": "boolean", "nullable": true }, "yearsExperience": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSsoSettingsReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "ssoUserId": { "type": "string" }, "userName": { "type": "string" }, "email": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberSsoToken": { "type": "object", "properties": { "token": { "type": "string" } } }, "MemberType": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "MemberTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "MemberTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NoteTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NotificationRecipientReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "NotifyTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OpportunityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OrderStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnerLevelReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "OwnershipTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PatchOperation": { "type": "object", "properties": { "op": { "type": "string" }, "path": { "type": "string" }, "value": { "type": "object" } } }, "PersonasInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" } } }, "PhaseStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "collapsedFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "boardAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": "Required when statusIndicator is Custom. Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "PhaseStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "collapsedFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "boardAssociationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PhaseStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PortalSecurity": { "type": "object", "properties": { "identifier": { "type": "string" }, "enabled": { "type": "boolean", "nullable": true } } }, "PricingScheduleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Priority": { "required": [ "name", "color" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "color": { "enum": [ "Black", "Blue", "Cyan", "Gray", "Green", "Lime", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Custom" ], "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "imageLink": { "type": "string" }, "urgencySortOrder": { "type": "string" }, "level": { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "PriorityInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "color": { "enum": [ "Black", "Blue", "Cyan", "Gray", "Green", "Lime", "Orange", "Pink", "Purple", "Red", "White", "Yellow", "Custom" ], "type": "string", "nullable": true }, "sortOrder": { "type": "integer", "format": "int32", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "imageLink": { "type": "string" }, "urgencySortOrder": { "type": "string" }, "level": { "enum": [ "Critical", "High", "Medium", "Low" ], "type": "string", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "PriorityReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "sort": { "type": "integer", "format": "int32", "nullable": true }, "level": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProductReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Project": { "required": [ "billingMethod", "board", "company", "estimatedEnd", "estimatedStart", "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "actualEnd": { "type": "string", "format": "date-time" }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "actualStart": { "type": "string", "format": "date-time" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "billingAttention": { "type": "string", "description": " Max length: 50;" }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "billingRateType": { "enum": [ "StaffMember", "WorkRole" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProjectAfterClosedFlag": { "type": "boolean", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "billUnapprovedTimeAndExpense": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/ProjectBoardReference" }, "budgetAnalysis": { "enum": [ "ActualHours", "BillableHours" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "budgetFlag": { "type": "boolean", "nullable": true }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerPO": { "type": "string", "description": " Max length: 50;" }, "description": { "type": "string" }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "downpayment": { "type": "number", "format": "double", "nullable": true }, "estimatedEnd": { "type": "string", "format": "date-time" }, "percentComplete": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedHours": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedStart": { "type": "string", "format": "date-time" }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "expenseApprover": { "$ref": "#/components/schemas/MemberReference" }, "includeDependenciesFlag": { "type": "boolean", "nullable": true }, "includeEstimatesFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "manager": { "$ref": "#/components/schemas/MemberReference" }, "name": { "type": "string", "description": " Max length: 100;" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "projectTemplateId": { "type": "integer", "format": "int32", "nullable": true }, "restrictDownPaymentFlag": { "type": "boolean", "nullable": true }, "scheduledEnd": { "type": "string", "format": "date-time" }, "scheduledHours": { "type": "number", "format": "double", "nullable": true }, "scheduledStart": { "type": "string", "format": "date-time" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "status": { "$ref": "#/components/schemas/ProjectStatusReference" }, "closedFlag": { "type": "boolean" }, "timeApprover": { "$ref": "#/components/schemas/MemberReference" }, "type": { "$ref": "#/components/schemas/ProjectTypeReference" }, "doNotDisplayInPortalFlag": { "type": "boolean", "nullable": true }, "billingStartDate": { "type": "string", "format": "date-time" }, "poAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "companyLocation": { "$ref": "#/components/schemas/SystemLocationReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "overridePercentComplete": { "type": "boolean", "nullable": true }, "showOverridePercentFlag": { "type": "boolean", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectBoardKanbanSetting": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "color": { "type": "string", "description": " Max length: 4;" }, "order": { "type": "integer", "format": "int32" }, "statuses": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectBoardKanbanStatus" } }, "updatedBy": { "type": "string", "description": " Max length: 15;" }, "lastUpdated": { "type": "string" } } }, "ProjectBoardKanbanStatus": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "srStatusId": { "type": "integer", "format": "int32" }, "order": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" } } }, "ProjectBoardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardTeam": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "ProjectBoardTeamInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectBoardTeamMember": { "required": [ "member", "projectRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "projectRole": { "$ref": "#/components/schemas/ProjectRoleReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectContact": { "required": [ "contact" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectNote": { "required": [ "text" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "type": { "$ref": "#/components/schemas/NoteTypeReference" }, "flagged": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectPhase": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string", "description": " Max length: 100;" }, "board": { "$ref": "#/components/schemas/ProjectBoardReference" }, "status": { "$ref": "#/components/schemas/PhaseStatusReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "department": { "$ref": "#/components/schemas/BillingUnitReference" }, "parentPhase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string", "description": " Max length: 50;" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "notes": { "type": "string" }, "deadlineDate": { "type": "string", "format": "date-time" }, "billSeparatelyFlag": { "type": "boolean", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "description": "billingMethod is required if the phase billSeparatelyFlag is true.", "nullable": true }, "scheduledHours": { "type": "number", "format": "double", "nullable": true }, "scheduledStart": { "type": "string" }, "scheduledEnd": { "type": "string" }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "actualStart": { "type": "string" }, "actualEnd": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "billingStartDate": { "type": "string", "format": "date-time" }, "billPhaseClosedFlag": { "type": "boolean", "description": "This phase can only be billed after it has been closed.", "nullable": true }, "billProjectClosedFlag": { "type": "boolean", "description": "This phase can only be billed after the project has been closed.", "nullable": true }, "downpayment": { "type": "number", "format": "double", "nullable": true }, "poNumber": { "type": "string", "description": " Max length: 25;" }, "poAmount": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "billToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "billToContact": { "$ref": "#/components/schemas/ContactReference" }, "billToSite": { "$ref": "#/components/schemas/SiteReference" }, "shipToCompany": { "$ref": "#/components/schemas/CompanyReference" }, "shipToContact": { "$ref": "#/components/schemas/ContactReference" }, "shipToSite": { "$ref": "#/components/schemas/SiteReference" }, "billingTerms": { "$ref": "#/components/schemas/BillingTermsReference" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectPhaseReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectRecap": { "type": "object", "properties": { "treeID": { "type": "string" }, "iD": { "type": "integer", "format": "int32" }, "recID": { "type": "integer", "format": "int32" }, "displayID": { "type": "string" }, "description": { "type": "string" }, "companyName": { "type": "string" }, "status": { "type": "string" }, "isProject": { "type": "boolean" }, "isPhase": { "type": "boolean" }, "isTicket": { "type": "boolean" }, "isIssue": { "type": "boolean" }, "addOnFlag": { "type": "boolean" }, "parentPhaseRecID": { "type": "integer", "format": "int32" }, "wbsCode": { "type": "string" }, "billingMethodID": { "type": "string" }, "billingMethod": { "type": "string" }, "billingAmount": { "type": "string" }, "overrideFlag": { "type": "boolean" }, "billingStartDate": { "type": "string" }, "revenueEstimate": { "type": "number", "format": "double" }, "revenueActual": { "type": "number", "format": "double" }, "revenueBilled": { "type": "number", "format": "double" }, "revenueUnbilled": { "type": "number", "format": "double" }, "costEstimate": { "type": "number", "format": "double" }, "costActual": { "type": "number", "format": "double" }, "grossMarginEstimate": { "type": "number", "format": "double" }, "grossMarginBilled": { "type": "number", "format": "double" }, "recType": { "type": "string" }, "productsBilled": { "type": "number", "format": "double" }, "expensesBilled": { "type": "number", "format": "double" }, "bundleBilled": { "type": "number", "format": "double" } } }, "ProjectReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectStatus": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "noTimeFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "statusIndicator": { "$ref": "#/components/schemas/StatusIndicatorReference" }, "customStatusIndicatorName": { "type": "string", "description": "Required when statusIndicator is Custom. Max length: 30;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ProjectStatusInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "noTimeFlag": { "type": "boolean", "nullable": true }, "closedFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTeamMember": { "required": [ "member", "projectRole" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "hours": { "type": "number", "format": "double", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "projectRole": { "$ref": "#/components/schemas/ProjectRoleReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTemplate": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 200;" }, "description": { "type": "string" }, "connectWiseId": { "type": "string" }, "type": { "$ref": "#/components/schemas/ProjectTypeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTicket": { "required": [ "summary", "phase" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "description": " Max length: 100;" }, "isIssueFlag": { "type": "boolean", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string", "description": " Max length: 50;" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "siteName": { "type": "string", "description": " Max length: 156;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateIdentifier": { "type": "string", "description": " Max length: 50;" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "contactName": { "type": "string", "description": " Max length: 62;" }, "contactPhoneNumber": { "type": "string", "description": " Max length: 20;" }, "contactPhoneExtension": { "type": "string", "description": " Max length: 15;" }, "contactEmailAddress": { "type": "string", "description": " Max length: 250;" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "owner": { "$ref": "#/components/schemas/MemberReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "requiredDate": { "type": "string", "format": "date-time" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "knowledgeBaseCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseSubCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseLinkId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseLinkType": { "enum": [ "Activity", "ProjectIssue", "KnowledgeBaseArticle", "ProjectTicket", "ServiceTicket", "Time" ], "type": "string", "nullable": true }, "allowAllClientsPortalView": { "type": "boolean", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "automaticEmailContactFlag": { "type": "boolean", "nullable": true }, "automaticEmailResourceFlag": { "type": "boolean", "nullable": true }, "automaticEmailCcFlag": { "type": "boolean", "nullable": true }, "automaticEmailCc": { "type": "string", "description": " Max length: 1000;" }, "closedDate": { "type": "string" }, "closedBy": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "approved": { "type": "boolean", "nullable": true }, "subBillingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "subBillingAmount": { "type": "number", "format": "double", "nullable": true }, "subDateAccepted": { "type": "string" }, "resources": { "type": "string" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "predecessorType": { "enum": [ "Ticket", "Phase" ], "type": "string", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorClosedFlag": { "type": "boolean", "nullable": true }, "lagDays": { "type": "integer", "format": "int32", "nullable": true }, "lagNonworkingDaysFlag": { "type": "boolean", "nullable": true }, "estimatedStartDate": { "type": "string", "format": "date-time" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "scheduleStartDate": { "type": "string", "format": "date-time" }, "scheduleEndDate": { "type": "string", "format": "date-time" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "tasks": { "type": "array", "items": { "$ref": "#/components/schemas/TicketTask" } }, "initialDescription": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialInternalAnalysis": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialResolution": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "contactEmailLookup": { "type": "string" }, "processNotifications": { "type": "boolean", "description": "Can be set to false to skip notification processing when adding or updating a ticket (Defaults to True).", "nullable": true }, "skipCallback": { "type": "boolean", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "ProjectTicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "noteType": { "enum": [ "TicketNote", "TimeEntryNote", "MeetingNote" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "timeStart": { "type": "string", "format": "date-time" }, "timeEnd": { "type": "string", "format": "date-time" }, "bundledFlag": { "type": "boolean", "nullable": true }, "mergedFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "originalAuthor": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ProjectWorkplan": { "type": "object", "properties": { "projectId": { "type": "integer", "format": "int32" }, "phases": { "type": "array", "items": { "$ref": "#/components/schemas/ProjectWorkplanProjectPhase" } } } }, "ProjectWorkplanProjectPhase": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "projectId": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "status": { "$ref": "#/components/schemas/PhaseStatusReference" }, "parentPhase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "wbsCode": { "type": "string" }, "markAsMilestoneFlag": { "type": "boolean", "nullable": true }, "notes": { "type": "string" }, "startDate": { "type": "string" }, "endDate": { "type": "string" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "billableHours": { "type": "number", "format": "double", "nullable": true }, "scheduled_Hours": { "type": "number", "format": "double", "nullable": true }, "scheduled_Start": { "type": "string" }, "scheduled_End": { "type": "string" }, "scheduled_Duration": { "type": "integer", "format": "int32", "nullable": true }, "billPhaseSeparately": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "RelationshipReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReminderReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ReportCardReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "RequestPasswordRequest": { "required": [ "email" ], "type": "object", "properties": { "email": { "type": "string" } } }, "ResultInfo": { "type": "object", "properties": { "success": { "type": "boolean" }, "originalIndex": { "type": "integer", "format": "int32" }, "statusCode": { "type": "integer", "format": "int32" }, "data": { "$ref": "#/components/schemas/IRestIdentifiedItem" }, "error": { "$ref": "#/components/schemas/ErrorResponseMessage" } } }, "SLA": { "required": [ "name", "basedOn" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 25;" }, "basedOn": { "enum": [ "AllHours", "Customer", "MyCalendar", "Custom" ], "type": "string", "nullable": true }, "customCalendar": { "$ref": "#/components/schemas/CalendarReference" }, "defaultFlag": { "type": "boolean", "nullable": true }, "applicationOrder": { "type": "integer", "format": "int32", "nullable": true }, "hiImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "hiImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "hiImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "medImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactHiUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactMedUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "lowImpactLowUrgency": { "$ref": "#/components/schemas/PriorityReference" }, "respondHours": { "type": "number", "format": "double", "nullable": true }, "respondPercent": { "type": "integer", "format": "int32", "nullable": true }, "planWithin": { "type": "number", "format": "double", "nullable": true }, "planWithinPercent": { "type": "integer", "format": "int32", "nullable": true }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolutionPercent": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "SLAInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SLAPriority": { "required": [ "priority" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "respondHours": { "type": "number", "format": "double", "nullable": true }, "respondPercent": { "type": "integer", "format": "int32", "nullable": true }, "planWithin": { "type": "number", "format": "double", "nullable": true }, "planWithinPercent": { "type": "integer", "format": "int32", "nullable": true }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolutionPercent": { "type": "integer", "format": "int32", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" }, "serviceSlaPriorityCwId": { "type": "string" } } }, "SLAReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleDetail": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "scheduleEntry": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "dateStart": { "type": "string" }, "dateEnd": { "type": "string" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleEntry": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "objectId": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string", "description": " Max length: 250;" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "where": { "$ref": "#/components/schemas/ServiceLocationReference" }, "dateStart": { "type": "string", "format": "date-time" }, "dateEnd": { "type": "string", "format": "date-time" }, "reminder": { "$ref": "#/components/schemas/ReminderReference" }, "status": { "$ref": "#/components/schemas/ScheduleStatusReference" }, "type": { "$ref": "#/components/schemas/ScheduleTypeReference" }, "span": { "$ref": "#/components/schemas/ScheduleSpanReference" }, "doneFlag": { "type": "boolean", "nullable": true }, "acknowledgedFlag": { "type": "boolean", "nullable": true }, "ownerFlag": { "type": "boolean", "nullable": true }, "meetingFlag": { "type": "boolean", "nullable": true }, "ticketType": { "type": "string" }, "allowScheduleConflictsFlag": { "type": "boolean", "nullable": true }, "addMemberToProjectFlag": { "type": "boolean", "nullable": true }, "projectRoleId": { "type": "integer", "format": "int32", "nullable": true }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "acknowledgedDate": { "type": "string", "format": "date-time" }, "closeDate": { "type": "string", "format": "date-time" }, "notifyResource": { "type": "boolean", "nullable": true }, "notificationSent": { "type": "boolean", "nullable": true }, "notificationResponse": { "type": "string" }, "hours": { "type": "number", "format": "double", "nullable": true }, "startTimeSet": { "type": "boolean", "nullable": true }, "endTimeSet": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleEntryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleSpanReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ScheduleTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SecurityRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceEmailTemplate": { "required": [ "type" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "type": { "enum": [ "Any", "Closed", "Invoice", "New", "SalesOrder", "PurchaseOrder", "RMA", "Specific" ], "type": "string", "nullable": true }, "serviceSurvey": { "$ref": "#/components/schemas/ServiceSurveyReference" }, "serviceBoard": { "$ref": "#/components/schemas/BoardReference" }, "useSenderFlag": { "type": "boolean", "nullable": true }, "firstName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "lastName": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "emailAddress": { "type": "string", "description": "From fields (first name, last name, email address) are required if useSenderFlag is false. Max length: 100;" }, "subject": { "type": "string", "description": " Max length: 200;" }, "body": { "type": "string" }, "copySenderFlag": { "type": "boolean", "nullable": true }, "tasksFlag": { "type": "boolean", "nullable": true }, "resourceRecordsFlag": { "type": "boolean", "nullable": true }, "externalContactNotifications": { "type": "boolean", "nullable": true }, "internalContactNotifications": { "type": "boolean", "nullable": true }, "serviceStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ServiceEmailTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceItemReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceLocation": { "required": [ "name", "where" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 30;" }, "where": { "enum": [ "OnSite", "Remote", "InHouse" ], "type": "string", "nullable": true }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ServiceLocationInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceLocationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "processNotifications": { "type": "boolean", "nullable": true }, "dateCreated": { "type": "string" }, "createdBy": { "type": "string" }, "internalFlag": { "type": "boolean", "nullable": true }, "externalFlag": { "type": "boolean", "nullable": true }, "sentimentScore": { "type": "number", "format": "double", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSignoffReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSourceReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceStatusReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "sort": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSubTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceSurvey": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "headerIncludeLogoFlag": { "type": "boolean", "nullable": true }, "headerText": { "type": "string", "description": " Max length: 4000;" }, "headerTextVisibleFlag": { "type": "boolean", "nullable": true }, "footerText": { "type": "string", "description": " Max length: 500;" }, "footerTextVisibleFlag": { "type": "boolean", "nullable": true }, "thankYouText": { "type": "string", "description": " Max length: 4000;" }, "notifyWho": { "$ref": "#/components/schemas/GenericIdIdentifierReference" }, "notifyWhoVisibleFlag": { "type": "boolean", "nullable": true }, "notifyMember": { "$ref": "#/components/schemas/MemberReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ServiceSurveyQuestion": { "required": [ "type", "question" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "sequenceNumber": { "type": "integer", "format": "int32", "nullable": true }, "type": { "enum": [ "OpenEnded", "Selection" ], "type": "string", "nullable": true }, "question": { "type": "string", "description": " Max length: 1000;" }, "options": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceSurveyQuestionOption" } }, "includeFlag": { "type": "boolean", "nullable": true }, "requiredFlag": { "type": "boolean", "nullable": true }, "noAnswerPoints": { "type": "integer", "format": "int32", "nullable": true }, "surveyId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "ServiceSurveyQuestionOption": { "type": "object", "properties": { "includeFlag": { "type": "boolean", "nullable": true }, "caption": { "type": "string" }, "points": { "type": "integer", "format": "int32", "nullable": true } } }, "ServiceSurveyReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "schedule": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "resolution": { "type": "string" }, "childScheduleAction": { "enum": [ "Transfer", "Delete", "Done" ], "type": "string", "nullable": true }, "childTicketId": { "type": "integer", "format": "int32", "nullable": true }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTeam": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "leader": { "$ref": "#/components/schemas/MemberReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "deleteNotifyFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTeamReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplate": { "required": [ "name", "board", "status", "summary" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "subtype": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "assignedNotifyFlag": { "type": "boolean", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "summary": { "type": "string", "description": " Max length: 100;" }, "problem": { "type": "string" }, "hoursBudget": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "internalAnalysis": { "type": "string" }, "resolution": { "type": "string" }, "timeBillableFlag": { "type": "boolean", "nullable": true }, "expenseBillableFlag": { "type": "boolean", "nullable": true }, "productBillableFlag": { "type": "boolean", "nullable": true }, "purchaseOrderNumber": { "type": "string", "description": " Max length: 25;" }, "reference": { "type": "string", "description": " Max length: 50;" }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "billComplete_Flag": { "type": "boolean", "nullable": true }, "billServiceSeparatelyFlag": { "type": "boolean", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "billUnapprovedTimeAndExpensesFlag": { "type": "boolean", "nullable": true }, "overrideFlag": { "type": "boolean", "nullable": true }, "timeInvoiceFlag": { "type": "boolean", "nullable": true }, "expenseInvoiceFlag": { "type": "boolean", "nullable": true }, "productInvoiceFlag": { "type": "boolean", "nullable": true }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "severity": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "impact": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "assignedBy": { "$ref": "#/components/schemas/MemberReference" }, "scheduleDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "serviceDaysBefore": { "type": "integer", "format": "int32", "nullable": true }, "attachScheduleToNewServiceFlag": { "type": "boolean", "nullable": true }, "templateFlag": { "type": "boolean", "nullable": true }, "emailContactFlag": { "type": "boolean", "nullable": true }, "emailResourceFlag": { "type": "boolean", "nullable": true }, "emailCCFlag": { "type": "boolean", "nullable": true }, "emailCC": { "type": "string", "description": " Max length: 1000;" }, "restrictDownpaymentFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "templateFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateTask": { "required": [ "priority", "notes" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "linkedServiceTemplateTask": { "$ref": "#/components/schemas/ServiceTemplateTaskReference" }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "notes": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTemplateTaskReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTicketLink": { "required": [ "name", "linkText", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "enabledFlag": { "type": "boolean", "nullable": true }, "linkText": { "type": "string", "description": " Max length: 50;" }, "url": { "type": "string", "description": " Max length: 1000;" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "ServiceTicketLinkInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "enabledFlag": { "type": "boolean", "nullable": true }, "linkText": { "type": "string" }, "url": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "noteType": { "enum": [ "TicketNote", "TimeEntryNote", "MeetingNote" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "text": { "type": "string" }, "isMarkdownFlag": { "type": "boolean", "nullable": true }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "timeStart": { "type": "string" }, "timeEnd": { "type": "string" }, "bundledFlag": { "type": "boolean", "nullable": true }, "mergedFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "originalAuthor": { "type": "string" }, "createdByParentFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "ServiceTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Severity": { "required": [ "description" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string", "description": " Max length: 200;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "SicCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SiteReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillCategoryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SkillReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Source": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "defaultFlag": { "type": "boolean", "nullable": true }, "enteredBy": { "type": "string" }, "dateEntered": { "type": "string", "format": "date-time" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "SourceInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StandardNoteInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "contents": { "type": "string" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StateReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StatusIndicatorReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "StructureReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SuccessResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } } }, "SurveyOption": { "required": [ "caption", "points" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "caption": { "type": "string", "description": " Max length: 100;" }, "points": { "type": "integer", "format": "int32", "nullable": true }, "visibleflag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" }, "parentConnectWiseId": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentConnectWiseId": { "type": "string" } } }, "SurveyResult": { "required": [ "ticketId" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "emailAddress": { "type": "string" }, "footerResponse": { "type": "string" }, "contactMeFlag": { "type": "boolean", "nullable": true }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/SurveyResultDetail" } }, "totalPoints": { "type": "integer", "format": "int32", "nullable": true }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "surveyId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SurveyResultDetail": { "type": "object", "properties": { "questionId": { "type": "integer", "format": "int32", "nullable": true }, "answer": { "type": "object", "description": "If question type is Selection, this should be the option array index." } } }, "SystemDepartmentReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "SystemLocationReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TaxCodeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamMember": { "required": [ "team", "member" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "board": { "$ref": "#/components/schemas/BoardReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "teamLeaderFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TeamRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TemplateGenerate": { "type": "object", "properties": { "generateAllRecordsFlag": { "type": "boolean", "nullable": true } } }, "TemplateGeneratedCountsModel": { "type": "object", "properties": { "serviceCount": { "type": "integer", "format": "int32" }, "scheduleCount": { "type": "integer", "format": "int32" } } }, "Ticket": { "required": [ "summary", "company" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string", "description": " Max length: 100;" }, "recordType": { "enum": [ "ProjectIssue", "ProjectTicket", "ServiceTicket" ], "type": "string", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "site": { "$ref": "#/components/schemas/SiteReference" }, "siteName": { "type": "string", "description": " Max length: 156;" }, "addressLine1": { "type": "string", "description": " Max length: 50;" }, "addressLine2": { "type": "string", "description": " Max length: 50;" }, "city": { "type": "string", "description": " Max length: 50;" }, "stateIdentifier": { "type": "string", "description": " Max length: 50;" }, "zip": { "type": "string", "description": " Max length: 12;" }, "country": { "$ref": "#/components/schemas/CountryReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "contactName": { "type": "string", "description": " Max length: 62;" }, "contactPhoneNumber": { "type": "string", "description": " Max length: 20;" }, "contactPhoneExtension": { "type": "string", "description": " Max length: 15;" }, "contactEmailAddress": { "type": "string", "description": " Max length: 250;" }, "type": { "$ref": "#/components/schemas/ServiceTypeReference" }, "subType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "item": { "$ref": "#/components/schemas/ServiceItemReference" }, "team": { "$ref": "#/components/schemas/ServiceTeamReference" }, "owner": { "$ref": "#/components/schemas/MemberReference" }, "priority": { "$ref": "#/components/schemas/PriorityReference" }, "serviceLocation": { "$ref": "#/components/schemas/ServiceLocationReference" }, "source": { "$ref": "#/components/schemas/ServiceSourceReference" }, "requiredDate": { "type": "string", "format": "date-time" }, "budgetHours": { "type": "number", "format": "double", "nullable": true }, "opportunity": { "$ref": "#/components/schemas/OpportunityReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "severity": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "impact": { "enum": [ "Low", "Medium", "High" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "externalXRef": { "type": "string", "description": " Max length: 100;" }, "poNumber": { "type": "string", "description": " Max length: 50;" }, "knowledgeBaseCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "knowledgeBaseSubCategoryId": { "type": "integer", "format": "int32", "nullable": true }, "allowAllClientsPortalView": { "type": "boolean", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "automaticEmailContactFlag": { "type": "boolean", "nullable": true }, "automaticEmailResourceFlag": { "type": "boolean", "nullable": true }, "automaticEmailCcFlag": { "type": "boolean", "nullable": true }, "automaticEmailCc": { "type": "string", "description": " Max length: 1000;" }, "initialDescription": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialInternalAnalysis": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialResolution": { "type": "string", "description": "Only available for POST, will not be returned in the response." }, "initialDescriptionFrom": { "type": "string" }, "contactEmailLookup": { "type": "string" }, "processNotifications": { "type": "boolean", "description": "Can be set to false to skip notification processing when adding or updating a ticket (Defaults to True).", "nullable": true }, "skipCallback": { "type": "boolean", "nullable": true }, "closedDate": { "type": "string" }, "closedBy": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "approved": { "type": "boolean", "nullable": true }, "estimatedExpenseCost": { "type": "number", "format": "double", "nullable": true }, "estimatedExpenseRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedProductCost": { "type": "number", "format": "double", "nullable": true }, "estimatedProductRevenue": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeCost": { "type": "number", "format": "double", "nullable": true }, "estimatedTimeRevenue": { "type": "number", "format": "double", "nullable": true }, "billingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "billingAmount": { "type": "number", "format": "double", "nullable": true }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "subBillingMethod": { "enum": [ "ActualRates", "FixedFee", "NotToExceed", "OverrideRate" ], "type": "string", "nullable": true }, "subBillingAmount": { "type": "number", "format": "double", "nullable": true }, "subDateAccepted": { "type": "string" }, "dateResolved": { "type": "string" }, "dateResplan": { "type": "string" }, "dateResponded": { "type": "string" }, "resolveMinutes": { "type": "integer", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "int32", "nullable": true }, "resPlanMinutes": { "type": "integer", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "int32", "nullable": true }, "respondMinutes": { "type": "integer", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "int32", "nullable": true }, "respondByGoalUTC": { "type": "string", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "date-time" }, "resplanGoalUTC": { "type": "string", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "date-time" }, "resolutionGoalUTC": { "type": "string", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "date-time" }, "escalationLastUpdateMinutes": { "type": "integer", "description": "To obtain the current SLA times for an active ticket, please use the /service/tickets/calculateSLA endpoint for multiple tickets or /service/tickets/{id} for individual tickets.", "format": "int32", "nullable": true }, "isInSla": { "type": "boolean", "nullable": true }, "knowledgeBaseLinkId": { "type": "integer", "format": "int32", "nullable": true }, "resources": { "type": "string" }, "parentTicketId": { "type": "integer", "format": "int32", "nullable": true }, "hasChildTicket": { "type": "boolean", "nullable": true }, "hasMergedChildTicketFlag": { "type": "boolean", "nullable": true }, "knowledgeBaseLinkType": { "enum": [ "Activity", "ProjectIssue", "KnowledgeBaseArticle", "ProjectTicket", "ServiceTicket", "Time" ], "type": "string", "nullable": true }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billExpenses": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "billProducts": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "nullable": true }, "predecessorType": { "enum": [ "Ticket", "Phase" ], "type": "string", "nullable": true }, "predecessorId": { "type": "integer", "format": "int32", "nullable": true }, "predecessorClosedFlag": { "type": "boolean", "nullable": true }, "lagDays": { "type": "integer", "format": "int32", "nullable": true }, "lagNonworkingDaysFlag": { "type": "boolean", "nullable": true }, "estimatedStartDate": { "type": "string", "format": "date-time" }, "duration": { "type": "integer", "format": "int32", "nullable": true }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "sla": { "$ref": "#/components/schemas/SLAReference" }, "slaStatus": { "type": "string" }, "requestForChangeFlag": { "type": "boolean", "nullable": true }, "currency": { "$ref": "#/components/schemas/CurrencyReference" }, "mergedParentTicket": { "$ref": "#/components/schemas/TicketReference" }, "integratorTags": { "type": "array", "items": { "type": "string" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "escalationStartDateUTC": { "type": "string" }, "escalationLevel": { "type": "integer", "format": "int32", "nullable": true }, "minutesBeforeWaiting": { "type": "integer", "format": "int32", "nullable": true }, "respondedSkippedMinutes": { "type": "integer", "format": "int32", "nullable": true }, "resplanSkippedMinutes": { "type": "integer", "format": "int32", "nullable": true }, "respondedHours": { "type": "number", "format": "double", "nullable": true }, "respondedBy": { "type": "string" }, "resplanHours": { "type": "number", "format": "double", "nullable": true }, "resplanBy": { "type": "string" }, "resolutionHours": { "type": "number", "format": "double", "nullable": true }, "resolvedBy": { "type": "string" }, "minutesWaiting": { "type": "integer", "format": "int32", "nullable": true }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "TicketBundle": { "type": "object", "properties": { "childTicketIds": { "type": "array", "items": { "type": "integer", "format": "int32" } } } }, "TicketChangeLog": { "type": "object", "properties": { "id": { "type": "integer", "description": "Ticket Change Log ID", "format": "int32" }, "partnerId": { "type": "string", "description": "Partner ID." }, "productInstanceId": { "type": "string", "description": "Product Instance ID." }, "action": { "type": "string", "description": "Action." }, "boardId": { "type": "integer", "description": "Board ID.", "format": "int32", "nullable": true }, "boardName": { "type": "string", "description": "Board Name." }, "companyIdentifier": { "type": "integer", "description": "Company Identifier.", "format": "int32", "nullable": true }, "companyName": { "type": "string", "description": "Company Name." }, "contactId": { "type": "integer", "description": "Contact ID.", "format": "int32", "nullable": true }, "contactName": { "type": "string", "description": "Contact Name." }, "impact": { "type": "string", "description": "Impact." }, "ownerIdentifier": { "type": "integer", "description": "Owner Identifier.", "format": "int32", "nullable": true }, "priorityId": { "type": "integer", "description": "Priority ID.", "format": "int32", "nullable": true }, "priorityLevel": { "type": "string", "description": "Priority Level." }, "priorityName": { "type": "string", "description": "Priority Name." }, "prioritySort": { "type": "integer", "description": "Priority Sort.", "format": "int32", "nullable": true }, "resourceList": { "type": "string", "description": "Resource List." }, "severity": { "type": "string", "description": "Severity." }, "slaName": { "type": "string", "description": "SLA Name." }, "slaStatus": { "type": "string", "description": "SLA Status." }, "status": { "type": "string", "description": "Status." }, "summary": { "type": "string", "description": "Summary." }, "teamName": { "type": "string", "description": "Team Name." }, "ticketNumber": { "type": "integer", "description": "Ticket Number.", "format": "int32", "nullable": true }, "recordType": { "type": "string", "description": "Record Type." }, "ticketOwner": { "type": "string", "description": "Ticket Owner." }, "closedFlag": { "type": "boolean", "description": "Closed Flag.", "nullable": true }, "customerUpdatedFlag": { "type": "boolean", "description": "Customer Updated Flag.", "nullable": true }, "processingStatus": { "type": "string", "description": "Processing Status." }, "parentTicketId": { "type": "integer", "description": "Parent Ticket ID.", "format": "int32", "nullable": true }, "mergedParentTicketId": { "type": "integer", "description": "Merged Parent Ticket ID.", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "summary": { "type": "string" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketMerge": { "required": [ "mergeTicketIds", "status" ], "type": "object", "properties": { "mergeTicketIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "status": { "$ref": "#/components/schemas/ServiceStatusReference" } } }, "TicketNote": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "text": { "type": "string" }, "detailDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "issueFlag": { "type": "boolean", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "contact": { "$ref": "#/components/schemas/ContactReference" }, "customerUpdatedFlag": { "type": "boolean", "nullable": true }, "processNotifications": { "type": "boolean", "nullable": true }, "internalFlag": { "type": "boolean", "nullable": true }, "externalFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "summary": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketSync": { "required": [ "name", "vendorType", "integratorLogin", "company", "url" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 80;" }, "vendorType": { "enum": [ "Zenith" ], "type": "string", "nullable": true }, "integratorLogin": { "$ref": "#/components/schemas/IntegratorLoginReference" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "url": { "type": "string" }, "userName": { "type": "string" }, "password": { "type": "string" }, "psg": { "type": "string" }, "problemDescriptionFlag": { "type": "boolean", "nullable": true }, "internalAnalysisFlag": { "type": "boolean", "nullable": true }, "resolutionFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TicketTask": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "ticketId": { "type": "integer", "format": "int32", "nullable": true }, "notes": { "type": "string" }, "closedFlag": { "type": "boolean", "nullable": true }, "priority": { "type": "integer", "format": "int32", "nullable": true }, "schedule": { "$ref": "#/components/schemas/ScheduleEntryReference" }, "code": { "$ref": "#/components/schemas/ServiceCodeReference" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "resolution": { "type": "string" }, "summary": { "type": "string" }, "childScheduleAction": { "enum": [ "Transfer", "Delete", "Done" ], "type": "string", "nullable": true }, "childTicketId": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntry": { "required": [ "timeStart" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "company": { "$ref": "#/components/schemas/CompanyReference" }, "companyType": { "type": "string" }, "chargeToId": { "type": "integer", "description": "If chargeToId is not specified, we asume you enter time against the company specified", "format": "int32", "nullable": true }, "chargeToType": { "enum": [ "Company", "ServiceTicket", "ProjectTicket", "ChargeCode", "Activity" ], "type": "string", "description": "If chargeToId is not specified, we asume you enter time against the company specified", "nullable": true }, "member": { "$ref": "#/components/schemas/MemberReference" }, "locationId": { "type": "integer", "format": "int32", "nullable": true }, "businessUnitId": { "type": "integer", "format": "int32", "nullable": true }, "businessGroupDesc": { "type": "string" }, "location": { "$ref": "#/components/schemas/OwnerLevelReference" }, "department": { "$ref": "#/components/schemas/BillingUnitReference" }, "workType": { "$ref": "#/components/schemas/WorkTypeReference" }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "agreement": { "$ref": "#/components/schemas/AgreementReference" }, "agreementType": { "type": "string" }, "activity": { "$ref": "#/components/schemas/ActivityReference" }, "opportunityRecid": { "type": "integer", "format": "int32", "nullable": true }, "projectActivity": { "type": "string" }, "territory": { "type": "string" }, "timeStart": { "type": "string", "format": "date-time" }, "timeEnd": { "type": "string", "format": "date-time" }, "hoursDeduct": { "type": "number", "format": "double", "nullable": true }, "actualHours": { "type": "number", "format": "double", "nullable": true }, "billableOption": { "enum": [ "Billable", "DoNotBill", "NoCharge", "NoDefault" ], "type": "string", "description": " Required On Updates;", "nullable": true }, "notes": { "type": "string" }, "internalNotes": { "type": "string" }, "addToDetailDescriptionFlag": { "type": "boolean", "nullable": true }, "addToInternalAnalysisFlag": { "type": "boolean", "nullable": true }, "addToResolutionFlag": { "type": "boolean", "nullable": true }, "emailResourceFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailResourceFlag field", "nullable": true }, "emailContactFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailContactFlag field", "nullable": true }, "emailCcFlag": { "type": "boolean", "description": "This is an action flag. To update this value use the /service/tickets endpoint automaticEmailCcFlag field", "nullable": true }, "emailCc": { "type": "string", "description": "To update this value use the /service/tickets endpoint automaticEmailCc field" }, "hoursBilled": { "type": "number", "format": "double", "nullable": true }, "invoiceHours": { "type": "number", "format": "double", "nullable": true }, "hourlyCost": { "type": "string" }, "enteredBy": { "type": "string" }, "dateEntered": { "type": "string", "format": "date-time" }, "invoice": { "$ref": "#/components/schemas/InvoiceReference" }, "mobileGuid": { "type": "string", "format": "uuid", "nullable": true }, "hourlyRate": { "type": "number", "description": "This field may only be Updated, it is defaulted on Create", "format": "double", "nullable": true }, "overageRate": { "type": "number", "format": "double", "nullable": true }, "agreementHours": { "type": "number", "format": "double", "nullable": true }, "agreementAmount": { "type": "number", "format": "double", "nullable": true }, "agreementAdjustment": { "type": "number", "format": "double", "nullable": true }, "adjustment": { "type": "number", "format": "double", "nullable": true }, "invoiceReady": { "type": "integer", "format": "int32", "nullable": true }, "timeSheet": { "$ref": "#/components/schemas/TimeSheetReference" }, "status": { "enum": [ "Open", "Rejected", "PendingApproval", "ErrorsCorrected", "PendingProjectApproval", "ApprovedByTierOne", "RejectBySecondTier", "ApprovedByTierTwo", "ReadyToBill", "Billed", "WrittenOff", "BilledAgreement" ], "type": "string", "nullable": true }, "ticket": { "$ref": "#/components/schemas/TicketReference" }, "project": { "$ref": "#/components/schemas/ProjectReference" }, "phase": { "$ref": "#/components/schemas/ProjectPhaseReference" }, "ticketBoard": { "type": "string" }, "ticketStatus": { "type": "string" }, "ticketType": { "type": "string" }, "ticketSubType": { "type": "string" }, "invoiceFlag": { "type": "boolean", "nullable": true }, "extendedInvoiceAmount": { "type": "number", "format": "double", "nullable": true }, "locationName": { "type": "string" }, "taxCode": { "$ref": "#/components/schemas/TaxCodeReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "customFields": { "type": "array", "items": { "$ref": "#/components/schemas/CustomFieldValue" } } } }, "TimeEntryAudit": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "member": { "$ref": "#/components/schemas/MemberReference" }, "source": { "enum": [ "None", "Member", "API", "Workflow", "Portal", "Mobile", "Network", "EmailConnector", "MassMaintenance", "Application", "SystemAPI", "Conversion" ], "type": "string", "nullable": true }, "type": { "enum": [ "Activity", "CloseDate", "Company", "Contact", "Conversion", "Document", "Forecast", "Note", "Notes", "Opportunity", "Products", "Stage", "Status", "Surveys", "Team", "Tracks", "Configuration", "ConfigurationQuestions", "DeviceBackupDetails", "Tickets", "Subject", "ActivityOverview", "Schedule", "Resources", "ExpenseEntry", "Member", "Date", "Classification", "Amount", "ExpenseType", "WorkType", "WorkRole", "Mileage", "Billing", "ExpenseHeader", "Project", "TimeEntry", "TicketStatus", "DateTime", "DeductHours", "ActualHours", "Invoice", "CompanyFinance", "Billable", "SalesOrder", "Shipping", "Profile", "Group", "GroupContact", "GroupCompany", "Options", "Site", "Agreement", "Addition", "Adjustment", "Microsoft365", "API", "ProjectFinance", "CompanyProfile", "CompanyTeam", "CompanyMgmt", "InvoiceTotal", "BillingInformation", "ShippingInformation", "BillingStatus", "Location", "Department", "Territory", "Payment", "Credit", "SubcontractorInformation", "InvoicingParameters", "ApplicationParameters", "Finance", "Invoicing", "Email", "Batching", "KnowledgeBase", "KbArticle", "KnowledgeBaseApproval", "KnowledgeBaseTicket", "ManageNetwork", "Tasks", "CustomField", "ScreenConnect", "SLA", "Ticket", "Workflow", "Record", "CombinedTickets", "Template", "PurchaseOrder", "Meeting", "RmaOverview", "ReturnedBy", "PurchasedFromVendor", "WarrantyVendor", "RepairVendor", "AdditionalDetails", "TicketTemplate", "AutoGeneration", "TimeInternalNote", "TimeDiscussion", "TimeInternal", "TimeResolution", "MemberTemplate", "Delegation", "Skill", "Certification", "Accrual", "ApiKey", "Login", "Notifications", "System", "ServiceBoard", "ProjectBoard", "Scheduling", "TimeBillingExpense", "CRM", "Procurement", "JobRole", "Details", "Authentication" ], "type": "string", "nullable": true }, "message": { "type": "string" }, "oldValue": { "type": "string" }, "newValue": { "type": "string" }, "value": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntryReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeEntryTierReject": { "type": "object", "properties": { "comment": { "type": "string" }, "id": { "type": "integer", "format": "int32" }, "approvalType": { "enum": [ "DataEntry", "Tier1Update", "Tier2Update", "Billing", "Service", "Project", "MonthlySummary", "SalesActivity", "Schedule" ], "type": "string", "nullable": true } } }, "TimeEntryTierUpdate": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "approvalType": { "enum": [ "DataEntry", "Tier1Update", "Tier2Update", "Billing", "Service", "Project", "MonthlySummary", "SalesActivity", "Schedule" ], "type": "string", "nullable": true } } }, "TimeSheetReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "TimeZoneSetupReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Token": { "type": "object", "properties": { "publicKey": { "type": "string" }, "privateKey": { "type": "string" }, "expiration": { "type": "string" } } }, "TrackReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Usage": { "type": "object", "properties": { "type": { "type": "string" }, "count": { "type": "integer", "format": "int32", "nullable": true }, "id": { "type": "integer", "format": "int32", "nullable": true }, "description": { "type": "string" }, "hyperlink": { "type": "string" }, "typeKey": { "type": "string" } } }, "UserDefinedFieldReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "UserDefinedFieldValueModel": { "type": "object", "properties": { "userDefinedFieldRecId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "rowNum": { "type": "integer", "format": "int32" }, "skipLocationAndBillingUnit": { "type": "boolean" }, "filtered": { "type": "boolean" } } }, "ValidatePortalRequest": { "required": [ "email", "password" ], "type": "object", "properties": { "email": { "type": "string" }, "password": { "type": "string" } } }, "ValidatePortalResponse": { "type": "object", "properties": { "success": { "type": "boolean" }, "contactId": { "type": "integer", "format": "int32" } } }, "WarehouseBinReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WarehouseReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "lockedFlag": { "type": "boolean" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRole": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "integrationXref": { "type": "string", "description": " Max length: 50;" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "addAllLocations": { "type": "boolean", "nullable": true }, "removeAllLocations": { "type": "boolean", "nullable": true }, "addAllAgreementExclusions": { "type": "boolean", "description": "Used only on create to add the work role to all agreement and agreement type exclusion lists", "nullable": true }, "locationIds": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "WorkRoleInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "inactiveFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleLocation": { "required": [ "location" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "hourlyRate": { "type": "number", "format": "double", "nullable": true }, "workRole": { "$ref": "#/components/schemas/WorkRoleReference" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkRoleReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkType": { "required": [ "name", "billTime", "rateType", "rate" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 50;" }, "billTime": { "enum": [ "Billable", "DoNotBill", "NoCharge" ], "type": "string", "nullable": true }, "rateType": { "enum": [ "AdjAmount", "Custom", "Multiplier" ], "type": "string", "nullable": true }, "rate": { "type": "number", "format": "double", "nullable": true }, "hoursMin": { "type": "number", "format": "double", "nullable": true }, "hoursMax": { "type": "number", "format": "double", "nullable": true }, "roundBillHoursTo": { "type": "number", "format": "double", "nullable": true }, "accrualType": { "enum": [ "Holiday", "PTO", "Sick", "Vacation" ], "type": "string", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "overallDefaultFlag": { "type": "boolean", "nullable": true }, "activityDefaultFlag": { "type": "boolean", "nullable": true }, "utilizationFlag": { "type": "boolean", "nullable": true }, "costMultiplier": { "type": "number", "format": "double", "nullable": true }, "integrationXRef": { "type": "string", "description": " Max length: 50;" }, "addAllAgreementExclusions": { "type": "boolean", "description": "Used only on create to add the work type to all agreement and agreement type exclusion lists", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } }, "connectWiseId": { "type": "string" } } }, "WorkTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "defaultFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "activityDefaultFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "name": { "type": "string" }, "utilizationFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "Workflow": { "required": [ "name", "tableType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string", "description": " Max length: 100;" }, "tableType": { "$ref": "#/components/schemas/WorkflowTableTypeReference" }, "location": { "$ref": "#/components/schemas/SystemLocationReference" }, "department": { "$ref": "#/components/schemas/SystemDepartmentReference" }, "activateFlag": { "type": "boolean", "description": "Batches can not be turned on until after the workflow is created and it has atleast one event associated with it", "nullable": true }, "batchInterval": { "type": "integer", "format": "int32", "nullable": true }, "batchFrequencyUnit": { "enum": [ "Minutes", "Hours", "Days" ], "type": "string", "description": "If not specified, defaults to Minutes. Months is not supported as month length varies", "nullable": true }, "batchLastRan": { "type": "string", "format": "date-time" }, "batchSchedule": { "enum": [ "AnyTime", "MyCompanyOfficeHours", "SlaHours" ], "type": "string", "description": "If activateFlag is true, batchSchedule is required", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowAction": { "required": [ "notifyType" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "notifyType": { "$ref": "#/components/schemas/NotifyTypeReference" }, "notifyWho": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "specificMemberTo": { "$ref": "#/components/schemas/MemberReference" }, "emailRecipient": { "type": "string", "description": "Required when notifyWho is set to: \"Email Address\" Max length: 250;" }, "notifyFrom": { "$ref": "#/components/schemas/NotificationRecipientReference" }, "specificMemberFrom": { "$ref": "#/components/schemas/MemberReference" }, "emailFrom": { "type": "string", "description": "Required when notifyFrom is set to: \"Email Address\" Max length: 250;" }, "ccContact": { "$ref": "#/components/schemas/ContactReference" }, "bccContact": { "$ref": "#/components/schemas/ContactReference" }, "subject": { "type": "string", "description": "Required when notifyType is set to: \"Create Activity\", \"Send Email\", \"Assign Resource\" Max length: 100;" }, "notes": { "type": "string" }, "activityStatus": { "$ref": "#/components/schemas/ActivityStatusReference" }, "activityType": { "$ref": "#/components/schemas/ActivityTypeReference" }, "attachedTrack": { "$ref": "#/components/schemas/TrackReference" }, "daysToExecute": { "type": "integer", "format": "int32", "nullable": true }, "board": { "$ref": "#/components/schemas/BoardReference" }, "boardStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "serviceType": { "$ref": "#/components/schemas/ServiceTypeReference" }, "serviceSubType": { "$ref": "#/components/schemas/ServiceSubTypeReference" }, "serviceItem": { "$ref": "#/components/schemas/ServiceItemReference" }, "group": { "$ref": "#/components/schemas/GroupReference" }, "serviceTemplate": { "$ref": "#/components/schemas/ServiceTemplateReference" }, "invoiceMinDays": { "type": "integer", "format": "int32", "nullable": true }, "automateScript": { "$ref": "#/components/schemas/AutomateScriptReference" }, "scriptSuccessStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "scriptFailStatus": { "$ref": "#/components/schemas/ServiceStatusReference" }, "detailNotesFlag": { "type": "boolean", "nullable": true }, "internalNotesFlag": { "type": "boolean", "nullable": true }, "auditNotesFlag": { "type": "boolean", "nullable": true }, "servicePriority": { "$ref": "#/components/schemas/PriorityReference" }, "updateOwnerFlag": { "type": "boolean", "nullable": true }, "salesOrderStatus": { "$ref": "#/components/schemas/OrderStatusReference" }, "projectStatus": { "$ref": "#/components/schemas/ProjectStatusReference" }, "companyStatus": { "$ref": "#/components/schemas/CompanyStatusReference" }, "attachments": { "type": "array", "items": { "type": "integer", "format": "int32" } }, "serviceSurvey": { "$ref": "#/components/schemas/ServiceSurveyReference" }, "specificTeamTo": { "$ref": "#/components/schemas/GenericBoardTeamReference" }, "attachConfigurationsFor": { "enum": [ "Company", "Contact" ], "type": "string", "description": "Required when notifyType is set to: \"Attach Configuration\"", "nullable": true }, "configurationType": { "$ref": "#/components/schemas/ConfigurationTypeReference" }, "configurationStatus": { "$ref": "#/components/schemas/ConfigurationStatusReference" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyEvents_RecID", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowActionAutomateParameter": { "required": [ "name" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "value": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyActions_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowActionUserDefinedField": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "eventId": { "type": "integer", "format": "int32" }, "actionId": { "type": "integer", "format": "int32" }, "caption": { "type": "string" }, "userDefinedFieldId": { "type": "integer", "format": "int32" }, "value": { "type": "string" }, "overwriteFlag": { "type": "boolean", "nullable": true }, "podDescription": { "type": "string" }, "fieldTypeId": { "type": "string" }, "entryTypeId": { "type": "string" }, "requiredFlag": { "type": "boolean", "nullable": true }, "inactiveFlag": { "type": "boolean", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyActions_RecID", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "description": "WF_NotifyEvents_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowAttachment": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowEvent": { "required": [ "eventCondition" ], "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "eventCondition": { "type": "string" }, "frequencyUnit": { "enum": [ "Minutes", "Hours", "Days", "Months" ], "type": "string", "description": "Required when exectionTimes is set to MultipleTimes or Continuously", "nullable": true }, "frequencyOfExecution": { "type": "integer", "description": "Required when exectionTimes is set to MultipleTimes or Continuously", "format": "int32", "nullable": true }, "maxNumberOfExecution": { "type": "integer", "description": "Required when exectionTimes is set to MultipleTimes", "format": "int32", "nullable": true }, "executionTime": { "enum": [ "Once", "MultipleTimes", "Continuously" ], "type": "string", "description": "Defaults to Once when not specified", "nullable": true }, "dateTestedUTC": { "type": "string", "format": "date-time" }, "testRecordsMatched": { "type": "integer", "format": "int32", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowNotifyType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "isSetupFlag": { "type": "boolean", "description": "If the current action is available because it is already set up. Pertains to integrations such as Automate", "nullable": true }, "externalFlag": { "type": "boolean", "description": "If the current action effects external objects e.g. integrations or sending an email", "nullable": true }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "description": "WF_NotifyHeader_RecID", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowNotifyTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "isSetupFlag": { "type": "boolean", "nullable": true }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableType": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "connectWiseID": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableTypeInfo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTableTypeReference": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32", "nullable": true }, "identifier": { "type": "string" }, "name": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTrigger": { "type": "object", "properties": { "id": { "type": "integer", "format": "int32" }, "name": { "type": "string" }, "description": { "type": "string" }, "hasOptionsFlag": { "type": "boolean", "nullable": true }, "hasOperatorFlag": { "type": "boolean", "nullable": true }, "customField": { "$ref": "#/components/schemas/UserDefinedFieldReference" }, "expectedType": { "type": "string" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } }, "WorkflowTriggerOption": { "type": "object", "properties": { "value": { "type": "string" }, "name": { "type": "string" }, "customField": { "$ref": "#/components/schemas/UserDefinedFieldReference" }, "connectWiseID": { "type": "string" }, "parentId": { "type": "integer", "format": "int32", "nullable": true }, "grandParentId": { "type": "integer", "format": "int32", "nullable": true }, "parentConnectWiseId": { "type": "string" }, "grandParentConnectWiseId": { "type": "string" }, "_info": { "type": "object", "additionalProperties": { "type": "string" } } } } } } }