### Get Customers API Response Example

Source: https://app.atera.com/apidocs

This is an example of a successful response when retrieving a list of customers. It includes pagination details and customer data.

```json
{
  "items": [
    {
      "CustomerID": 0,
      "CustomerName": "string",
      "CreatedOn": "2026-05-19T09:24:18.754Z",
      "LastModified": "2026-05-19T09:24:18.754Z",
      "BusinessNumber": "string",
      "Domain": "string",
      "Address": "string",
      "City": "string",
      "State": "string",
      "Country": "string",
      "Phone": "string",
      "Fax": "string",
      "Notes": "string",
      "Logo": "string",
      "Links": "string",
      "Longitude": 0,
      "Latitude": 0,
      "ZipCodeStr": "string"
    }
  ],
  "totalItemCount": 0,
  "page": 0,
  "itemsInPage": 0,
  "totalPages": 0,
  "prevLink": "string",
  "nextLink": "string"
}
```

--------------------------------

### Get Customer API Response (JSON Example)

Source: https://app.atera.com/apidocs

Provides an example of a successful response (200 OK) when retrieving customer details. This JSON object includes various customer attributes.

```json
{
  "CustomerID": 1,
  "CustomerName": "Example Customer",
  "CreatedOn": "2026-05-19T09:24:18.5283056Z",
  "LastModified": "2026-05-19T09:24:18.5283056Z",
  "BusinessNumber": "BN12345",
  "Domain": "exampledomain.com",
  "Address": "Main street 10",
  "City": "New York City",
  "State": "New York",
  "Country": "United States",
  "Phone": "3-659854875",
  "Fax": "3-659854876",
  "Notes": "Notes for new customer..",
  "Links": "http://www.examplecustomer.com",
  "Longitude": 45.0345345,
  "Latitude": 45.0345345,
  "ZipCodeStr": "5000CR"
}
```

--------------------------------

### Get Customer API Response (XML Example)

Source: https://app.atera.com/apidocs

An example of a successful response (200 OK) when retrieving customer details, formatted as XML. This structure mirrors the JSON response with corresponding elements.

```xml
<?xml version="1.0"?>
<CustomerQueryDTO>
  <CustomerID>1</CustomerID>
  <CustomerName>string</CustomerName>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <LastModified>1970-01-01T00:00:00.001Z</LastModified>
  <BusinessNumber>string</BusinessNumber>
  <Domain>string</Domain>
  <Address>string</Address>
  <City>string</City>
  <State>string</State>
  <Country>string</Country>
  <Phone>string</Phone>
  <Fax>string</Fax>
  <Notes>string</Notes>
  <Logo>string</Logo>
  <Links>string</Links>
  <Longitude>1.1</Longitude>
  <Latitude>1.1</Latitude>
  <ZipCodeStr>string</ZipCodeStr>
</CustomerQueryDTO>

```

--------------------------------

### Get Contact by ID (XML Example)

Source: https://app.atera.com/apidocs

Example of an XML response when retrieving a specific contact. This model includes various optional fields for contact details.

```xml
<?xml version="1.0"?>
<ContactQueryDTO>
  <EndUserID>1</EndUserID>
  <CustomerID>1</CustomerID>
  <CustomerName>string</CustomerName>
  <Firstname>string</Firstname>
  <Lastname>string</Lastname>
  <JobTitle>string</JobTitle>
  <Email>string</Email>
  <Phone>string</Phone>
  <MobilePhone>string</MobilePhone>
  <IsContactPerson>true</IsContactPerson>
  <InIgnoreMode>true</InIgnoreMode>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <LastModified>1970-01-01T00:00:00.001Z</LastModified>
  <Archived>true</Archived>
  <DepartmentID>1</DepartmentID>
  <DepartmentName>string</DepartmentName>
</ContactQueryDTO>
```

--------------------------------

### Get Contact by ID (JSON Example)

Source: https://app.atera.com/apidocs

Example of a JSON response when retrieving a specific contact. This model includes various optional fields for contact details.

```json
{
  "EndUserID": 54,
  "CustomerID": 12,
  "CustomerName": "Default Customer",
  "Firstname": "John",
  "Lastname": "Smith",
  "JobTitle": "CTO",
  "Email": "support@customer.com",
  "Phone": "3-656-1213",
  "IsContactPerson": true,
  "InIgnoreMode": false,
  "CreatedOn": "2026-05-19T09:24:18.5126818Z",
  "LastModified": "2026-05-19T09:24:18.5126818Z",
  "Archived": false
}
```

