Every API here is available over the APIs.io API and to AI agents over MCP.
{
"openapi": "3.0.1",
"info": {
"title": "BMS API 2.0",
"description": "Documentation of APIs Version 2.0",
"version": "2.0"
},
"servers": [
{
"url": "https://api.bms.kaseya.com"
}
],
"paths": {
"/v2/admin/finance/accountcodes/lookup": {
"get": {
"tags": [
"AccountCodes"
],
"operationId": "GetAccountCodesLookup",
"parameters": [
{
"name": "Filter.Name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountCodeLookupOutputDtoIEnumerableResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountCodeLookupOutputDtoIEnumerableResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountCodeLookupOutputDtoIEnumerableResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/lookup": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccounts",
"parameters": [
{
"name": "Filter.Ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Filter.Name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.WithSecurityScope",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Filter.WithInactiveAccounts",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/summary": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountsListSummary",
"parameters": [
{
"name": "Filter.AccountName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.AccountCode",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.AccountTypeId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Filter.AccountTypeName",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.CreatedOnFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Filter.CreatedOnTo",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Filter.ModifiedOnFrom",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Filter.ModifiedOnTo",
"in": "query",
"schema": {
"type": "string",
"format": "date-time"
}
},
{
"name": "Filter.IsActive",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoIEnumerablePagedResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoIEnumerablePagedResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoIEnumerablePagedResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/summary/{id}": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountSummary",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDto"
}
}
}
}
}
}
},
"/v2/crm/accounts/{accountId}/locations/lookup": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountLocations",
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountLocationLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountLocationLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountLocationLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/{accountId}/locations/{locationId}": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountLocation",
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "locationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountLocationOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountLocationOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountLocationOutputDtoResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/{accountId}/contacts/lookup": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountContacts",
"parameters": [
{
"name": "Filter.Name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.LocationId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ContactLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ContactLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/{accountId}/contacts/{contactId}/summaryinfo": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountContactSummaryInfo",
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "contactId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ContactSummaryInfoOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactSummaryInfoOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ContactSummaryInfoOutputDtoResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/{accountId}/alerts/{accountAlertType}": {
"get": {
"tags": [
"Accounts"
],
"operationId": "GetAccountAlert",
"parameters": [
{
"name": "accountId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "accountAlertType",
"in": "path",
"required": true,
"schema": {
"$ref": "#/components/schemas/AccountAlertType"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountAlertOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountAlertOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountAlertOutputDtoResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts": {
"post": {
"tags": [
"Accounts"
],
"operationId": "PostAccount",
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AccountPostInputDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPostInputDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPostInputDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AccountPostInputDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
}
}
}
}
}
},
"/v2/crm/accounts/{id}": {
"put": {
"tags": [
"Accounts"
],
"operationId": "PutAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"$ref": "#/components/schemas/AccountPutInputDto"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountPutInputDto"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountPutInputDto"
}
},
"application/*+json": {
"schema": {
"$ref": "#/components/schemas/AccountPutInputDto"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
}
}
}
}
},
"patch": {
"tags": [
"Accounts"
],
"operationId": "PatchAccount",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"requestBody": {
"content": {
"application/json-patch+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
},
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
},
"text/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
},
"application/*+json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Operation"
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountSummaryOutputDtoResponse"
}
}
}
}
}
}
},
"/v2/system/accounttypes/lookup": {
"get": {
"tags": [
"AccountTypes"
],
"operationId": "GetAccountTypesLookup",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AccountTypeLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccountTypeLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AccountTypeLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/admin/{integrationTypeId}/agentprocedures": {
"get": {
"tags": [
"AgentProcedure"
],
"operationId": "GetAgentProcedures",
"parameters": [
{
"name": "integrationTypeId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Filter.Id",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Filter.Name",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AgentProcedureOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AgentProcedureOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AgentProcedureOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/system/approvalroutes/lookup": {
"get": {
"tags": [
"ApprovalRoutes"
],
"operationId": "GetApprovalRoutesLookup",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/ApprovalRouteLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalRouteLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/ApprovalRouteLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/hr/assignees": {
"get": {
"tags": [
"Assignees"
],
"operationId": "GetAssignees",
"parameters": [
{
"name": "Name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "EmployeesOnly",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AssigneeOutputDtoIEnumerableResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssigneeOutputDtoIEnumerableResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssigneeOutputDtoIEnumerableResponse"
}
}
}
}
}
}
},
"/v2/hr/assignees/lookup": {
"get": {
"tags": [
"Assignees"
],
"operationId": "GetAssigneeLookups",
"parameters": [
{
"name": "Filter.Ids",
"in": "query",
"schema": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
}
},
{
"name": "Filter.Name",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.ExcludedIds",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Filter.AccountId",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AssigneeLookupOutputDtoIEnumerableResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AssigneeLookupOutputDtoIEnumerableResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AssigneeLookupOutputDtoIEnumerableResponse"
}
}
}
}
}
}
},
"/v2/hr/assignees/count": {
"get": {
"tags": [
"Assignees"
],
"operationId": "GetAssigneesCount",
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/Int32Response"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/Int32Response"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/Int32Response"
}
}
}
}
}
}
},
"/v2/hr/assignees/{assigneeId}/roles": {
"get": {
"tags": [
"Assignees"
],
"operationId": "GetEmployeeRoleLookups",
"parameters": [
{
"name": "assigneeId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/RoleLookupOutputDtoListResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleLookupOutputDtoListResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/RoleLookupOutputDtoListResponse"
}
}
}
}
}
}
},
"/v2/system/attachments/{moduleId}/{objectId}": {
"get": {
"tags": [
"Attachments"
],
"operationId": "GetAttachments",
"parameters": [
{
"name": "objectId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "moduleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "Sort",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "Exclude",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "PageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
},
{
"name": "PageNumber",
"in": "query",
"schema": {
"type": "integer",
"format": "int32"
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"text/plain": {
"schema": {
"$ref": "#/components/schemas/AttachmentOutputDtoIEnumerablePagedResponse"
}
},
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentOutputDtoIEnumerablePagedResponse"
}
},
"text/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentOutputDtoIEnumerablePagedResponse"
}
}
}
}
}
},
"post": {
"tags": [
"Attachments"
],
"operationId": "Post",
"parameters": [
{
"name": "objectId",
"in
# --- truncated at 32 KB (1371 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/kaseya/refs/heads/main/openapi/kaseya-bms-openapi-original.json