--------------------------------

### Generic Device List Response Example

Source: https://app.atera.com/apidocs

Example JSON response for retrieving a list of generic devices. Includes pagination details and device information.

```json
{
  "items": [
    {
      "Name": "string",
      "DeviceID": 0,
      "DeviceGuid": "00000000-0000-0000-0000-000000000000",
      "FolderID": 0,
      "CustomerID": 0,
      "CustomerName": "string",
      "Monitored": true,
      "MonitoringAgentID": 0
    }
  ],
  "totalItemCount": 0,
  "page": 0,
  "itemsInPage": 0,
  "totalPages": 0,
  "prevLink": "string",
  "nextLink": "string"
}
```

--------------------------------

### Create Alert XML Example

Source: https://app.atera.com/apidocs

Example XML payload for creating a system alert. This format is an alternative to JSON.

```xml
<?xml version="1.0"?>
<CreateAlertDTO>
  <DeviceGuid>00000000-0000-0000-0000-000000000000</DeviceGuid>
  <Title>string</Title>
  <CustomerID>1</CustomerID>
  <Code>1</Code>
  <Severity>Information</Severity>
  <ThresholdValue1>string</ThresholdValue1>
  <ThresholdValue2>string</ThresholdValue2>
  <ThresholdValue3>string</ThresholdValue3>
  <ThresholdValue4>string</ThresholdValue4>
  <ThresholdValue5>string</ThresholdValue5>
  <SnoozedEndDate>1970-01-01T00:00:00.001Z</SnoozedEndDate>
  <AdditionalInfo>string</AdditionalInfo>
  <AlertCategoryID>Hardware</AlertCategoryID>
  <TicketID>1</TicketID>
  <MessageTemplate>string</MessageTemplate>
  <FolderID>1</FolderID>
</CreateAlertDTO>
```

--------------------------------

### AccountDTO XML Example

Source: https://app.atera.com/apidocs

Example XML response for an account. Properties are optional and may be null.

```xml
<?xml version="1.0"?>
<AccountDTO>
  <AccountID>string</AccountID>
  <Country>string</Country>
  <CompanyName>string</CompanyName>
  <CreatedOn>string</CreatedOn>
  <State>string</State>
  <TimeZoneName>string</TimeZoneName>
  <City>string</City>
  <Address>string</Address>
  <PostalCode>string</PostalCode>
  <Phone>string</Phone>
  <IsITDepartment>true</IsITDepartment>
  <Plan>string</Plan>
</AccountDTO>
```

--------------------------------

### Create Alert JSON Example

Source: https://app.atera.com/apidocs

Example JSON payload for creating a system alert. Ensure all required fields are populated.

```json
{
  "DeviceGuid": "00000000-0000-0000-0000-000000000000",
  "Title": "string",
  "CustomerID": 0,
  "Code": 0,
  "Severity": "Information",
  "ThresholdValue1": "string",
  "ThresholdValue2": "string",
  "ThresholdValue3": "string",
  "ThresholdValue4": "string",
  "ThresholdValue5": "string",
  "SnoozedEndDate": "2026-05-19T09:24:18.708Z",
  "AdditionalInfo": "string",
  "AlertCategoryID": "Hardware",
  "TicketID": 0,
  "MessageTemplate": "string",
  "FolderID": 0
}
```

--------------------------------

### Get Agent Installed Patches (JSON)

Source: https://app.atera.com/apidocs

Retrieves a list of installed patches for a specified agent. Requires the agent's Device GUID.

```json
{
  "DeviceGuid": "string",
  "Timestamp": "2026-05-19T09:24:18.701Z",
  "InstalledUpdates": [
    {
      "Name": "string",
      "Class": "string",
      "KBId": "string",
      "InstallDate": "2026-05-19T09:24:18.701Z"
    }
  ]
}
```

--------------------------------

### AccountDTO JSON Example

Source: https://app.atera.com/apidocs

Example JSON response for an account. Properties are optional and may be null.

```json
{
  "AccountID": "string",
  "Country": "string",
  "CompanyName": "string",
  "CreatedOn": "string",
  "State": "string",
  "TimeZoneName": "string",
  "City": "string",
  "Address": "string",
  "PostalCode": "string",
  "Phone": "string",
  "IsITDepartment": true,
  "Plan": "string"
}
```

--------------------------------

### Get Agent Installed Patches (XML)

Source: https://app.atera.com/apidocs

Retrieves a list of installed patches for a specified agent in XML format. Requires the agent's Device GUID.

```xml
<?xml version="1.0"?>
<AgentInstalledUpdates>
  <DeviceGuid>string</DeviceGuid>
  <Timestamp>1970-01-01T00:00:00.001Z</Timestamp>
  <InstalledUpdates>
    <Name>string</Name>
    <Class>string</Class>
    <KBId>string</KBId>
    <InstallDate>1970-01-01T00:00:00.001Z</InstallDate>
  </InstalledUpdates>
</AgentInstalledUpdates>
```

--------------------------------

### Get Department Response Body (XML)

Source: https://app.atera.com/apidocs

Example XML response for retrieving department details. Includes Id, Name, and optional Description.

```xml
<?xml version="1.0"?>
<DepartmentDTO>
  <Id>1</Id>
  <Name>string</Name>
  <Description>string</Description>
</DepartmentDTO>
```

--------------------------------

### Create Customer API Request Example (XML)

Source: https://app.atera.com/apidocs

This is an example of a request body to create a new customer using XML format. The CustomerName field is required.

```xml
<?xml version="1.0"?>
<CreateCustomerDTO>
  <CustomerName>string</CustomerName>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <BusinessNumber>string</BusinessNumber>
  <Domain>string</Domain>
  <Address>string</Address>
  <City>string</City>
  <State>string</State>
  <Country>string</Country>
  <Phone>string</Phone>
  <Fax>string</Fax>
  <Notes>string</Notes>
  <Links>string</Links>
  <Longitude>1.1</Longitude>
  <Latitude>1.1</Latitude>
  <ZipCodeStr>string</ZipCodeStr>
</CreateCustomerDTO>
```

--------------------------------

### Get Department Response Body (JSON)

Source: https://app.atera.com/apidocs

Example JSON response for retrieving department details. Includes Id, Name, and optional Description.

```json
{
  "CustomerID": 1,
  "CustomerName": "Example Customer",
  "CreatedOn": "2026-05-19T09:24:18.5439315Z",
  "LastModified": "2026-05-19T09:24:18.5439315Z",
  "BusinessNumber": "BN12345",
  "Domain": "exampledomain.com",
  "Address": "Main street 10",
  "City": "New York City",
  "State": "New York",
  "Country": "United States",
  "Phone": "3-659854875",
  "Fax": "3-659854876",
  "Notes": "Notes for new customer..",
  "Links": "http://www.examplecustomer.com",
  "Longitude": 45.0345345,
  "Latitude": 45.0345345,
  "ZipCodeStr": "5000CR"
}
```

--------------------------------

### Get Customer Custom Field Value (JSON Example)

Source: https://app.atera.com/apidocs

Example of a JSON response when retrieving a custom field value for a customer. This model includes various data types for custom fields.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.776Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Create Customer API Request Example (JSON)

Source: https://app.atera.com/apidocs

This is an example of a request body to create a new customer using JSON format. The CustomerName field is required.

```json
{
  "CustomerName": "string",
  "CreatedOn": "2026-05-19T09:24:18.756Z",
  "BusinessNumber": "string",
  "Domain": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Country": "string",
  "Phone": "string",
  "Fax": "string",
  "Notes": "string",
  "Links": "string",
  "Longitude": 0,
  "Latitude": 0,
  "ZipCodeStr": "string"
}
```

--------------------------------

### AgentQueryDTO JSON Example

Source: https://app.atera.com/apidocs

Example JSON payload representing an AgentQueryDTO. This can be used to represent device information.

```json
{
  "AgentID": 12,
  "DeviceGuid": "5369e175-05fa-4a6d-a06b-1683654eb7da",
  "FolderID": 1,
  "FolderName": "Default Folder",
  "CustomerID": 1,
  "CustomerName": "Default Customer",
  "AgentName": "WINDOWS10",
  "SystemName": "WINDOWS10",
  "MachineName": "WINDOWS10",
  "DomainName": "Workgroup",
  "CurrentLoggedUsers": "User",
  "ComputerDescription": "System",
  "Monitored": false,
  "Created": "2026-05-18T09:24:18.4970555Z",
  "Modified": "2026-05-19T07:24:18.4970555Z",
  "Online": true,
  "LastSeen": "2026-05-19T09:24:18.4970555Z",
  "AppViewUrl": "https://app.atera.com/Admin#/rmm/device/5369e175-05fa-4a6d-a06b-1683654eb7da/agent",
  "Motherboard": "ATI SB450",
  "Processor": "Intel(R) Celeron(R) M processor 1.60GHz",
  "Memory": 512,
  "SystemDrive": "C",
  "ProcessorClock": "1.59",
  "BiosManufacturer": "American Megatrends Inc.",
  "BiosVersion": "Ver: 09.02",
  "BiosReleaseDate": "2026-04-19T09:24:18.4970555Z",
  "MacAddresses": [
    "00:AA:11:BB:22:CC"
  ],
  "IpAddresses": [
    "10.0.0.1"
  ],
  "BatteryInfo": {
    "Id": 1,
    "Name": "DELL CF5RH0A",
    "BatteryHealth": 80,
    "DesignedCapacity": 40005,
    "FullChargeCapacity": 31961,
    "CycleCount": 0
  },
  "OS": "Microsoft Windows 10",
  "Office": "Microsoft Office 365 ProPlus",
  "LastRebootTime": "2026-05-19T08:54:18.4970555Z",
  "OSVersion": "1803",
  "OSBuild": "17134.165",
  "OfficeFullVersion": "16.0.8431.2270",
  "LastLoginUser": "User"
}
```

--------------------------------

### Get Agent Available Patches (XML)

Source: https://app.atera.com/apidocs

Retrieves a list of available patches for a specified agent in XML format. Requires the agent's Device GUID.

```xml
<?xml version="1.0"?>
<AgentAvailableUpdates>
  <DeviceGuid>string</DeviceGuid>
  <Timestamp>1970-01-01T00:00:00.001Z</Timestamp>
  <AvailableUpdates>
    <Name>string</Name>
    <Class>string</Class>
    <KBId>string</KBId>
    <Status>string</Status>
  </AvailableUpdates>
</AgentAvailableUpdates>
```

--------------------------------

### CustomValueQueryDTO JSON Example (Second Instance)

Source: https://app.atera.com/apidocs

Example JSON payload for CustomValueQueryDTO. Use this for requests or to understand the response structure.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.860Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### UpdateContractDto XML Example

Source: https://app.atera.com/apidocs

Provides an example of the XML structure for updating a contract, mirroring the JSON object's fields.

```xml
<?xml version="1.0"?>
<UpdateContractDto>
  <ContractName>string</ContractName>
  <Default>true</Default>
  <StartDate>1970-01-01T00:00:00.001Z</StartDate>
  <EndDate>1970-01-01T00:00:00.001Z</EndDate>
  <Active>true</Active>
  <Taxable>true</Taxable>
  <TaxId>1</TaxId>
  <Notes>string</Notes>
  <RetainerFlatFeeContract>
    <Quantity>1.1</Quantity>
    <BillingPeriod>EndOfContractDuration</BillingPeriod>
  </RetainerFlatFeeContract>
  <HourlyContract>
    <BillingPeriod>EndOfContractDuration</BillingPeriod>
  </HourlyContract>
```

--------------------------------

### AgentQueryDTO XML Example

Source: https://app.atera.com/apidocs

Example XML payload representing an AgentQueryDTO. This can be used for data exchange where XML is preferred.

```xml
<?xml version="1.0"?>
<AgentQueryDTO>
  <MachineID>string</MachineID>
  <AgentID>1</AgentID>
  <DeviceGuid>00000000-0000-0000-0000-000000000000</DeviceGuid>
  <FolderID>1</FolderID>
  <FolderName>string</FolderName>
  <CustomerID>1</CustomerID>
  <CustomerName>string</CustomerName>
  <AgentName>string</AgentName>
  <SystemName>string</SystemName>
  <MachineName>string</MachineName>
  <DomainName>string</DomainName>
  <CurrentLoggedUsers>string</CurrentLoggedUsers>
  <ComputerDescription>string</ComputerDescription>
  <Monitored>true</Monitored>
  <AgentVersion>string</AgentVersion>
  <Favorite>true</Favorite>
  <ThresholdID>1</ThresholdID>
  <MonitoredAgentID>1</MonitoredAgentID>
  <Created>1970-01-01T00:00:00.001Z</Created>
  <Modified>1970-01-01T00:00:00.001Z</Modified>
  <Online>true</Online>
  <LastSeen>1970-01-01T00:00:00.001Z</LastSeen>
  <ReportedFromIP>string</ReportedFromIP>
  <AppViewUrl>string</AppViewUrl>
  <Motherboard>string</Motherboard>
  <Processor>string</Processor>
  <Memory>1</Memory>
  <Display>string</Display>
  <Sound>string</Sound>
  <ProcessorCoresCount>1</ProcessorCoresCount>
  <SystemDrive>string</SystemDrive>
  <ProcessorClock>string</ProcessorClock>
  <Vendor>string</Vendor>
  <VendorSerialNumber>string</VendorSerialNumber>
  <VendorBrandModel>string</VendorBrandModel>
  <ProductName>string</ProductName>
</AgentQueryDTO>
```

--------------------------------

### Ticket Comment Query DTO Example (JSON)

Source: https://app.atera.com/apidocs

Example JSON structure for a ticket comment query response, including items, pagination details, and links.

```json
{
  "items": [
    {
      "Date": "2026-05-19T09:24:18.939Z",
      "Comment": "string",
      "EndUserID": 0,
      "TechnicianContactID": 0,
      "Email": "string",
      "FirstName": "string",
      "LastName": "string",
      "IsInternal": true
    }
  ],
  "totalItemCount": 0,
  "page": 0,
  "itemsInPage": 0,
  "totalPages": 0,
  "prevLink": "string",
  "nextLink": "string"
}
```

--------------------------------

### CustomValueQueryDTO Model and Example (JSON)

Source: https://app.atera.com/apidocs

Defines the structure for querying custom field values and provides an example of the expected JSON payload for a successful response.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.814Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### SetCustomValueDTO JSON Example

Source: https://app.atera.com/apidocs

Example of a JSON object for setting a custom value. It contains a 'Value' field to specify the new value for the custom field.

```json
{
  "Value": "string"
}
```

--------------------------------

### Get Installed Patches for Agent

Source: https://app.atera.com/apidocs

Retrieves a list of installed patches for a specified agent using its device GUID.

```APIDOC
## GET /api/v3/agents/{deviceGuid}/installed-patches

### Description
Get installed patches for specified agent.

Returns the installed patches on the agent. Requires the Device guid.

### Method
GET

### Endpoint
/api/v3/agents/{deviceGuid}/installed-patches

### Parameters
#### Path Parameters
- **deviceGuid** (string) - Required - Device guid

### Response
#### Success Response (200)
OK
- **DeviceGuid** (string, optional)
- **Timestamp** (string, optional)
- **InstalledUpdates** (Array[AgentInstalledUpdate], optional)
  - **Name** (string, optional)
  - **Class** (string, optional)
  - **KBId** (string, optional)
  - **InstallDate** (string, optional)

### Response Example
```json
{
  "DeviceGuid": "string",
  "Timestamp": "2026-05-19T09:24:18.701Z",
  "InstalledUpdates": [
    {
      "Name": "string",
      "Class": "string",
      "KBId": "string",
      "InstallDate": "2026-05-19T09:24:18.701Z"
    }
  ]
}
```
```

--------------------------------

### Create TCP Device XML Example

Source: https://app.atera.com/apidocs

Use this XML payload to create a new TCP device. Ensure all required fields are populated.

```xml
<?xml version="1.0"?>
<CreateTCPDTO>
  <Hostname>string</Hostname>
  <Ports>
    <PortNum>1</PortNum>
    <Monitored>true</Monitored>
  </Ports>
  <Name>string</Name>
  <CustomerID>1</CustomerID>
  <FolderID>1</FolderID>
  <MonitoringAgentID>1</MonitoringAgentID>
  <Monitored>true</Monitored>
</CreateTCPDTO>
```

--------------------------------

### Create Product

Source: https://app.atera.com/apidocs

Creates a new product with the provided details. Requires a product description.

```APIDOC
## POST /api/v3/rates/products

### Description
Creates a new product.

### Method
POST

### Endpoint
/api/v3/rates/products

### Parameters
#### Request Body
- **product** (CreateProductExpenseRateDTO) - Required - System Product object

### Request Example
```json
{
  "Category": "string",
  "Description": "string",
  "Amount": 0,
  "SKU": "string"
}
```

### Response
#### Success Response (201)
Created
```

--------------------------------

### Get Contact Custom Field Value (JSON Example)

Source: https://app.atera.com/apidocs

Example of a JSON response when retrieving a custom field value for a contact. This model includes various data types for custom fields.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.784Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Create TCP Device JSON Example

Source: https://app.atera.com/apidocs

Use this JSON payload to create a new TCP device. Ensure all required fields are populated.

```json
{
  "Hostname": "string",
  "Ports": [
    {
      "PortNum": 0,
      "Monitored": true
    }
  ],
  "Name": "string",
  "CustomerID": 0,
  "FolderID": 0,
  "MonitoringAgentID": 0,
  "Monitored": true
}
```

--------------------------------

### Get Agents for Machine

Source: https://app.atera.com/apidocs

Retrieves a list of agents installed on a specified machine. Requires the machine name.

```APIDOC
## GET /api/v3/agents/machine/{machineName}

### Description
Get agents for specified machine.

### Method
GET

### Endpoint
/api/v3/agents/machine/{machineName}

### Parameters
#### Path Parameters
- **machineName** (string) - Required - The name of the machine to retrieve agents for.

### Response
#### Success Response (200)
- **agents** (array) - List of agents installed on the machine.
- **agentId** (long) - System agent ID.

### Implementation Notes
Returns agents installed on a specified machine. Requires the machine name.
Please note that the property 'LastPatchManagementReceived' is no longer supported and will return a null reference.
```

--------------------------------

### Get HTTP Custom Field Value (JSON Example)

Source: https://app.atera.com/apidocs

Example of a JSON response when retrieving a custom field value for an HTTP device. This model includes various data types for custom field values.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.829Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Get Available Patches for Agent

Source: https://app.atera.com/apidocs

Retrieves a list of available patches for a specified agent using its device GUID.

```APIDOC
## GET /api/v3/agents/{deviceGuid}/available-patches

### Description
Get available patches for specified agent.

Returns the available patches on the agent. Requires the Device guid.

### Method
GET

### Endpoint
/api/v3/agents/{deviceGuid}/available-patches

### Parameters
#### Path Parameters
- **deviceGuid** (string) - Required - Device guid

### Response
#### Success Response (200)
OK
- **DeviceGuid** (string, optional)
- **Timestamp** (string, optional)
- **AvailableUpdates** (Array[AgentAvailableUpdate], optional)
  - **Name** (string, optional)
  - **Class** (string, optional)
  - **KBId** (string, optional)
  - **Status** (string, optional)

### Response Example
```json
{
  "DeviceGuid": "string",
  "Timestamp": "2026-05-19T09:24:18.702Z",
  "AvailableUpdates": [
    {
      "Name": "string",
      "Class": "string",
      "KBId": "string",
      "Status": "string"
    }
  ]
}
```
```

--------------------------------

### Get Expense API XML Response

Source: https://app.atera.com/apidocs

Example of a successful XML response (Status 200) when retrieving a specific expense.

```xml
<?xml version="1.0"?>
<RateQueryDTO>
  <RateID>1</RateID>
  <Amount>1.1</Amount>
  <Description>string</Description>
  <SKU>string</SKU>
  <Category>string</Category>
</RateQueryDTO>

```

--------------------------------

### Sample Success Response (200 OK)

Source: https://app.atera.com/apidocs

This JSON object represents a successful response when querying for contract details, specifically for a RetainerFlatFee contract.

```APIDOC
## Success Response Example (200 OK)

### Description
This JSON object details a contract, specifically a RetainerFlatFee contract, with its end date and retainer fee details.

### Response Body
```json
{
  "EndDate": "2029-05-19T09:24:18.5283056Z",
  "RetainerFlatFeeContract": {
    "Quantity": 1,
    "Rate": {
      "RateID": 1,
      "Amount": 100,
      "Description": "Default Rate"
    },
    "BillingPeriod": 4
  }
}
```
```

--------------------------------

### Get Expense API JSON Response

Source: https://app.atera.com/apidocs

Example of a successful JSON response (Status 200) when retrieving a specific expense.

```json
{
  "RateID": 2,
  "Amount": 50,
  "Description": "Fare Fee",
  "Category": "Transportation"
}
```

--------------------------------

### Find Products

Source: https://app.atera.com/apidocs

Retrieves a list of products.

```APIDOC
## GET /api/v3/rates/products

### Description
Finds and returns a list of products.

### Method
GET

### Endpoint
/api/v3/rates/products

### Response
#### Success Response
OK

#### Error Response
(No specific error responses documented in source)
```

--------------------------------

### Create SNMP Device V1/V2 XML Example

Source: https://app.atera.com/apidocs

Use this XML payload to create a new SNMP device using V1 or V2 protocol. Specify SNMP version and other relevant parameters.

```xml
<?xml version="1.0"?>
<CreateSNMPDTOV1V2>
  <Community>string</Community>
  <SNMPVersion>V1</SNMPVersion>
  <Hostname>string</Hostname>
  <Port>1</Port>
  <SNMPType>string</SNMPType>
  <Name>string</Name>
  <CustomerID>1</CustomerID>
  <FolderID>1</FolderID>
  <MonitoringAgentID>1</MonitoringAgentID>
  <Monitored>true</Monitored>
</CreateSNMPDTOV1V2>
```

--------------------------------

### Get Agent Available Patches (JSON)

Source: https://app.atera.com/apidocs

Retrieves a list of available patches for a specified agent. Requires the agent's Device GUID.

```json
{
  "DeviceGuid": "string",
  "Timestamp": "2026-05-19T09:24:18.702Z",
  "AvailableUpdates": [
    {
      "Name": "string",
      "Class": "string",
      "KBId": "string",
      "Status": "string"
    }
  ]
}
```

--------------------------------

### Create Customer

Source: https://app.atera.com/apidocs

Creates a new customer. Requires the customer name.

```APIDOC
## POST /api/v3/customers

### Description
Create Customer

Creates a new customer. Requires the customer name.

### Method
POST

### Endpoint
/api/v3/customers

### Parameters
#### Request Body
- **customer** (object) - Required - 

### Request Example
```json
{
  "CustomerName": "string",
  "CreatedOn": "2026-05-19T09:24:18.756Z",
  "BusinessNumber": "string",
  "Domain": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "Country": "string",
  "Phone": "string",
  "Fax": "string",
  "Notes": "string",
  "Links": "string",
  "Longitude": 0,
  "Latitude": 0,
  "ZipCodeStr": "string"
}
```

```xml
<?xml version="1.0"?>
<CreateCustomerDTO>
  <CustomerName>string</CustomerName>
  <CreatedOn>1970-01-01T00:00:00.001Z</CreatedOn>
  <BusinessNumber>string</BusinessNumber>
  <Domain>string</Domain>
  <Address>string</Address>
  <City>string</City>
  <State>string</State>
  <Country>string</Country>
  <Phone>string</Phone>
  <Fax>string</Fax>
  <Notes>string</Notes>
  <Links>string</Links>
  <Longitude>1.1</Longitude>
  <Latitude>1.1</Latitude>
  <ZipCodeStr>string</ZipCodeStr>
</CreateCustomerDTO>
```

### Response
#### Success Response (201)
Created
```

--------------------------------

### Create Customer Folder

Source: https://app.atera.com/apidocs

Creates a new folder for a customer. Requires the folder name and customer ID. A threshold profile ID is optional.

```APIDOC
## POST /api/v3/customers/folders

### Description
Creates a customer folder.

### Method
POST

### Endpoint
/api/v3/customers/folders

### Implementation Notes
Requires the folder name and customer ID. Threshold profile ID is optional; if not included, the folder will inherit the threshold profile applied to the customer, if applicable.
```

--------------------------------

### Get Custom Field Values for Agent (JSON)

Source: https://app.atera.com/apidocs

Retrieves all custom field values for a specified agent. Requires the agent ID. This example shows the JSON response format.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.854Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Create SNMP Device V1/V2 JSON Example

Source: https://app.atera.com/apidocs

Use this JSON payload to create a new SNMP device using V1 or V2 protocol. Specify SNMP version and other relevant parameters.

```json
{
  "Community": "string",
  "SNMPVersion": "V1",
  "Hostname": "string",
  "Port": 0,
  "SNMPType": "string",
  "Name": "string",
  "CustomerID": 0,
  "FolderID": 0,
  "MonitoringAgentID": 0,
  "Monitored": true
}
```

--------------------------------

### Get Custom Field Values for SLA (JSON)

Source: https://app.atera.com/apidocs

Retrieves all custom field values for a specified SLA. Requires the SLA ID. This example shows the JSON response format.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.852Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### API Response Example (Status 200)

Source: https://app.atera.com/apidocs

An example of a successful API response (Status 200) containing a list of contracts. It illustrates the nested structure for different contract types like RetainerFlatFee, HourlyContract, BlockHoursContract, etc., and includes detailed rate information.

```json
{
  "items": [
    {
      "CustomerID": 0,
      "CustomerName": "string",
      "ContractID": 0,
      "ContractName": "string",
      "ContractType": "RetainerFlatFee",
      "Active": true,
      "Default": true,
      "Taxable": true,
      "StartDate": "2026-05-19T09:24:18.735Z",
      "EndDate": "2026-05-19T09:24:18.735Z",
      "RetainerFlatFeeContract": {
        "Quantity": 0,
        "Rate": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "BillingPeriod": "EndOfContractDuration"
      },
      "HourlyContract": {
        "PrimaryRate": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "AdditionalRates": [
          {
            "RateID": 0,
            "Amount": 0,
            "Description": "string",
            "SKU": "string",
            "Category": "string"
          }
        ],
        "BillingPeriod": "EndOfContractDuration"
      },
      "BlockHoursContract": {
        "HoursIncluded": 0,
        "PricePerHour": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "OverageRate": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "CommitRollover": true,
        "BillingPeriod": "EndOfContractDuration"
      },
      "BlockMoneyContract": {
        "ContractAmount": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "PrimaryRate": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "AdditionalRates": [
          {
            "RateID": 0,
            "Amount": 0,
            "Description": "string",
            "SKU": "string",
            "Category": "string"
          }
        ],
        "CommitRollover": true,
        "BillingPeriod": "EndOfContractDuration"
      },
      "RemoteMonitoringContract": {
        "RatePerDevice": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "CountBy": "PCAgents",
        "BillingPeriod": "EndOfContractDuration",
        "ExcludeRetiredDevices": true
      },
      "OnlineBackupContract": {
        "RatePerGB": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "CountBy": "PCAgents",
        "BillingPeriod": "EndOfContractDuration"
      },
      "ProjectOneTimeFeeContract": {
        "TotalAmount": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        }
      },
      "ProjectHourlyRateContract": {
        "PrimaryRate": {
          "RateID": 0,
          "Amount": 0,
          "Description": "string",
          "SKU": "string",
          "Category": "string"
        },
        "AdditionalRates": [
          {
            "RateID": 0,
            "Amount": 0,
            "Description": "string",
            "SKU": "string",
            "Category": "string"
          }
        ]
      }
    }
  ],
  "totalItemCount": 0,
  "page": 0,
  "itemsInPage": 0,
  "totalPages": 0,
  "prevLink": "string",
  "nextLink": "string"
}
```

--------------------------------

### Get Custom Field Values for Contract (JSON)

Source: https://app.atera.com/apidocs

Retrieves all custom field values for a specified contract. Requires the contract ID. This example shows the JSON response format.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.851Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Create Ticket Comment DTO Example (JSON)

Source: https://app.atera.com/apidocs

Example JSON payload for creating a new ticket comment, including comment text, timestamp, and details for technician or end-user.

```json
{
  "CommentText": "string",
  "CommentTimestampUTC": "2026-05-19T09:24:18.941Z",
  "TechnicianCommentDetails": {
    "TechnicianId": 0,
    "IsInternal": true,
    "TechnicianEmail": "string"
  },
  "EnduserCommentDetails": {
    "EnduserId": 0
  }
}
```

--------------------------------

### Get Ticket Workhours List (JSON Response)

Source: https://app.atera.com/apidocs

Example JSON response for retrieving a list of ticket work hours. Includes pagination details and an array of work hour entries.

```json
{
  "items": [
    {
      "TicketID": 0,
      "WorkHoursID": 0,
      "StartWorkHour": "2026-05-19T09:24:18.937Z",
      "EndWorkHour": "2026-05-19T09:24:18.937Z",
      "TechnicianContactID": 0,
      "Billiable": true,
      "OnCustomerSite": true,
      "Description": "string",
      "TechnicianFullName": "string",
      "TechnicianEmail": "string",
      "RateID": 0,
      "RateAmount": 0
    }
  ],
  "totalItemCount": 0,
  "page": 0,
  "itemsInPage": 0,
  "totalPages": 0,
  "prevLink": "string",
  "nextLink": "string"
}
```

--------------------------------

### Get Custom Field Value (JSON Example)

Source: https://app.atera.com/apidocs

Retrieves a custom field value for a specified TCP device in JSON format. Requires TCP ID and custom field name.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.822Z",
    "ValueAsBool": true
  }
]
```

--------------------------------

### Custom Value Query DTO Example (JSON)

Source: https://app.atera.com/apidocs

Example JSON response for a custom field value. Includes optional fields like ItemId, Id, FieldName, ValueAsString, ValueAsDecimal, ValueAsDateTime, and ValueAsBool.

```json
[
  {
    "ItemId": 0,
    "Id": "00000000-0000-0000-0000-000000000000",
    "FieldName": "string",
    "ValueAsString": "string",
    "ValueAsDecimal": 0,
    "ValueAsDateTime": "2026-05-19T09:24:18.768Z",
    "ValueAsBool": true
  }
]
```