Autotask Tools
at_ · 452 tools · Free 298 · Pro 154
Static API headers (ApiIntegrationCode/UserName/Secret); zone auto-discovery; cursor pagination via nextPageUrl; max page size 500.
Service Tickets
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_tickets |
Free | Read-only | [Autotask] Count tickets matching optional filters. Returns the total number of matching tickets without fetching ticket data. Useful for dashboards, reporting, and checking result set size before paginating with at_list_tickets. |
at_create_ticket |
Pro | Write | [Autotask] Create a new service ticket. Requires at minimum a title and company ID. Returns the created ticket with its assigned ID. This creates data visible to helpdesk staff and end users. Use at_list_companies to find valid company IDs. |
at_get_ticket |
Free | Read-only | [Autotask] Retrieve a single ticket by its numeric ID. Returns full ticket details including title, status, priority, queue, company, assigned resource, due date, and custom fields. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_list_company_tickets |
Free | Read-only | [Autotask] List tickets for a specific company. Useful for reviewing a client's current issues or full ticket history. Requires a valid company ID -- use at_list_companies to find IDs. |
at_list_high_priority_tickets |
Free | Read-only | [Autotask] List open tickets with Critical (priority 1) or High (priority 2) priority. Useful for urgent triage. Note: priority IDs may vary by Autotask instance -- this uses 1 (Critical) and 2 (High) as common defaults. |
at_list_open_tickets |
Free | Read-only | [Autotask] List open tickets (status is not Complete). Convenience tool that filters out completed tickets. Note: Autotask status IDs vary by instance -- this uses status != 5 (Complete) as a common default. If your instance uses different status IDs, use at_list_tickets with a custom filter instead. |
at_list_past_due_tickets |
Free | Read-only | [Autotask] List open tickets that are past their due date. Useful for identifying overdue work items that need immediate attention. |
at_list_recently_updated_tickets |
Free | Read-only | [Autotask] List tickets updated within the last 24 hours. Useful for monitoring recent helpdesk activity without filtering by status or priority. |
at_list_resource_tickets |
Free | Read-only | [Autotask] List tickets assigned to a specific resource. Use this to view a technician's current workload. Requires a valid resource ID -- use at_list_resources to find IDs. |
at_list_tickets |
Free | Read-only | [Autotask] Query tickets with optional filters. Returns paginated ticket summaries including ID, title, status, priority, queue, company, and assigned resource. Use this to browse tickets or narrow results before fetching full details with at_get_ticket. Pass typed filter parameters or a raw filterJson string for advanced queries. |
at_list_unassigned_tickets |
Free | Read-only | [Autotask] List open tickets with no assigned resource. Useful for triage queues -- shows tickets waiting to be dispatched. |
at_search_tickets |
Free | Read-only | [Autotask] Search tickets by title keyword. Returns tickets whose title contains the search term. Use this when looking for tickets by keyword or description rather than structured filtering with at_list_tickets. |
at_update_ticket |
Pro | Write | [Autotask] Update an existing ticket via PATCH. Provide the ticket ID and a JSON object of fields to update. The id field is automatically included. Returns the updated ticket. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_count_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID. |
endDate |
string | no | null | Filter by end date in yyyy-MM-dd format. |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. When provided, typed filter params are ignored. |
queueId |
integer | no | null | Filter by queue ID. |
resourceId |
integer | no | null | Filter by assigned resource ID. |
startDate |
string | no | null | Filter by start date in yyyy-MM-dd format. |
statusId |
integer | no | null | Filter by status ID. |
at_create_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
assignedResourceId |
integer | no | null | Resource ID to assign the ticket to (optional). Use at_list_resources to find valid IDs. |
companyId |
integer | yes | Company ID the ticket belongs to. Use at_list_companies to find valid IDs. | |
fieldsJson |
string | no | null | Additional fields as JSON object (optional). Merged with the above parameters. Example: {"description":"Details here","dueDateTime":"2026-04-01"} |
priorityId |
integer | no | null | Priority ID (optional). Use Autotask field info to find valid priority IDs. |
queueId |
integer | no | null | Queue ID (optional). Routes the ticket to a specific queue. |
statusId |
integer | no | null | Status ID (optional). Use Autotask field info to find valid status IDs. |
title |
string | yes | Ticket title/subject line. Keep concise and descriptive. |
at_get_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The numeric Autotask ticket ID. Use at_list_tickets or at_search_tickets to find valid IDs. |
at_list_company_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The numeric Autotask company ID. Use at_list_companies to find valid IDs. | |
includeClosed |
boolean | no | false | Include closed/completed tickets (default false, shows only open). |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_high_priority_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_open_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_past_due_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_recently_updated_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
resourceId |
integer | yes | The numeric Autotask resource ID. Use at_list_resources to find valid IDs. |
at_list_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID. Use at_list_companies to find valid IDs. |
endDate |
string | no | null | Filter by end date in yyyy-MM-dd format. Returns tickets created on or before this date. |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. When provided, typed filter params are ignored. Example: [{"op":"eq","field":"status","value":1}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
queueId |
integer | no | null | Filter by queue ID. |
resourceId |
integer | no | null | Filter by assigned resource ID. Use at_list_resources to find valid IDs. |
startDate |
string | no | null | Filter by start date in yyyy-MM-dd format. Returns tickets created on or after this date. |
statusId |
integer | no | null | Filter by status ID. Use at_list_ticket_statuses or Autotask field info to find valid status IDs. |
at_list_unassigned_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search term to match against ticket titles. Case-insensitive contains match. |
at_update_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"status":2,"priority":3,"queueID":5}. Field names must match Autotask API field names. | |
ticketId |
integer | yes | The numeric Autotask ticket ID to update. |
Ticket Notes and Checklists
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_ticket_checklist_item |
Pro | Write | [Autotask] Add a checklist item to an existing ticket. Checklist items represent discrete tasks or steps within a ticket. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_create_ticket_note |
Pro | Write | [Autotask] Add a note to an existing ticket. Notes can be internal or published to the customer portal. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_get_ticket_note |
Free | Read-only | [Autotask] Retrieve a single ticket note by its numeric ID. Returns the full note including title, description, note type, publish settings, and timestamps. Requires a valid note ID -- use at_list_ticket_notes to find IDs. |
at_list_ticket_checklist_items |
Free | Read-only | [Autotask] List checklist items for a specific ticket. Returns checklist items including ID, item name, completion status, and sort order. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_list_ticket_notes |
Free | Read-only | [Autotask] List notes for a specific ticket. Returns paginated note summaries including ID, title, description, note type, and timestamps. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_update_ticket_checklist_item |
Pro | Write | [Autotask] Update an existing ticket checklist item via PATCH. Commonly used to mark items as complete. Provide the checklist item ID and a JSON object of fields to update. The id field is automatically included. Requires a valid checklist item ID -- use at_list_ticket_checklist_items to find IDs. |
at_update_ticket_note |
Pro | Write | [Autotask] Update an existing ticket note via PATCH. Provide the note ID and a JSON object of fields to update. The id field is automatically included. Requires a valid note ID -- use at_list_ticket_notes to find IDs. |
at_create_ticket_checklist_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
isComplete |
boolean | no | false | Whether the item is already complete (default false). |
itemName |
string | yes | Name/description of the checklist item. | |
ticketId |
integer | yes | The numeric Autotask ticket ID to add the checklist item to. |
at_create_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
description |
string | yes | Note description/body text. | |
noteType |
string | no | "Internal" | Note type. Common values: 'Internal' (default), 'External', 'Resolution'. Controls visibility and categorization. |
publish |
string | no | null | Publish setting (optional). Controls visibility on customer portal. Common values: 'All', 'Internal Only'. |
ticketId |
integer | yes | The numeric Autotask ticket ID to add the note to. | |
title |
string | yes | Note title/subject line. |
at_get_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
noteId |
integer | yes | The numeric Autotask ticket note ID. Use at_list_ticket_notes to find valid IDs. |
at_list_ticket_checklist_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | yes | The numeric Autotask ticket ID to list checklist items for. |
at_list_ticket_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | yes | The numeric Autotask ticket ID to list notes for. |
at_update_ticket_checklist_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
checklistItemId |
integer | yes | The numeric Autotask checklist item ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"isComplete":true} to mark complete, or {"itemName":"Updated name"}. Field names must match Autotask API field names. |
at_update_ticket_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"title":"Updated title","description":"Updated body","noteType":"External"}. Field names must match Autotask API field names. | |
noteId |
integer | yes | The numeric Autotask ticket note ID to update. |
Ticket Charges
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_ticket_charge |
Pro | Write | [Autotask] Add a charge to an existing ticket. Charges represent billable or non-billable costs associated with the ticket. Provide a JSON object with charge fields. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_get_ticket_charge |
Free | Read-only | [Autotask] Retrieve a single ticket charge by its numeric ID. Returns full charge details including charge type, billing code, units, rate, amount, and timestamps. Requires a valid charge ID -- use at_list_ticket_charges to find IDs. |
at_list_ticket_additional_contacts |
Free | Read-only | [Autotask] List additional contacts associated with a ticket. Returns contact IDs and resource associations beyond the primary contact. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_list_ticket_charges |
Free | Read-only | [Autotask] List charges on a specific ticket. Returns charge summaries including ID, charge type, billing code, amount, and timestamps. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_update_ticket_charge |
Pro | Write | [Autotask] Update an existing ticket charge via PATCH. Provide the charge ID and a JSON object of fields to update. The id field is automatically included. Requires a valid charge ID -- use at_list_ticket_charges to find IDs. |
at_create_ticket_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | Charge fields as JSON object. Must include ticketID. Example: {"ticketID":12345,"chargeType":1,"name":"Labor","unitQuantity":2.0,"unitCost":75.00,"billingCodeID":100}. Field names must match Autotask API field names. | |
ticketId |
integer | yes | The numeric Autotask ticket ID to add the charge to. |
at_get_ticket_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
chargeId |
integer | yes | The numeric Autotask ticket charge ID. Use at_list_ticket_charges to find valid IDs. |
at_list_ticket_additional_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | yes | The numeric Autotask ticket ID to list additional contacts for. |
at_list_ticket_charges parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | yes | The numeric Autotask ticket ID to list charges for. |
at_update_ticket_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
chargeId |
integer | yes | The numeric Autotask ticket charge ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"unitQuantity":3.0,"unitCost":80.00}. Field names must match Autotask API field names. |
Service Calls
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_service_calls |
Free | Read-only | [Autotask] Count service calls matching optional filters. Returns the total number of matching service calls without fetching data. |
at_create_service_call |
Pro | Write | [Autotask] Create a new service call for dispatch/scheduling. Returns the created service call with its assigned ID. |
at_create_service_call_task |
Pro | Write | [Autotask] Create a new task for a service call. Returns the created task with its assigned ID. |
at_create_service_call_ticket |
Pro | Write | [Autotask] Link an existing ticket to a service call. Returns the created association record. |
at_delete_service_call |
Pro | Write | [Autotask] Delete a service call by its numeric ID. This permanently removes the service call. |
at_get_service_call |
Free | Read-only | [Autotask] Retrieve a single service call by its numeric ID. Returns full service call details including status, scheduled times, and assignments. |
at_list_service_call_task_resources |
Free | Read-only | [Autotask] Query resources assigned to service call tasks. Returns resource assignment details. Use filterJson to narrow by service call task ID. |
at_list_service_call_tasks |
Free | Read-only | [Autotask] Query tasks associated with service calls. Returns task details including assignments and status. Use filterJson to narrow by service call ID. |
at_list_service_call_tickets |
Free | Read-only | [Autotask] Query tickets linked to service calls. Returns ticket associations. Use filterJson to narrow by service call ID. |
at_list_service_calls |
Free | Read-only | [Autotask] Query service calls with optional filters. Returns paginated service call summaries used for dispatch and scheduling. Use filterJson for advanced queries. |
at_update_service_call |
Pro | Write | [Autotask] Update an existing service call. The id field is automatically included. Returns the updated service call. |
at_count_service_calls parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Omit for no filtering. |
at_create_service_call parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the service call to create. Include required fields like companyID and description. |
at_create_service_call_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the service call task to create. Include serviceCallID and other required fields. |
at_create_service_call_ticket parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the service call ticket association. Include serviceCallID and ticketID. |
at_delete_service_call parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
serviceCallId |
integer | yes | The numeric Autotask service call ID to delete. |
at_get_service_call parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
serviceCallId |
integer | yes | The numeric Autotask service call ID. |
at_list_service_call_task_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"serviceCallTaskID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_service_call_tasks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
serviceCallId |
integer | no | null | Filter by service call ID. |
at_list_service_call_tickets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
serviceCallId |
integer | no | null | Filter by service call ID. |
at_list_service_calls parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"status","value":1}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_service_call parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"status":2,"description":"Updated"}. | |
serviceCallId |
integer | yes | The numeric Autotask service call ID to update. |
Ticket Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_ticket_additional_ci |
Pro | Write | [Autotask] Link an additional configuration item to a ticket. Returns the created association record. Include ticketID and configurationItemID. |
at_create_ticket_change_request_approval |
Pro | Write | [Autotask] Create a change request approval for a ticket. Returns the created approval record. |
at_create_ticket_rma_credit |
Pro | Write | [Autotask] Create an RMA credit for a ticket. Returns the created RMA credit record. |
at_create_ticket_secondary_resource |
Pro | Write | [Autotask] Assign a secondary resource to a ticket. Returns the created assignment record. Include ticketID and resourceID in the JSON. |
at_create_ticket_tag_association |
Pro | Write | [Autotask] Associate a tag with a ticket. Returns the created tag association record. Include ticketID and tagID. |
at_delete_ticket_additional_ci |
Pro | Write | [Autotask] Remove an additional configuration item link from a ticket by its association ID. |
at_delete_ticket_secondary_resource |
Pro | Write | [Autotask] Remove a secondary resource assignment from a ticket by its assignment ID. |
at_delete_ticket_tag_association |
Pro | Write | [Autotask] Remove a tag association from a ticket by its association ID. |
at_get_ticket_note_attachment |
Free | Read-only | [Autotask] Retrieve a single ticket note attachment by its numeric ID. Returns attachment metadata including filename and content type. |
at_list_ticket_additional_cis |
Free | Read-only | [Autotask] Query additional configuration items linked to tickets. Filter by ticketID to see CIs for a specific ticket. |
at_list_ticket_change_request_approvals |
Free | Read-only | [Autotask] Query change request approvals for tickets. Filter by ticketID to see approvals for a specific ticket. |
at_list_ticket_history |
Free | Read-only | [Autotask] Query the audit history for tickets. Returns a log of changes including who made changes and when. Filter by ticketID to see history for a specific ticket. |
at_list_ticket_note_attachments |
Free | Read-only | [Autotask] Query attachments on ticket notes. Filter by noteID or ticketID to narrow results. |
at_list_ticket_rma_credits |
Free | Read-only | [Autotask] Query RMA credits associated with tickets. Filter by ticketID to see credits for a specific ticket. |
at_list_ticket_secondary_resources |
Free | Read-only | [Autotask] Query secondary resources assigned to tickets. Returns resource assignment records. Filter by ticketID to see secondary resources for a specific ticket. |
at_list_ticket_tag_associations |
Free | Read-only | [Autotask] Query tag associations for tickets. Filter by ticketID to see tags on a specific ticket. |
at_create_ticket_additional_ci parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the additional CI link. Include ticketID and configurationItemID. |
at_create_ticket_change_request_approval parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the change request approval. Include ticketID and approval details. |
at_create_ticket_rma_credit parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the RMA credit. Include ticketID and credit details. |
at_create_ticket_secondary_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the secondary resource assignment. Include ticketID and resourceID. |
at_create_ticket_tag_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the tag association. Include ticketID and tagID. |
at_delete_ticket_additional_ci parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask ticket additional CI association ID to delete. |
at_delete_ticket_secondary_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask ticket secondary resource assignment ID to delete. |
at_delete_ticket_tag_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask ticket tag association ID to delete. |
at_get_ticket_note_attachment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
attachmentId |
integer | yes | The numeric Autotask ticket note attachment ID. |
at_list_ticket_additional_cis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
at_list_ticket_change_request_approvals parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
at_list_ticket_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
at_list_ticket_note_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ticket_rma_credits parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
at_list_ticket_secondary_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
at_list_ticket_tag_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | no | null | Filter by ticket ID. |
Companies
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_companies |
Free | Read-only | [Autotask] Get total count of companies matching optional filters. Returns a count object. Useful for pagination planning or dashboards. |
at_create_company |
Pro | Write | [Autotask] Create a new company record. Returns the created company with its assigned ID. The JSON must include at minimum companyName and companyType. Use at_list_companies to verify creation. |
at_get_company |
Free | Read-only | [Autotask] Retrieve full details for a single company by ID. Returns company info including name, type, status, address, and custom fields. Requires a valid company ID -- use at_list_companies or at_search_companies to find IDs. |
at_list_active_companies |
Free | Read-only | [Autotask] List companies that are currently active. Filters on isActive=true. Useful for client roster views and service reporting. |
at_list_companies |
Free | Read-only | [Autotask] Query companies with optional filters and pagination. Returns company summaries including ID, name, type, and status. Use this to discover company IDs for filtering contacts, tickets, configurations, and other company-scoped data. |
at_list_company_todos |
Free | Read-only | [Autotask] List to-do items associated with a specific company. Returns to-do details including title, status, and due date. Requires a valid company ID. |
at_list_customer_companies |
Free | Read-only | [Autotask] List companies of type Customer (companyType=1). Useful for client roster views, billing reviews, and service reporting. |
at_list_prospect_companies |
Free | Read-only | [Autotask] List companies of type Prospect (companyType=3). Useful for sales pipeline reviews -- shows companies that are potential customers but not yet active clients. |
at_search_companies |
Free | Read-only | [Autotask] Search companies by name. Returns matching companies where the company name contains the search text. Use this when you know the company name but not the ID. |
at_update_company |
Pro | Write | [Autotask] Update an existing company's fields. Returns the updated company. The JSON must include the company id field. Use at_get_company to check current values before updating. |
at_count_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
at_create_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the company to create. Must include companyName and companyType. Example: {"companyName":"Acme Corp","companyType":1,"phone":"555-0100"}. |
at_get_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. |
at_list_active_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"companyType","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_todos parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list to-dos for. | |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_customer_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_prospect_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_companies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against company name. |
at_update_company parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"companyName":"Acme Corp Updated","phone":"555-0200"}. |
Company Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_company_location |
Pro | Write | [Autotask] Add a new location to a company. Returns the created location with its assigned ID. The JSON should include at minimum a name and address fields. |
at_create_company_note |
Pro | Write | [Autotask] Add a note to a company. Returns the created note with its assigned ID. Useful for recording important information about a client. Note: Autotask's CompanyNotes entity marks actionType, assignedResourceID, startDateTime, and endDateTime as required; start/end default to the current time, but many instances also require actionType and assignedResourceID (supply them via the parameters below). |
at_get_company_attachment |
Free | Read-only | [Autotask] Retrieve a single company attachment by its numeric ID. Returns attachment metadata including filename, size, and content type. |
at_get_company_location |
Free | Read-only | [Autotask] Retrieve full details for a single company location by ID. Returns location info including name, address, phone, and whether it is the primary location. |
at_get_company_site_config |
Free | Read-only | [Autotask] Retrieve a single company site configuration by its numeric ID. Returns full configuration details. |
at_list_company_alerts |
Free | Read-only | [Autotask] List alerts for a specific company. Returns alert details including type, severity, and message. Requires a valid company ID. |
at_list_company_attachments |
Free | Read-only | [Autotask] List attachments for a specific company. Returns attachment metadata including filename, size, and content type. Filter by parentID (company ID). |
at_list_company_locations |
Free | Read-only | [Autotask] List locations for a specific company. Returns location details including name, address, and contact info. Requires a valid company ID -- use at_list_companies or at_search_companies to find IDs. |
at_list_company_notes |
Free | Read-only | [Autotask] List notes for a specific company. Returns note details including title, description, and timestamps. Requires a valid company ID. |
at_list_company_site_configs |
Free | Read-only | [Autotask] List site configurations for a specific company. Returns configuration details for company sites. Filter by companyID. |
at_list_company_teams |
Free | Read-only | [Autotask] List teams assigned to a specific company. Returns team details including resource assignments. Requires a valid company ID. |
at_update_company_location |
Pro | Write | [Autotask] Update an existing company location's fields. Returns the updated location. Use at_get_company_location to check current values before updating. |
at_update_company_site_config |
Pro | Write | [Autotask] Update an existing company site configuration. The id field is automatically included. Returns the updated configuration. |
at_create_company_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to add the location to. | |
fieldsJson |
string | yes | JSON object for the location to create. Example: {"name":"Main Office","address1":"123 Main St","city":"Denver","state":"CO","postalCode":"80202"}. |
at_create_company_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
actionType |
integer | no | null | Action type (picklist ID) for the note. Autotask marks this field required on the CompanyNotes entity, but its picklist values are customizable per Autotask instance with no universal default -- discover valid IDs via the entityInformation/fields endpoint or your Autotask Action Types setup. Sent only when provided; omit only if your instance does not enforce it. |
assignedResourceID |
integer | no | null | Assigned resource (Autotask user) ID for the note. Autotask marks this field required on the CompanyNotes entity, but there is no safe default -- supply a valid resource ID from your instance (use at_search_resources to find one). Sent only when provided. |
companyId |
integer | yes | The Autotask company ID to add the note to. | |
description |
string | yes | The note description/body text. | |
endDateTime |
string | no | null | Note end date/time in ISO 8601 (e.g. 2026-07-17T14:30:00Z). Defaults to the current UTC time when omitted. Always sent (Autotask requires it). |
startDateTime |
string | no | null | Note start date/time in ISO 8601 (e.g. 2026-07-17T14:30:00Z). Defaults to the current UTC time when omitted. Always sent (Autotask requires it). |
title |
string | yes | The note title. |
at_get_company_attachment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
attachmentId |
integer | yes | The numeric Autotask company attachment ID. |
at_get_company_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
locationId |
integer | yes | The Autotask company location ID. |
at_get_company_site_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
integer | yes | The numeric Autotask company site configuration ID. |
at_list_company_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list alerts for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list attachments for. | |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list locations for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list notes for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_site_configs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list site configurations for. | |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_teams parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list teams for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_company_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"name":"Branch Office","phone":"555-0300"}. | |
locationId |
integer | yes | The Autotask company location ID to update. |
at_update_company_site_config parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configId |
integer | yes | The numeric Autotask company site configuration ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. |
Contacts
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_contacts |
Free | Read-only | [Autotask] Get total count of contacts matching optional filters. Returns a count object. Useful for pagination planning or dashboards. |
at_create_contact |
Pro | Write | [Autotask] Create a new contact record. Returns the created contact with its assigned ID. The JSON should include at minimum firstName, lastName, and companyID. |
at_create_contact_billing_product |
Pro | Write | [Autotask] Create a billing product association for a contact. |
at_create_contact_group |
Pro | Write | [Autotask] Create a new contact group. Returns the created group with its assigned ID. Include at minimum a name field. |
at_create_contact_group_contact |
Pro | Write | [Autotask] Add a contact to a contact group. Returns the created membership record. Include contactGroupID and contactID. |
at_delete_contact_billing_product |
Pro | Write | [Autotask] Delete a contact billing product association by ID. |
at_delete_contact_group |
Pro | Write | [Autotask] Delete a contact group by its numeric ID. This permanently removes the group. |
at_get_contact |
Free | Read-only | [Autotask] Retrieve full details for a single contact by ID. Returns contact info including name, email, phone, company, and custom fields. Requires a valid contact ID -- use at_list_contacts or at_search_contacts to find IDs. |
at_list_company_contacts |
Free | Read-only | [Autotask] List contacts belonging to a specific company. Returns contact details including name, email, and phone. Requires a valid company ID -- use at_list_companies or at_search_companies to find IDs. |
at_list_contact_billing_products |
Free | Read-only | [Autotask] Query billing product associations for contacts. Returns products linked to contacts for billing purposes. |
at_list_contact_group_contacts |
Free | Read-only | [Autotask] List contacts belonging to a specific contact group. Filter by contactGroupID to see members. |
at_list_contact_groups |
Free | Read-only | [Autotask] List contact groups with optional filters. Returns group details including name and description. Useful for organizing contacts into categories. |
at_list_contacts |
Free | Read-only | [Autotask] Query contacts with optional filters and pagination. Returns contact summaries including ID, name, email, phone, and company association. Use this to discover contact IDs for tickets and other contact-scoped operations. |
at_search_contacts |
Free | Read-only | [Autotask] Search contacts by name or email address. Returns matching contacts where first name, last name, or email contains the search text. Use this when you know the contact name or email but not the ID. |
at_update_client_portal_user |
Pro | Write | [Autotask] Update a client portal user's settings. |
at_update_contact |
Pro | Write | [Autotask] Update an existing contact's fields. Returns the updated contact. Use at_get_contact to check current values before updating. |
at_update_contact_group |
Pro | Write | [Autotask] Update an existing contact group. The id field is automatically included. Returns the updated group. |
at_count_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":1}]. Omit for no filtering. |
at_create_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the contact to create. Example: {"firstName":"Jane","lastName":"Doe","companyID":12345,"emailAddress":"jane@example.com"}. |
at_create_contact_billing_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with billing product association fields. |
at_create_contact_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the contact group to create. Example: {"name":"VIP Contacts","isActive":true}. |
at_create_contact_group_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the group membership. Include contactGroupID and contactID. |
at_delete_contact_billing_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask contact billing product association ID. |
at_delete_contact_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
integer | yes | The numeric Autotask contact group ID to delete. |
at_get_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The Autotask contact ID. |
at_list_company_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list contacts for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contact_billing_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | no | null | Filter by contact ID. |
filterJson |
string | no | null | Raw Autotask filter JSON array. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contact_group_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
groupId |
integer | yes | The Autotask contact group ID to list contacts for. | |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contact_groups parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_contacts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against first name, last name, or email address. |
at_update_client_portal_user parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with client portal user fields to update. Must include id. |
at_update_contact parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contactId |
integer | yes | The Autotask contact ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"emailAddress":"new@example.com","phone":"555-0200"}. |
at_update_contact_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"name":"Updated Group Name"}. | |
groupId |
integer | yes | The Autotask contact group ID to update. |
Configuration Items (Assets)
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_configuration_items |
Free | Read-only | [Autotask] Get total count of configuration items matching optional filters. Returns a count object. Useful for pagination planning or asset inventory dashboards. |
at_create_ci_note |
Pro | Write | [Autotask] Add a note to a configuration item. Returns the created note with its assigned ID. Useful for documenting asset changes, maintenance records, or audit trails. |
at_create_configuration_item |
Pro | Write | [Autotask] Create a new configuration item (asset) record. Returns the created CI with its assigned ID. The JSON must include at minimum referenceTitle and companyID. Use at_list_ci_types and at_list_ci_categories to find valid reference values. |
at_get_configuration_item |
Free | Read-only | [Autotask] Retrieve full details for a single configuration item (asset) by ID. Returns CI info including title, type, serial number, company, and custom fields. Requires a valid CI ID -- use at_list_configuration_items or at_search_configuration_items to find IDs. |
at_list_active_configuration_items |
Free | Read-only | [Autotask] List configuration items that are currently active. Filters on isActive=true. Useful for current asset inventory views, excluding retired or decommissioned equipment. |
at_list_ci_notes |
Free | Read-only | [Autotask] List notes associated with a specific configuration item. Returns note details including title, description, and created date. Requires a valid CI ID. |
at_list_company_configuration_items |
Free | Read-only | [Autotask] List all configuration items (assets) for a specific company. Filters CIs by companyID. Useful for asset inventory reviews or pre-ticket context gathering. |
at_list_configuration_items |
Free | Read-only | [Autotask] Query configuration items (assets) with optional filters and pagination. Returns CI summaries including ID, title, type, company, and status. Use this to discover configuration item IDs for asset management. |
at_search_configuration_items |
Free | Read-only | [Autotask] Search configuration items by title, serial number, or reference number. Returns matching CIs where the referenceTitle contains the search text. Use this when you know a device name but not the ID. |
at_update_configuration_item |
Pro | Write | [Autotask] Update an existing configuration item's fields. Returns the updated CI. The JSON must include the CI id field. Use at_get_configuration_item to check current values before updating. |
at_count_configuration_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
at_create_ci_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to add the note to. | |
description |
string | yes | Description/body of the note. | |
title |
string | yes | Title of the note. |
at_create_configuration_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the CI to create. Must include referenceTitle and companyID. Example: {"referenceTitle":"DESKTOP-001","companyID":123,"configurationItemType":5,"serialNumber":"SN12345"}. |
at_get_configuration_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID. |
at_list_active_configuration_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to list notes for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_configuration_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list CIs for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_configuration_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"companyID","value":123}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_configuration_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against CI referenceTitle. |
at_update_configuration_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"referenceTitle":"DESKTOP-002","serialNumber":"SN67890"}. |
CI Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_list_ci_categories |
Free | Read-only | [Autotask] List configuration item categories with optional filters. Returns category details including name and description. Useful for discovering valid category values when creating or updating CIs. |
at_list_ci_category_udf_associations |
Free | Read-only | [Autotask] List user-defined field (UDF) associations for a specific configuration item category. Returns UDF metadata including field names, types, and picklist values. Use at_list_ci_categories to find valid category IDs. |
at_list_ci_dns_records |
Free | Read-only | [Autotask] List DNS records associated with a configuration item. Returns DNS record details including hostname, record type, and value. Requires a valid CI ID. |
at_list_ci_related_items |
Free | Read-only | [Autotask] List items related to a configuration item. Returns relationship details including related item type and ID. Useful for understanding asset dependencies and connections. |
at_list_ci_ssl_certificates |
Free | Read-only | [Autotask] List SSL certificates associated with a configuration item. Returns certificate details including subject, issuer, and expiration date. Requires a valid CI ID. |
at_list_ci_types |
Free | Read-only | [Autotask] List configuration item types with optional filters. Returns type details including name and description. Useful for discovering valid type values when creating or updating CIs. |
at_list_ci_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_category_udf_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
categoryId |
integer | yes | The Autotask CI category ID to list UDF associations for. Use at_list_ci_categories to find valid IDs. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_dns_records parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to list DNS records for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_related_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to list related items for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_ssl_certificates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
configItemId |
integer | yes | The Autotask configuration item ID to list SSL certificates for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Contracts
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_contracts |
Free | Read-only | [Autotask] Get total count of contracts matching optional filters. Returns a count object. Useful for pagination planning or contract portfolio dashboards. |
at_create_contract |
Pro | Write | [Autotask] Create a new contract record. Returns the created contract with its assigned ID. The JSON must include at minimum contractName, companyID, and contractType. Use at_list_contracts to verify creation. |
at_get_contract |
Free | Read-only | [Autotask] Retrieve full details for a single contract by ID. Returns contract info including name, type, status, dates, and billing details. Requires a valid contract ID -- use at_list_contracts or at_search_contracts to find IDs. |
at_list_active_contracts |
Free | Read-only | [Autotask] List contracts that are currently active. Filters on status=1 (Active). Useful for service delivery dashboards and identifying contracts that are currently in effect. |
at_list_company_contracts |
Free | Read-only | [Autotask] List all contracts for a specific company. Filters contracts by companyID. Useful for service delivery reviews, billing audits, and understanding a company's contract portfolio. |
at_list_contracts |
Free | Read-only | [Autotask] Query contracts with optional filters and pagination. Returns contract summaries including ID, name, type, status, and company. Use this to discover contract IDs for service delivery and billing management. |
at_search_contracts |
Free | Read-only | [Autotask] Search contracts by name. Returns matching contracts where the contract name contains the search text. Use this when you know the contract name but not the ID. |
at_update_contract |
Pro | Write | [Autotask] Update an existing contract's fields. Returns the updated contract. The JSON must include the contract id field. Use at_get_contract to check current values before updating. |
at_count_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
at_create_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the contract to create. Must include contractName, companyID, and contractType. Example: {"contractName":"Managed Services","companyID":123,"contractType":1,"startDate":"2026-01-01","endDate":"2026-12-31"}. |
at_get_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID. |
at_list_active_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list contracts for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"companyID","value":123}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against contract name. |
at_update_contract parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"contractName":"Managed Services v2","endDate":"2027-12-31"}. |
Contract Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_contract_charge |
Pro | Write | [Autotask] Add a charge to a contract. Returns the created charge with its assigned ID. The JSON must include at minimum contractID, name, and unitCost. Use at_list_contract_charges to verify creation. |
at_list_contract_billing_rules |
Free | Read-only | [Autotask] List billing rules configured for a contract. Returns rule details including frequency, amount, and effective dates. Useful for understanding recurring billing schedules. |
at_list_contract_blocks |
Free | Read-only | [Autotask] List hour blocks associated with a contract. Returns block details including hours purchased, hours used, and effective dates. Useful for tracking prepaid hour consumption. |
at_list_contract_charges |
Free | Read-only | [Autotask] List charges posted against a contract. Returns charge details including description, amount, and date. Useful for billing reviews and expense tracking. |
at_list_contract_milestones |
Free | Read-only | [Autotask] List milestones associated with a contract. Returns milestone details including title, due date, and status. Useful for tracking contract deliverables and project timelines. |
at_list_contract_notes |
Free | Read-only | [Autotask] List notes associated with a contract. Returns note details including title, description, and created date. Useful for reviewing contract documentation and communication history. |
at_list_contract_rates |
Free | Read-only | [Autotask] List rates configured for a contract. Returns rate details including role, rate amount, and billing type. Useful for billing reviews and rate card analysis. |
at_list_contract_retainers |
Free | Read-only | [Autotask] List retainers associated with a contract. Returns retainer details including amount, period, and usage. Useful for tracking retainer consumption and billing. |
at_list_contract_service_bundles |
Free | Read-only | [Autotask] List service bundles associated with a contract. Returns bundle details including name and included services. Useful for reviewing bundled service agreements. |
at_list_contract_services |
Free | Read-only | [Autotask] List services associated with a contract. Returns service details including name, price, and quantity. Useful for understanding what services are included in a contract. |
at_create_contract_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to add the charge to. | |
fieldsJson |
string | yes | JSON object for the charge to create. Must include name and unitCost. Example: {"name":"After-hours support","unitCost":150.00,"unitQuantity":2,"datePurchased":"2026-03-27"}. |
at_list_contract_billing_rules parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list billing rules for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_blocks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list blocks for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_charges parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list charges for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_milestones parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list milestones for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list notes for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_rates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list rates for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_retainers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list retainers for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_service_bundles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list service bundles for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_services parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to list services for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Projects
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_projects |
Free | Read-only | [Autotask] Get total count of projects matching optional filters. Returns a count object. Useful for pagination planning or dashboards. |
at_create_project |
Pro | Write | [Autotask] Create a new project record. Returns the created project with its assigned ID. The JSON must include at minimum projectName and companyID. Use at_list_projects to verify creation. |
at_get_project |
Free | Read-only | [Autotask] Retrieve full details for a single project by ID. Returns project info including name, status, company, dates, budget, and custom fields. Requires a valid project ID -- use at_list_projects or at_search_projects to find IDs. |
at_list_active_projects |
Free | Read-only | [Autotask] List projects with Active or New status. Filters on status values 1 (New) and 3 (Active). Useful for workload reviews and resource planning -- excludes completed, cancelled, and inactive projects. |
at_list_company_projects |
Free | Read-only | [Autotask] List all projects for a specific company. Returns projects filtered by company ID. Use at_list_companies or at_search_companies to find valid company IDs. |
at_list_projects |
Free | Read-only | [Autotask] Query projects with optional filters and pagination. Returns project summaries including ID, name, status, company, and dates. Use this to discover project IDs for filtering phases, tasks, notes, and charges. |
at_search_projects |
Free | Read-only | [Autotask] Search projects by name. Returns matching projects where the project name contains the search text. Use this when you know the project name but not the ID. |
at_update_project |
Pro | Write | [Autotask] Update an existing project's fields. Returns the updated project. The project id field is set automatically from the projectId parameter. Use at_get_project to check current values before updating. |
at_count_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
at_create_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the project to create. Must include projectName and companyID. Example: {"projectName":"Network Upgrade","companyID":12345,"status":1}. |
at_get_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
projectId |
integer | yes | The Autotask project ID. |
at_list_active_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list projects for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_projects parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against project name. |
at_update_project parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"projectName":"Network Upgrade v2","status":5}. | |
projectId |
integer | yes | The Autotask project ID to update. |
Project Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_project_task |
Pro | Write | [Autotask] Create a new task within a project. Returns the created task with its assigned ID. The JSON must include at minimum title and projectID. The projectId parameter is merged into the JSON automatically. |
at_get_project_phase |
Free | Read-only | [Autotask] Retrieve full details for a single project phase by ID. Returns phase info including title, dates, status, and description. Requires a valid phase ID -- use at_list_project_phases to find IDs. |
at_get_project_task |
Free | Read-only | [Autotask] Retrieve full details for a single project task by ID. Returns task info including title, status, assigned resource, estimated hours, and description. Requires a valid task ID -- use at_list_project_tasks to find IDs. |
at_list_project_charges |
Free | Read-only | [Autotask] List charges on a project. Returns charge details including name, amount, date, and billing status. Requires a valid project ID -- use at_list_projects or at_search_projects to find IDs. |
at_list_project_notes |
Free | Read-only | [Autotask] List notes on a project. Returns note details including title, description, publish type, and created date. Requires a valid project ID -- use at_list_projects or at_search_projects to find IDs. |
at_list_project_phases |
Free | Read-only | [Autotask] List phases within a project. Returns phase summaries including ID, title, start/end dates, and status. Requires a valid project ID -- use at_list_projects or at_search_projects to find IDs. |
at_list_project_tasks |
Free | Read-only | [Autotask] List tasks within a project. Returns task summaries including ID, title, status, assigned resource, and estimated hours. Requires a valid project ID -- use at_list_projects or at_search_projects to find IDs. |
at_update_project_task |
Pro | Write | [Autotask] Update an existing project task's fields. Returns the updated task. The task id field is set automatically from the taskId parameter. Use at_get_project_task to check current values before updating. |
at_create_project_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the task to create. Must include title. Example: {"title":"Configure firewall","status":1,"estimatedHours":4.0}. | |
projectId |
integer | yes | The Autotask project ID to create the task in. |
at_get_project_phase parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
phaseId |
integer | yes | The Autotask phase ID. |
at_get_project_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskId |
integer | yes | The Autotask task ID. |
at_list_project_charges parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
projectId |
integer | yes | The Autotask project ID to list charges for. |
at_list_project_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
projectId |
integer | yes | The Autotask project ID to list notes for. |
at_list_project_phases parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
projectId |
integer | yes | The Autotask project ID to list phases for. |
at_list_project_tasks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
projectId |
integer | yes | The Autotask project ID to list tasks for. |
at_update_project_task parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"status":5,"estimatedHours":8.0}. | |
taskId |
integer | yes | The Autotask task ID to update. |
Time Entries
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_time_entries |
Free | Read-only | [Autotask] Get total count of time entries matching optional filters. Returns a count object. Useful for utilization reporting and pagination planning. |
at_create_time_entry |
Pro | Write | [Autotask] Create a new time entry record. Returns the created time entry with its assigned ID. The JSON must include at minimum resourceID, dateWorked, and hoursWorked. Use at_list_time_entries to verify creation. |
at_get_time_entry |
Free | Read-only | [Autotask] Retrieve full details for a single time entry by ID. Returns time entry info including resource, ticket, date worked, hours, summary, and billing fields. Requires a valid time entry ID -- use at_list_time_entries to find IDs. |
at_list_recent_time_entries |
Free | Read-only | [Autotask] List time entries from the last N days. Defaults to the last 7 days. Useful for recent activity reviews and timesheet audits across all resources. |
at_list_resource_time_entries |
Free | Read-only | [Autotask] List time entries for a specific resource within an optional date range. Useful for utilization reports and timesheet reviews. Use at_list_resources to find valid resource IDs. |
at_list_ticket_time_entries |
Free | Read-only | [Autotask] List time entries logged against a specific ticket. Returns time entry details including resource, hours, date, and summary. Requires a valid ticket ID -- use at_list_tickets or at_search_tickets to find IDs. |
at_list_time_entries |
Free | Read-only | [Autotask] Query time entries with optional filters and pagination. Returns time entry summaries including ID, resource, ticket, date worked, hours, and billing status. Use this to browse time entries or narrow results before fetching full details. |
at_update_time_entry |
Pro | Write | [Autotask] Update an existing time entry's fields. Returns the updated time entry. The time entry id field is set automatically from the timeEntryId parameter. Use at_get_time_entry to check current values before updating. |
at_count_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"resourceID","value":12345}]. Omit for no filtering. |
at_create_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the time entry to create. Must include resourceID, dateWorked, and hoursWorked. Example: {"resourceID":12345,"ticketID":67890,"dateWorked":"2026-03-27","hoursWorked":2.5,"summaryNotes":"Firewall config"}. |
at_get_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
timeEntryId |
integer | yes | The Autotask time entry ID. |
at_list_recent_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 7 | Number of days to look back (default 7). |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date filter in yyyy-MM-dd format. Returns entries on or before this date. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
resourceId |
integer | yes | The Autotask resource ID to list time entries for. | |
startDate |
string | no | null | Start date filter in yyyy-MM-dd format. Returns entries on or after this date. |
at_list_ticket_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
ticketId |
integer | yes | The Autotask ticket ID to list time entries for. |
at_list_time_entries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"resourceID","value":12345}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_time_entry parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"hoursWorked":3.0,"summaryNotes":"Updated notes"}. | |
timeEntryId |
integer | yes | The Autotask time entry ID to update. |
Resources (Technicians)
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_resource |
Free | Read-only | [Autotask] Retrieve full details for a single resource (technician) by ID. Returns resource info including name, email, title, department, and active status. Requires a valid resource ID -- use at_list_resources or at_search_resources to find IDs. |
at_list_active_resources |
Free | Read-only | [Autotask] List resources that are currently active. Filters on isActive=true. Useful for staffing views, dispatch boards, and resource assignment -- excludes inactive or terminated staff. |
at_list_resource_roles |
Free | Read-only | [Autotask] List resource roles with optional filters. Returns role details including ID, name, and description. Roles define billing rates and capacity for resources on projects and tickets. |
at_list_resource_skills |
Free | Read-only | [Autotask] List skills assigned to a specific resource. Returns skill details including skill name and proficiency level. Useful for skill-based routing and capacity planning. Requires a valid resource ID -- use at_list_resources to find IDs. |
at_list_resources |
Free | Read-only | [Autotask] List resources (technicians/staff) with optional filters and pagination. Returns resource summaries including ID, name, email, and active status. Use this to discover resource IDs for filtering time entries, tickets, and tasks. |
at_search_resources |
Free | Read-only | [Autotask] Search resources by name or email. Returns matching resources where the first name, last name, or email contains the search text. Use this when you know a technician's name or email but not their ID. |
at_get_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
resourceId |
integer | yes | The Autotask resource ID. |
at_list_active_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_roles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_skills parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
resourceId |
integer | yes | The Autotask resource ID to list skills for. |
at_list_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against first name, last name, or email. |
Opportunities (Sales)
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_opportunities |
Free | Read-only | [Autotask] Get total count of opportunities matching optional filters. Returns a count object. Useful for pipeline dashboards and sales reporting. |
at_create_opportunity |
Pro | Write | [Autotask] Create a new opportunity record. Returns the created opportunity with its assigned ID. The JSON must include required fields such as title and companyID. Use at_list_opportunities to verify creation. |
at_get_opportunity |
Free | Read-only | [Autotask] Retrieve full details for a single opportunity by ID. Returns opportunity info including title, status, amount, probability, projected close date, and custom fields. Requires a valid opportunity ID -- use at_list_opportunities or at_search_opportunities to find IDs. |
at_list_company_opportunities |
Free | Read-only | [Autotask] List opportunities for a specific company. Returns all opportunities linked to the given company ID. Useful for account reviews and company-level sales history. |
at_list_open_opportunities |
Free | Read-only | [Autotask] List opportunities that are currently open (not won or lost). Useful for active sales pipeline views and forecasting. |
at_list_opportunities |
Free | Read-only | [Autotask] Query opportunities with optional filters and pagination. Returns opportunity summaries including ID, title, status, amount, and probability. Use this to discover opportunity IDs for detailed lookups. |
at_search_opportunities |
Free | Read-only | [Autotask] Search opportunities by title. Returns matching opportunities where the title contains the search text. Use this when you know the opportunity name but not the ID. |
at_update_opportunity |
Pro | Write | [Autotask] Update an existing opportunity's fields. Returns the updated opportunity. The JSON must include the opportunity id field. Use at_get_opportunity to check current values before updating. |
at_count_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
at_create_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the opportunity to create. Must include title and companyID. Example: {"title":"New Deal","companyID":12345,"amount":50000,"probability":75}. |
at_get_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
opportunityId |
integer | yes | The Autotask opportunity ID. |
at_list_company_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list opportunities for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_open_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_opportunities parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against opportunity title. |
at_update_opportunity parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"amount":75000,"probability":90,"status":2}. | |
opportunityId |
integer | yes | The Autotask opportunity ID to update. |
Quotes and Sales Orders
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_quote |
Pro | Write | [Autotask] Create a new quote record. Returns the created quote with its assigned ID. The JSON must include required fields such as name and opportunityID. Use at_list_quotes to verify creation. |
at_get_quote |
Free | Read-only | [Autotask] Retrieve full details for a single quote by ID. Returns quote info including name, description, line items, totals, and approval status. Requires a valid quote ID -- use at_list_quotes to find IDs. |
at_get_sales_order |
Free | Read-only | [Autotask] Retrieve full details for a single sales order by ID. Returns sales order info including status, line items, and linked opportunity. Requires a valid sales order ID -- use at_list_sales_orders to find IDs. |
at_list_quotes |
Free | Read-only | [Autotask] Query quotes with optional filters and pagination. Returns quote summaries including ID, name, status, total, and associated opportunity. Use this to discover quote IDs for detailed lookups. |
at_list_sales_orders |
Free | Read-only | [Autotask] Query sales orders with optional filters and pagination. Returns sales order summaries including ID, status, and associated opportunity. Use this to discover sales order IDs for detailed lookups. |
at_update_quote |
Pro | Write | [Autotask] Update an existing quote's fields. Returns the updated quote. The JSON must include the quote id field. Use at_get_quote to check current values before updating. |
at_create_quote parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the quote to create. Must include name and opportunityID. Example: {"name":"Q-2026-001","opportunityID":12345,"description":"Annual support renewal"}. |
at_get_quote parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
quoteId |
integer | yes | The Autotask quote ID. |
at_get_sales_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
salesOrderId |
integer | yes | The Autotask sales order ID. |
at_list_quotes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_sales_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_quote parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"name":"Q-2026-001 Rev2","description":"Updated scope"}. | |
quoteId |
integer | yes | The Autotask quote ID to update. |
Scheduling and Calendar
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_appointment |
Pro | Write | [Autotask] Create a new appointment/calendar entry. Returns the created appointment with its assigned ID. The JSON should include at minimum a title, start date/time, and end date/time. This creates a calendar entry visible to assigned resources. |
at_get_appointment |
Free | Read-only | [Autotask] Retrieve a single appointment by its numeric ID. Returns full appointment details including title, description, start/end times, and assigned resource. Requires a valid appointment ID -- use at_list_appointments to find IDs. |
at_list_appointments |
Free | Read-only | [Autotask] Query appointments with optional filters. Returns paginated appointment summaries including ID, title, start/end times, and assigned resource. Use this to browse calendar entries or narrow results before fetching full details with at_get_appointment. |
at_list_resource_appointments |
Free | Read-only | [Autotask] List appointments for a specific resource within an optional date range. Useful for viewing a technician's calendar or checking availability. Requires a valid resource ID -- use at_list_resources to find IDs. |
at_update_appointment |
Pro | Write | [Autotask] Update an existing appointment via PATCH. Provide the appointment ID and a JSON object of fields to update. The id field is automatically included. Returns the updated appointment. Requires a valid appointment ID -- use at_list_appointments to find IDs. |
at_create_appointment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the appointment to create. Must include title, startDateTime, endDateTime. Example: {"title":"Client meeting","startDateTime":"2026-04-01T10:00:00Z","endDateTime":"2026-04-01T11:00:00Z","resourceID":12345}. |
at_get_appointment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
appointmentId |
integer | yes | The numeric Autotask appointment ID. Use at_list_appointments to find valid IDs. |
at_list_appointments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"gte","field":"startDateTime","value":"2026-03-01"}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_appointments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format. Returns appointments starting on or before this date. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
resourceId |
integer | yes | The numeric Autotask resource ID. Use at_list_resources to find valid IDs. | |
startDate |
string | no | null | Start date in yyyy-MM-dd format. Returns appointments starting on or after this date. |
at_update_appointment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
appointmentId |
integer | yes | The numeric Autotask appointment ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"title":"Updated meeting","endDateTime":"2026-04-01T12:00:00Z"}. Field names must match Autotask API field names. |
Expenses and Purchase Orders
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_purchase_order |
Pro | Write | [Autotask] Create a new purchase order. Returns the created PO with its assigned ID. The JSON must include required fields such as vendorID. Use at_list_purchase_orders to verify creation. |
at_get_expense_report |
Free | Read-only | [Autotask] Retrieve full details for a single expense report by ID. Returns expense report info including submitter, status, total, line items, and approval details. Requires a valid report ID -- use at_list_expense_reports to find IDs. |
at_get_purchase_order |
Free | Read-only | [Autotask] Retrieve full details for a single purchase order by ID. Returns PO info including vendor, status, line items, totals, and shipping details. Requires a valid PO ID -- use at_list_purchase_orders to find IDs. |
at_list_expense_items |
Free | Read-only | [Autotask] List expense items with optional filters and pagination. Optionally filter by expense report ID to see items for a specific report. Returns expense item details including description, amount, category, and billable status. |
at_list_expense_reports |
Free | Read-only | [Autotask] List expense reports with optional filters and pagination. Returns expense report summaries including ID, submitter, status, total, and submission date. Use this to discover report IDs for detailed lookups. |
at_list_purchase_orders |
Free | Read-only | [Autotask] List purchase orders with optional filters and pagination. Returns purchase order summaries including ID, vendor, status, total, and dates. Use this to discover PO IDs for detailed lookups. |
at_create_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the purchase order to create. Must include vendorID. Example: {"vendorID":12345,"status":1,"shipToAddress":"123 Main St"}. |
at_get_expense_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
reportId |
integer | yes | The Autotask expense report ID. |
at_get_purchase_order parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
purchaseOrderId |
integer | yes | The Autotask purchase order ID. |
at_list_expense_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isBillable","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
reportId |
integer | no | null | Optional expense report ID to filter items for a specific report. |
at_list_expense_reports parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_purchase_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Invoices and Billing
| Tool | Plan | Access | Description |
|---|---|---|---|
at_count_invoices |
Free | Read-only | [Autotask] Get total count of invoices matching optional filters. Returns a count object. Useful for billing dashboards and financial reporting. |
at_get_billing_item |
Free | Read-only | [Autotask] Retrieve full details for a single billing item by ID. Returns billing item info including type, amount, dates, and linked entities. Requires a valid billing item ID -- use at_list_billing_items to find IDs. |
at_get_invoice |
Free | Read-only | [Autotask] Retrieve full details for a single invoice by ID. Returns invoice info including number, dates, line items, totals, and payment status. Requires a valid invoice ID -- use at_list_invoices to find IDs. |
at_list_billing_items |
Free | Read-only | [Autotask] List billing items with optional filters and pagination. Returns billing item details including type, amount, and associated entities. Useful for revenue analysis and billing reconciliation. |
at_list_company_invoices |
Free | Read-only | [Autotask] List invoices for a specific company. Returns all invoices linked to the given company ID. Useful for client billing reviews and account reconciliation. |
at_list_invoices |
Free | Read-only | [Autotask] Query invoices with optional filters and pagination. Returns invoice summaries including ID, invoice number, company, total, and status. Use this to discover invoice IDs for detailed lookups. |
at_count_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"gte","field":"invoiceTotal","value":500}]. Omit for no filtering. |
at_get_billing_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
billingItemId |
integer | yes | The Autotask billing item ID. |
at_get_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId |
integer | yes | The Autotask invoice ID. |
at_list_billing_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"type","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to list invoices for. | |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_invoices parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"invoiceTotal","value":1000}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Products and Services
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_product |
Free | Read-only | [Autotask] Retrieve full details for a single product by ID. Returns product info including name, SKU, description, unit price, cost, and vendor details. Requires a valid product ID -- use at_list_products or at_search_products to find IDs. |
at_list_products |
Free | Read-only | [Autotask] List products from the product catalog with optional filters and pagination. Returns product details including ID, name, SKU, unit price, and active status. Use this to discover product IDs for detailed lookups. |
at_list_service_bundles |
Free | Read-only | [Autotask] List service bundles with optional filters and pagination. Returns service bundle details including ID, name, and included services. Service bundles group multiple services for simplified billing. |
at_list_services |
Free | Read-only | [Autotask] List services from the service catalog with optional filters and pagination. Returns service details including ID, name, unit price, and billing period. Useful for viewing recurring service offerings. |
at_list_subscriptions |
Free | Read-only | [Autotask] List subscriptions with optional filters and pagination. Returns subscription details including ID, period type, total, and associated company. Useful for recurring revenue analysis and subscription management. |
at_search_products |
Free | Read-only | [Autotask] Search products by name or SKU. Returns matching products where the name contains the search text. Use this when you know the product name but not the ID. |
at_get_product parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
productId |
integer | yes | The Autotask product ID. |
at_list_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_service_bundles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_services parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"isActive","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_subscriptions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"status","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search text to match against product name. |
Documents and Attachments
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_document |
Free | Read-only | [Autotask] Retrieve a single document by its numeric ID. Returns full document metadata including title, file name, content type, and parent entity reference. Requires a valid document ID -- use at_list_documents or at_search_documents to find IDs. |
at_list_documents |
Free | Read-only | [Autotask] Query documents and attachments with optional filters. Returns paginated document summaries including ID, title, file name, and parent entity reference. Use this to browse documents or narrow results before fetching full details with at_get_document. |
at_list_entity_documents |
Free | Read-only | [Autotask] List documents attached to a specific parent entity (e.g. Ticket, Company, Project). Builds a filter on the parentDocumentType and parentDocumentID fields to find all documents belonging to the specified entity. |
at_search_documents |
Free | Read-only | [Autotask] Search documents by title keyword. Returns documents whose title contains the search term. Use this when looking for documents by name rather than structured filtering with at_list_documents. |
at_get_document parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
documentId |
integer | yes | The numeric Autotask document ID. Use at_list_documents or at_search_documents to find valid IDs. |
at_list_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"publish","value":1}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_entity_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
parentId |
integer | yes | The numeric ID of the parent entity. | |
parentType |
string | yes | The parent entity type. Valid values: Ticket, Company, Contact, Project, Opportunity, ConfigurationItem. |
at_search_documents parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search term to match against document titles. Case-insensitive contains match. |
Attachments
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_attachment |
Free | Read-only | [Autotask] Retrieve a single attachment info record by its numeric ID. Returns attachment metadata including filename, size, content type, and parent entity reference. |
at_list_attachments |
Free | Read-only | [Autotask] Query attachment info records across all entity types. Returns attachment metadata including filename, size, and parent entity. Use filterJson for advanced queries. |
at_list_ci_note_attachments |
Free | Read-only | [Autotask] Query attachments on configuration item notes. Filter by parentID (CI note ID) to narrow results. |
at_list_company_note_attachments |
Free | Read-only | [Autotask] Query attachments on company notes. Filter by parentID (company note ID) to narrow results. |
at_list_contract_note_attachments |
Free | Read-only | [Autotask] Query attachments on contract notes. Filter by parentID (contract note ID) to narrow results. |
at_list_project_note_attachments |
Free | Read-only | [Autotask] Query attachments on project notes. Filter by parentID (project note ID) to narrow results. |
at_list_time_entry_attachments |
Free | Read-only | [Autotask] Query attachments on time entries. Filter by parentID (time entry ID) to narrow results. |
at_get_attachment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
attachmentId |
integer | yes | The numeric Autotask attachment info ID. |
at_list_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentType","value":"Ticket"}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_ci_note_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_company_note_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_note_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_project_note_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_time_entry_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Knowledge Base
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_kb_article |
Pro | Write | [Autotask] Create a new knowledge base article. Returns the created article with its assigned ID. The JSON should include at minimum a title and body content. This creates content visible to support staff and optionally end users. |
at_get_kb_article |
Free | Read-only | [Autotask] Retrieve a single knowledge base article by its numeric ID. Returns full article details including title, body content, and metadata. Requires a valid article ID -- use at_list_kb_articles or at_search_kb_articles to find IDs. |
at_list_kb_articles |
Free | Read-only | [Autotask] Query knowledge base articles with optional filters. Returns paginated KB article summaries including ID, title, and content. Use this to browse articles or narrow results before fetching full details with at_get_kb_article. |
at_search_kb_articles |
Free | Read-only | [Autotask] Search knowledge base articles by keyword. Returns articles whose title contains the search term. Use this when looking for KB articles by keyword rather than structured filtering with at_list_kb_articles. |
at_update_kb_article |
Pro | Write | [Autotask] Update an existing knowledge base article via PATCH. Provide the article ID and a JSON object of fields to update. The id field is automatically included. Returns the updated article. Requires a valid article ID -- use at_list_kb_articles or at_search_kb_articles to find IDs. |
at_create_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the KB article to create. Must include title. Example: {"title":"How to reset password","content":"Step 1...","publish":true}. |
at_get_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
articleId |
integer | yes | The numeric Autotask KB article ID. Use at_list_kb_articles or at_search_kb_articles to find valid IDs. |
at_list_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"eq","field":"publish","value":true}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_search_kb_articles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
search |
string | yes | Search term to match against article titles. Case-insensitive contains match. |
at_update_kb_article parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
articleId |
integer | yes | The numeric Autotask KB article ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"title":"Updated title","content":"Updated body..."}. Field names must match Autotask API field names. |
Surveys and CSAT
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_survey_result |
Free | Read-only | [Autotask] Retrieve a single survey result by its numeric ID. Returns full survey result details including rating, comments, ticket reference, and response metadata. Requires a valid survey result ID -- use at_list_survey_results to find IDs. |
at_list_survey_results |
Free | Read-only | [Autotask] Query customer satisfaction survey results with optional filters. Returns paginated survey result summaries including ID, rating, ticket reference, and response date. Useful for CSAT reporting and identifying trends in customer feedback. |
at_get_survey_result parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
surveyResultId |
integer | yes | The numeric Autotask survey result ID. Use at_list_survey_results to find valid IDs. |
at_list_survey_results parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Example: [{"op":"gte","field":"rating","value":4}]. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Discovery and Entity Info
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_api_threshold |
Free | Read-only | [Autotask] Get the current API request threshold and usage information. Returns the maximum number of API calls allowed per hour and the current usage count. Useful for monitoring rate limit consumption and planning batch operations. |
at_get_entity_info |
Free | Read-only | [Autotask] Get entity information including capabilities, field count, and whether the entity supports create/update/delete operations. Useful for understanding what operations are available on an entity before making API calls. |
at_get_field_info |
Free | Read-only | [Autotask] Get detailed field definitions for an entity including data types, required fields, picklist values, and validation rules. Essential for understanding which fields to include when creating or updating records, and for discovering valid picklist values for dropdown fields. |
at_get_udf_info |
Free | Read-only | [Autotask] Get user-defined field (UDF) definitions for an entity. Returns custom field names, data types, and picklist values configured by the Autotask administrator. UDFs are instance-specific and vary between Autotask tenants. |
at_get_zone_info |
Free | Read-only | [Autotask] Get the Autotask zone/datacenter URL for this tenant. Returns the correct API base URL for the tenant's geographic zone. Useful for diagnostics and verifying API connectivity. |
at_list_picklist_values |
Free | Read-only | [Autotask] Get picklist values for a specific field on an entity. Returns the field definition including its available picklist options with labels and values. Useful for discovering valid values for dropdown fields like status, priority, or type before creating or updating records. |
at_list_ticket_categories |
Free | Read-only | [Autotask] List ticket categories. Returns available ticket category options including ID and name. Categories group tickets into functional areas (e.g. Service Request, Incident, Problem). Use these values when creating or filtering tickets. |
at_list_ticket_sources |
Free | Read-only | [Autotask] List ticket source picklist values. Returns the source field definition from the Tickets entity including all available picklist options. Sources indicate how a ticket was created (e.g. Phone, Email, Portal). Use these values when creating tickets. |
at_get_entity_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityName |
string | yes | The Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects, TimeEntries, Contracts. |
at_get_field_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityName |
string | yes | The Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects, TimeEntries, Contracts. |
at_get_udf_info parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityName |
string | yes | The Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems, Resources, Projects. |
at_list_picklist_values parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityName |
string | yes | The Autotask entity name. Examples: Tickets, Companies, Contacts, ConfigurationItems. | |
fieldName |
string | yes | The field name to get picklist values for. Examples: status, priority, queueID, companyType, ticketType. |
at_list_ticket_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Lookups and Reference Data
| Tool | Plan | Access | Description |
|---|---|---|---|
at_list_billing_codes |
Free | Read-only | [Autotask] List billing codes (work types). Returns billing code records including ID, name, and rate information. Billing codes are used for time entries and charges to categorize work performed. Use these values when creating time entries or charges. |
at_list_company_classifications |
Free | Read-only | [Autotask] List company classification picklist values. Returns the classification field definition from the Companies entity including all available classification options. Classifications provide additional categorization beyond company type. Use these values when creating or updating companies. |
at_list_company_types |
Free | Read-only | [Autotask] List company type picklist values. Returns the companyType field definition from the Companies entity including all available type options (e.g. Customer, Lead, Prospect, Vendor). Use these values when creating, updating, or filtering companies by type. |
at_list_departments |
Free | Read-only | [Autotask] List all departments. Returns department records including ID, name, and description. Departments are used to organize resources and can be referenced when creating or filtering tickets, time entries, and other records. |
at_list_ticket_priorities |
Free | Read-only | [Autotask] List ticket priority picklist values. Returns the priority field definition from the Tickets entity including all available priority options with their IDs and labels. Priority IDs vary by Autotask instance. Use these values when creating, updating, or filtering tickets by priority. |
at_list_ticket_queues |
Free | Read-only | [Autotask] List ticket queue picklist values. Returns the queueID field definition from the Tickets entity including all available queue options with their IDs and labels. Queues route tickets to specific dispatch groups. Use these values when creating, updating, or filtering tickets by queue. |
at_list_ticket_statuses |
Free | Read-only | [Autotask] List ticket status picklist values. Returns the status field definition from the Tickets entity including all available status options with their IDs and labels. Status IDs vary by Autotask instance. Use these values when creating, updating, or filtering tickets by status. |
at_list_ticket_types |
Free | Read-only | [Autotask] List ticket type picklist values. Returns the ticketType field definition from the Tickets entity including all available type options with their IDs and labels. Use these values when creating, updating, or filtering tickets by type. |
at_list_billing_codes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_departments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
at_open_ticket_age_distribution |
Free | Read-only | [Autotask] Analyze open tickets grouped by age bucket (0-7d, 8-14d, 15-30d, 31-60d, 60d+). Returns bucket names and ticket counts showing the age profile of open work. Use for backlog health assessment. |
at_open_ticket_summary |
Free | Read-only | [Autotask] Quick summary of all open tickets grouped by queue, priority, and age bucket. Use for a fast pulse-check on the service desk backlog. |
at_priority_distribution |
Free | Read-only | [Autotask] Open ticket count per priority level. Returns a quick dashboard metric showing how open tickets are distributed across priority levels. Use for daily health checks and prioritization. |
at_queue_performance_comparison |
Free | Read-only | [Autotask] Compare ticket metrics across queues. Returns volume, average resolution time, and SLA compliance per queue. Use for identifying which queues are busiest or slowest. |
at_stale_ticket_report |
Free | Read-only | [Autotask] Identify open tickets with no activity beyond a threshold, indicating potential neglect or bottlenecks. Returns stale tickets sorted by days inactive. Use for daily triage to catch tickets that need attention. |
at_team_workload_balance |
Free | Read-only | [Autotask] View open ticket distribution across resources to identify workload imbalances. Returns per-resource open ticket counts and workload percentages. Use for capacity planning or rebalancing assignments. |
at_ticket_resolution_analytics |
Free | Read-only | [Autotask] Analyze resolution metrics for closed tickets in a date range. Returns average and median resolution time, total closed count, and fastest/slowest resolution times. Use for service delivery performance review. |
at_ticket_source_analysis |
Free | Read-only | [Autotask] Analyze ticket creation sources (email, phone, portal, etc.). Groups tickets by source to show which channels generate the most volume. Use for understanding intake patterns. |
at_ticket_volume_trends |
Free | Read-only | [Autotask] Track ticket volume over multiple time periods to identify trends. Returns an array of period buckets with start/end dates and ticket counts. Use for weekly or monthly volume reporting. |
at_unassigned_ticket_report |
Free | Read-only | [Autotask] Count and list unassigned open tickets grouped by queue. Returns per-queue counts and ticket summaries for tickets with no assigned resource. Use for daily triage to ensure all tickets are assigned. |
at_open_ticket_age_distribution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum tickets to analyze (default 500, max 500). Larger sets give more accurate distribution. |
at_open_ticket_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum tickets to analyze (default 500, max 500). |
at_priority_distribution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum tickets to analyze (default 500, max 500). |
at_queue_performance_comparison parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
days |
integer | no | 30 | Number of days to look back (default 30). |
at_stale_ticket_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum results to return (default 500, max 500). |
staleDays |
integer | no | 7 | Number of days without activity to consider a ticket stale (default 7). Lower for urgent triage, higher for periodic reviews. |
at_team_workload_balance parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum tickets to analyze (default 500, max 500). |
at_ticket_resolution_analytics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
at_ticket_source_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (default: today). |
startDate |
string | no | null | Start date in yyyy-MM-dd format (default: 30 days ago). |
at_ticket_volume_trends parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
periodDays |
integer | no | 7 | Days per period (default 7). |
periods |
integer | no | 4 | Number of periods to analyze (default 4). |
at_unassigned_ticket_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum results to return (default 500, max 500). |
Advanced Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
at_after_hours_impact_report |
Pro | Read-only | [Autotask] Analyze after-hours ticket volume and impact. Returns ticket counts by source during business vs after-hours, helping identify patterns in off-hours support demand. Use for staffing decisions and after-hours coverage planning. |
at_contract_utilization |
Pro | Read-only | [Autotask] Contract hours used vs allocated. Returns utilization percentages, remaining hours, and burn rate for active contracts. Use for identifying contracts approaching their hour limits or underutilized agreements. |
at_csat_report |
Pro | Read-only | [Autotask] Customer satisfaction metrics from survey responses. Returns average CSAT scores, response rates, and trends over time. Use for identifying service quality issues and client satisfaction patterns. |
at_dispatch_optimizer |
Pro | Read-only | [Autotask] Rank resources for optimal ticket dispatch. Returns resources sorted by current workload, skill match, and availability. Use for efficient ticket assignment and workload balancing. |
at_escalation_analysis |
Pro | Read-only | [Autotask] Analyze escalation patterns for tickets in a date range. Returns escalation rates, resolution time differences between escalated and non-escalated tickets, and common escalation triggers. Use for identifying process improvement opportunities. |
at_first_response_time_analytics |
Pro | Read-only | [Autotask] Measure first response times for tickets in a date range. Returns average and median time-to-first-response, distribution by priority, and SLA compliance. Use for SLA and responsiveness assessment. |
at_sla_breach_alerts |
Pro | Read-only | [Autotask] Identify tickets at risk of SLA breach. Returns open tickets approaching or exceeding their SLA targets, sorted by urgency. Use for proactive SLA management and escalation prevention. |
at_sla_compliance_dashboard |
Pro | Read-only | [Autotask] SLA compliance metrics for tickets in a date range. Returns compliance rates, breach counts, and near-miss counts based on SLA response and resolution targets. Use for management reporting and service quality assessment. |
at_technician_utilization |
Pro | Read-only | [Autotask] Resource utilization metrics showing billable vs non-billable hours. Returns utilization percentages, hour breakdowns, and comparison against target. Use for capacity planning and performance reviews. |
at_timesheet_summary |
Pro | Read-only | [Autotask] Time entry aggregation for a date range. Returns total hours, billable/non-billable breakdown, and per-resource summaries. Use for payroll verification, billing reconciliation, and team productivity analysis. |
at_after_hours_impact_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (optional). Defaults to today. |
startDate |
string | no | null | Start date in yyyy-MM-dd format (optional). Defaults to 30 days ago. |
at_contract_utilization parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
contractId |
integer | no | null | Filter by specific contract ID (optional). Use at_list_contracts to find valid IDs. If omitted, returns all active contracts. |
at_csat_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
endDate |
string | no | null | End date in yyyy-MM-dd format (optional). Defaults to today. |
startDate |
string | no | null | Start date in yyyy-MM-dd format (optional). Defaults to 90 days ago. |
at_dispatch_optimizer parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
queueId |
integer | no | null | Filter by queue ID (optional). Limits analysis to resources associated with a specific queue. |
at_escalation_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
at_first_response_time_analytics parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
at_sla_breach_alerts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
warningMinutes |
integer | no | 60 | Warning threshold in minutes before SLA breach (default 60). Tickets within this window are flagged as at-risk. |
at_sla_compliance_dashboard parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. Defines the end of the analysis period. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. Defines the beginning of the analysis period. |
at_technician_utilization parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (optional). Defaults to today. |
resourceId |
integer | no | null | Filter by specific resource ID (optional). Use at_list_resources to find valid IDs. If omitted, returns all resources. |
startDate |
string | no | null | Start date in yyyy-MM-dd format (optional). Defaults to current month start. |
targetUtilization |
integer | no | 80 | Target utilization percentage (default 80). Used to flag under/over-utilized resources. |
at_timesheet_summary parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
endDate |
string | yes | End date in yyyy-MM-dd format. | |
resourceId |
integer | no | null | Filter by resource ID (optional). Use at_list_resources to find valid IDs. |
startDate |
string | yes | Start date in yyyy-MM-dd format. |
Premium Analytics
| Tool | Plan | Access | Description |
|---|---|---|---|
at_client_health_score |
Pro | Read-only | [Autotask] Composite 0-100 health score for a company based on ticket volume trends, resolution times, SLA compliance, and satisfaction. Returns the overall score with component breakdowns. Use for proactive client relationship management. |
at_contract_profitability_analysis |
Pro | Read-only | [Autotask] Analyze contract profitability by comparing revenue to labor cost. Returns revenue, estimated cost, margin, and effective hourly rate. Use to evaluate whether specific contracts are profitable. |
at_effective_hourly_rate |
Pro | Read-only | [Autotask] Calculate the effective hourly rate across billing for a date range. Compares actual revenue per hour worked against a target rate. Returns rate analysis per resource and contract. Use for pricing strategy validation. |
at_mrr_analysis |
Pro | Read-only | [Autotask] Monthly recurring revenue analysis from active contracts. Returns total MRR, per-contract breakdown, and trend over recent months. Use for financial forecasting and revenue reporting. |
at_qbr_data_pack |
Pro | Read-only | [Autotask] Quarterly Business Review data package for a company. Returns ticket metrics, resolution analytics, SLA compliance, time entry summaries, contract utilization, and satisfaction scores for the specified quarter. Use to prepare QBR presentations. |
at_revenue_leakage_scan |
Pro | Read-only | [Autotask] Detect unbilled time entries, missed charges, and other revenue leakage. Returns flagged items with estimated lost revenue. Use for billing reconciliation and ensuring all work is properly invoiced. |
at_scope_creep_detector |
Pro | Read-only | [Autotask] Detect out-of-scope work and scope creep across contracts and projects. Returns flagged time entries and charges that fall outside contracted scope, with estimated unbilled amounts. Use for contract compliance and billing accuracy. |
at_unprofitable_contracts |
Pro | Read-only | [Autotask] Identify contracts where labor cost exceeds revenue. Returns contract utilization data highlighting agreements that may need renegotiation or scope adjustment. Use for financial reviews and margin improvement. |
at_client_health_score parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID to score. Use at_list_companies to find valid IDs. | |
lookbackDays |
integer | no | 90 | Number of days to look back for analysis (default 90). |
at_contract_profitability_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
contractId |
integer | yes | The Autotask contract ID to analyze. Use at_list_contracts to find valid IDs. | |
hourlyRate |
number | no | 150 | Hourly cost rate for labor cost estimation (default 150.00). |
at_effective_hourly_rate parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | yes | End date in yyyy-MM-dd format. | |
startDate |
string | yes | Start date in yyyy-MM-dd format. | |
targetRate |
number | no | 150 | Target hourly rate for comparison (default 150.00). |
at_mrr_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
includeBreakdown |
boolean | no | true | Include per-contract MRR breakdown in results (default true). |
trendMonths |
integer | no | 6 | Number of months to include in trend analysis (default 6). |
at_qbr_data_pack parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. Use at_list_companies to find valid IDs. | |
quarterEnd |
string | yes | Quarter end date in yyyy-MM-dd format (e.g., 2025-03-31). | |
quarterStart |
string | yes | Quarter start date in yyyy-MM-dd format (e.g., 2025-01-01). |
at_revenue_leakage_scan parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
lookbackDays |
integer | no | 30 | Number of days to look back (default 30). |
at_scope_creep_detector parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
lookbackDays |
integer | no | 30 | Number of days to look back (default 30). |
at_unprofitable_contracts parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
hourlyRate |
number | no | 150 | Hourly cost rate for profitability calculation (default 150.00). |
Intelligence
| Tool | Plan | Access | Description |
|---|---|---|---|
at_client_offboarding_audit |
Pro | Read-only | [Autotask] Audit open items before client offboarding. Returns open tickets, active contracts, pending invoices, and configuration items that need attention before disengagement. Use for clean client separation. |
at_client_onboarding_checklist |
Pro | Read-only | [Autotask] Check onboarding completeness for a company. Returns setup status for contacts, sites, configuration items, contracts, and other essential data. Use for ensuring new clients are properly set up. |
at_client_risk_assessment |
Pro | Read-only | [Autotask] Assess risk factors for a client based on ticket trends, SLA compliance, satisfaction scores, and contract status. Returns a risk score with contributing factors. Use for proactive client retention and escalation prevention. |
at_company_360_view |
Pro | Read-only | [Autotask] Comprehensive 360-degree view of a company. Fetches company details, open tickets, active contracts, contacts, configuration items, and recent activity in a single composite call. Use for account reviews or before customer calls. |
at_contract_renewal_pipeline |
Pro | Read-only | [Autotask] List contracts approaching renewal or expiration. Returns contracts sorted by days until expiration with revenue impact. Use for proactive renewal management and revenue retention. |
at_daily_operations_briefing |
Pro | Read-only | [Autotask] Morning briefing with key operational metrics. Returns today's open tickets, SLA status, resource availability, overdue items, and priority escalations. Use as a daily standup summary or operations dashboard. |
at_kb_gap_analysis |
Pro | Read-only | [Autotask] Identify missing knowledge base topics by analyzing recurring ticket themes that lack KB articles. Returns topic clusters with ticket frequency and suggested KB article titles. Use for improving self-service and reducing repeat tickets. |
at_recurring_issue_detector |
Pro | Read-only | [Autotask] Detect recurring issues based on ticket patterns. Returns clusters of similar tickets with frequency, affected companies, and suggested remediation. Use for root cause analysis and proactive problem management. |
at_ticket_similarity_search |
Pro | Read-only | [Autotask] Find tickets similar to a given ticket based on title, description, and categorization. Returns matching tickets with resolution details to help resolve the current ticket faster. Use for knowledge reuse and faster resolution. |
at_ticket_triage_assist |
Pro | Read-only | [Autotask] Triage assistance for a ticket. Fetches ticket details, similar resolved tickets, and resource context to suggest assignment and priority. Returns the ticket, similar tickets, and recommended actions. Use for efficient ticket routing. |
at_unbilled_time_report |
Pro | Read-only | [Autotask] Identify unbilled time entries across companies and contracts. Returns time entries that have not been invoiced, with estimated revenue impact. Use for billing reconciliation and revenue recovery. |
at_client_offboarding_audit parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. Use at_list_companies to find valid IDs. |
at_client_onboarding_checklist parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. Use at_list_companies to find valid IDs. |
at_client_risk_assessment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. Use at_list_companies to find valid IDs. | |
lookbackMonths |
integer | no | 3 | Number of months to look back for analysis (default 3). |
at_company_360_view parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. Use at_list_companies to find valid IDs. |
at_contract_renewal_pipeline parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
daysAhead |
integer | no | 90 | Number of days ahead to look for expiring contracts (default 90). |
at_kb_gap_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lookbackDays |
integer | no | 30 | Number of days to look back for ticket analysis (default 30). |
at_recurring_issue_detector parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
lookbackDays |
integer | no | 30 | Number of days to look back (default 30). |
minOccurrences |
integer | no | 3 | Minimum occurrences to flag as recurring (default 3). |
at_ticket_similarity_search parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxResults |
integer | no | 10 | Maximum similar tickets to return (default 10). |
ticketId |
integer | yes | The Autotask ticket ID to find similar tickets for. |
at_ticket_triage_assist parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
ticketId |
integer | yes | The Autotask ticket ID to triage. |
at_unbilled_time_report parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | no | null | Filter by company ID (optional). Use at_list_companies to find valid IDs. |
contractId |
integer | no | null | Filter by contract ID (optional). Use at_list_contracts to find valid IDs. |
Cross-Domain
| Tool | Plan | Access | Description |
|---|---|---|---|
at_first_contact_resolution |
Pro | Read-only | [Autotask] Calculate first contact resolution (FCR) rate for tickets in a date range. Returns the percentage of tickets resolved on first contact, broken down by queue and priority. Use for measuring service desk efficiency. |
at_ticket_backlog_analysis |
Pro | Read-only | [Autotask] Deep analysis of the ticket backlog. Returns backlog size, age distribution, priority breakdown, queue distribution, and trend analysis. Use for operations reviews and backlog reduction planning. |
at_ticket_handoff_analysis |
Pro | Read-only | [Autotask] Analyze ticket reassignment patterns for tickets in a date range. Returns reassignment frequency, average handoffs per ticket, and impact on resolution time. Use for identifying routing inefficiencies and improving dispatch. |
at_time_entry_anomaly_scan |
Pro | Read-only | [Autotask] Detect unusual time entry patterns such as excessive hours, after-hours entries, or inconsistent logging. Returns flagged entries with anomaly descriptions. Use for timesheet auditing and compliance. |
at_first_contact_resolution parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (optional). Defaults to today. |
startDate |
string | no | null | Start date in yyyy-MM-dd format (optional). Defaults to 30 days ago. |
at_ticket_handoff_analysis parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
endDate |
string | no | null | End date in yyyy-MM-dd format (optional). Defaults to today. |
startDate |
string | no | null | Start date in yyyy-MM-dd format (optional). Defaults to 30 days ago. |
at_time_entry_anomaly_scan parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
lookbackDays |
integer | no | 30 | Number of days to look back (default 30). |
resourceId |
integer | no | null | Filter by resource ID (optional). Use at_list_resources to find valid IDs. |
Resource Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_comanaged_association |
Pro | Write | [Autotask] Create a new co-managed association between a resource and a company. Returns the created record with its assigned ID. |
at_create_resource_service_desk_role |
Pro | Write | [Autotask] Create a new service desk role assignment for a resource. Returns the created record with its assigned ID. |
at_delete_comanaged_association |
Pro | Write | [Autotask] Delete a co-managed association by its numeric ID. This permanently removes the association. |
at_list_additional_resource_time_off |
Free | Read-only | [Autotask] Query additional time off records for resources beyond standard requests. Returns supplemental time off data. Use filterJson to narrow by resourceID. |
at_list_client_portal_users |
Free | Read-only | [Autotask] Query client portal user records. Returns portal user details including username, contact association, and security level. Use filterJson for advanced queries. |
at_list_comanaged_associations |
Free | Read-only | [Autotask] Query co-managed association records. Returns associations between resources and co-managed companies. Use filterJson to narrow by resourceID or companyID. |
at_list_resource_attachments |
Free | Read-only | [Autotask] Query attachment records associated with resources. Returns attachment metadata including filename, size, and content type. Use filterJson to narrow by parentID (resource ID). |
at_list_resource_daily_availability |
Free | Read-only | [Autotask] Query daily availability records for resources. Returns availability data including scheduled hours, time off, and capacity. Use filterJson to narrow by resourceID or date range. |
at_list_resource_role_departments |
Free | Read-only | [Autotask] Query resource role department assignments. Returns mappings between resources, roles, and departments. Use filterJson to narrow by resourceID or departmentID. |
at_list_resource_role_queues |
Free | Read-only | [Autotask] Query resource role queue assignments. Returns mappings between resources, roles, and queues. Use filterJson to narrow by resourceID or queueID. |
at_list_resource_service_desk_roles |
Free | Read-only | [Autotask] Query service desk role assignments for resources. Returns role-to-resource mappings including queue and default role settings. Use filterJson to narrow by resourceID. |
at_list_resource_time_off_balances |
Free | Read-only | [Autotask] Query time off balance records for resources. Returns balance details including accrued, used, and remaining hours by time off policy. Use filterJson to narrow by resourceID. |
at_list_time_off_request_approvers |
Free | Read-only | [Autotask] Query time off request approver records. Returns approver assignments including resource and approver resource IDs. Use filterJson to narrow by resourceID. |
at_create_comanaged_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the co-managed association to create. Include resourceID and companyID. |
at_create_resource_service_desk_role parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the resource service desk role to create. Include resourceID and roleID. |
at_delete_comanaged_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
associationId |
integer | yes | The numeric Autotask co-managed association ID to delete. |
at_list_additional_resource_time_off parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_client_portal_users parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"contactID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_comanaged_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_daily_availability parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_role_departments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_role_queues parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_service_desk_roles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_resource_time_off_balances parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_time_off_request_approvers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"resourceID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Time Off Requests
| Tool | Plan | Access | Description |
|---|---|---|---|
at_approve_time_off_request |
Pro | Write | [Autotask] Approve a pending time off request by its numeric ID. Returns the approval result. Only works on requests in a pending approval status. |
at_count_time_off_requests |
Free | Read-only | [Autotask] Count time off requests matching optional filters. Returns the total number of matching requests without fetching data. |
at_create_time_off_request |
Pro | Write | [Autotask] Create a new time off request. Returns the created request with its assigned ID. Include resourceID, startDateTime, endDateTime, and timeOffPolicyID. |
at_get_time_off_request |
Free | Read-only | [Autotask] Retrieve a single time off request by its numeric ID. Returns full details including resource, dates, hours, status, and approval information. |
at_list_resource_time_off_requests |
Free | Read-only | [Autotask] List time off requests for a specific resource. Filters by resourceID. Use this to view a technician's time off history and pending requests. |
at_list_time_off_requests |
Free | Read-only | [Autotask] Query time off requests with optional filters. Returns paginated time off request summaries including status, dates, and hours. Use filterJson for advanced queries. |
at_reject_time_off_request |
Pro | Write | [Autotask] Reject a pending time off request by its numeric ID with a reason. Returns the rejection result. Only works on requests in a pending approval status. |
at_update_time_off_request |
Pro | Write | [Autotask] Update an existing time off request. The id field is automatically included. Returns the updated request. |
at_approve_time_off_request parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
timeOffRequestId |
integer | yes | The numeric Autotask time off request ID to approve. |
at_count_time_off_requests parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Omit for no filtering. |
at_create_time_off_request parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the time off request to create. Include resourceID, startDateTime, endDateTime, and timeOffPolicyID. |
at_get_time_off_request parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
timeOffRequestId |
integer | yes | The numeric Autotask time off request ID. |
at_list_resource_time_off_requests parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
resourceId |
integer | yes | The Autotask resource ID to list time off requests for. |
at_list_time_off_requests parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"status","value":1}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_reject_time_off_request parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
rejectionReason |
string | yes | Reason for rejecting the time off request. | |
timeOffRequestId |
integer | yes | The numeric Autotask time off request ID to reject. |
at_update_time_off_request parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"status":2}. | |
timeOffRequestId |
integer | yes | The numeric Autotask time off request ID to update. |
Task Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_task_note |
Pro | Write | [Autotask] Create a new note on a project task. Returns the created note with its assigned ID. |
at_create_task_predecessor |
Pro | Write | [Autotask] Create a new task predecessor dependency. Returns the created dependency record with its assigned ID. |
at_create_task_secondary_resource |
Pro | Write | [Autotask] Assign an additional resource to a task. Returns the created assignment record with its assigned ID. |
at_delete_task_predecessor |
Pro | Write | [Autotask] Delete a task predecessor dependency by its numeric ID. This permanently removes the dependency. |
at_delete_task_secondary_resource |
Pro | Write | [Autotask] Remove a secondary resource assignment from a task by its numeric ID. This permanently removes the assignment. |
at_get_task_note |
Free | Read-only | [Autotask] Retrieve a single task note by its numeric ID. Returns full note details including title, description, creator, and timestamps. |
at_list_task_attachments |
Free | Read-only | [Autotask] Query attachment records associated with tasks. Returns attachment metadata including filename, size, and content type. Use filterJson to narrow by parentID (task ID). |
at_list_task_notes |
Free | Read-only | [Autotask] Query notes on project tasks. Returns note details including title, description, and creator. Use filterJson to narrow by taskID. |
at_list_task_predecessors |
Free | Read-only | [Autotask] Query task predecessor relationships. Returns dependency links between tasks including lag time. Use filterJson to narrow by successorTaskID or predecessorTaskID. |
at_list_task_secondary_resources |
Free | Read-only | [Autotask] Query secondary resource assignments on tasks. Returns additional resource assignments beyond the primary. Use filterJson to narrow by taskID or resourceID. |
at_update_task_note |
Pro | Write | [Autotask] Update an existing task note. The id field is automatically included. Returns the updated note. |
at_create_task_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the task note to create. Include taskID and description. |
at_create_task_predecessor parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the task predecessor to create. Include predecessorTaskID and successorTaskID. |
at_create_task_secondary_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object for the task secondary resource to create. Include taskID and resourceID. |
at_delete_task_predecessor parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskPredecessorId |
integer | yes | The numeric Autotask task predecessor ID to delete. |
at_delete_task_secondary_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskSecondaryResourceId |
integer | yes | The numeric Autotask task secondary resource ID to delete. |
at_get_task_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
taskNoteId |
integer | yes | The numeric Autotask task note ID. |
at_list_task_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"parentID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_task_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. When provided, typed filter params are ignored. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
taskId |
integer | no | null | Filter by task ID. |
at_list_task_predecessors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"successorTaskID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_task_secondary_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array. Example: [{"op":"eq","field":"taskID","value":123}] |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_task_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Example: {"description":"Updated note"}. | |
taskNoteId |
integer | yes | The numeric Autotask task note ID to update. |
Webhooks
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_webhook |
Pro | Write | [Autotask] Create a new webhook for a specific entity type. Requires webhook configuration data including URL and event types. |
at_create_webhook_field |
Pro | Write | [Autotask] Add a field to a webhook tracked fields. When this field changes on the entity, the webhook will fire. |
at_create_webhook_udf_field |
Pro | Write | [Autotask] Add a user-defined field to a webhook tracked UDF fields. When this UDF changes on the entity, the webhook will fire. |
at_delete_webhook |
Pro | Write | [Autotask] Delete a webhook by its numeric ID and entity type. This permanently removes the webhook configuration. |
at_delete_webhook_field |
Pro | Write | [Autotask] Remove a field from a webhook tracked fields. The webhook will no longer fire when this field changes. Requires the parent webhook ID -- use at_list_webhooks to find it. |
at_delete_webhook_udf_field |
Pro | Write | [Autotask] Remove a user-defined field from a webhook tracked UDF fields. Requires the parent webhook ID -- use at_list_webhooks to find it. |
at_get_webhook |
Free | Read-only | [Autotask] Retrieve a single webhook by its numeric ID and entity type. Returns full webhook configuration details. |
at_list_webhook_error_logs |
Free | Read-only | [Autotask] Query webhook event error logs. Returns error details for failed webhook deliveries including error messages, timestamps, and related webhook IDs. |
at_list_webhook_excluded_resources |
Free | Read-only | [Autotask] List resources excluded from triggering a specific webhook. Returns resources whose changes will not fire the webhook. |
at_list_webhook_fields |
Free | Read-only | [Autotask] List fields configured for a specific webhook. Returns the fields that trigger webhook notifications when changed. |
at_list_webhook_udf_fields |
Free | Read-only | [Autotask] List user-defined fields (UDFs) configured for a specific webhook. Returns the UDF fields that trigger webhook notifications when changed. |
at_list_webhooks |
Free | Read-only | [Autotask] Query webhooks for a specific entity type. Returns paginated webhook configurations including ID, name, URL, and active status. Supported entity types: Company, ConfigurationItem, Contact, Ticket, TicketNote. |
at_manage_webhook_excluded_resource |
Pro | Write | [Autotask] Create or delete an excluded resource for a webhook. Use action create with dataJson to add, or action delete with excludedResourceId to remove. |
at_update_webhook |
Pro | Write | [Autotask] Update an existing webhook via PATCH. Provide the entity type and a JSON object with the id field and fields to update. |
at_create_webhook parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with webhook configuration. Must include fields like deactivationUrl, name, webhookUrl, etc. | |
entityType |
string | yes | The entity type to create the webhook for. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. |
at_create_webhook_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with field configuration. Must include the fieldID to track. | |
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
webhookId |
integer | yes | The numeric Autotask webhook ID. |
at_create_webhook_udf_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with UDF field configuration. Must include the udfFieldID to track. | |
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
webhookId |
integer | yes | The numeric Autotask webhook ID. |
at_delete_webhook parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
id |
integer | yes | The numeric Autotask webhook ID to delete. |
at_delete_webhook_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
fieldId |
integer | yes | The numeric Autotask webhook field ID to delete. | |
webhookId |
integer | yes | The numeric Autotask webhook ID that owns the field. |
at_delete_webhook_udf_field parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
fieldId |
integer | yes | The numeric Autotask webhook UDF field ID to delete. | |
webhookId |
integer | yes | The numeric Autotask webhook ID that owns the UDF field. |
at_get_webhook parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
id |
integer | yes | The numeric Autotask webhook ID. |
at_list_webhook_error_logs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_webhook_excluded_resources parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
webhookId |
integer | yes | The numeric Autotask webhook ID. |
at_list_webhook_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
webhookId |
integer | yes | The numeric Autotask webhook ID. |
at_list_webhook_udf_fields parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
webhookId |
integer | yes | The numeric Autotask webhook ID. |
at_list_webhooks parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
entityType |
string | yes | The entity type to query webhooks for. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_manage_webhook_excluded_resource parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
action |
string | yes | The action to perform: create or delete. | |
dataJson |
string | no | null | JSON object with excluded resource data (required for create). Must include the resourceID. |
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. | |
excludedResourceId |
integer | no | null | The numeric excluded resource ID to delete (required for delete). |
webhookId |
integer | no | null | The numeric Autotask webhook ID that owns the excluded resource (required for both create and delete). |
at_update_webhook parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with the id field and fields to update. | |
entityType |
string | yes | The entity type the webhook belongs to. Valid values: Company, ConfigurationItem, Contact, Ticket, TicketNote. |
Change Management
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_change_order_charge |
Pro | Write | [Autotask] Create a new charge on a change order. Requires change order ID and charge details. Returns the created charge record with its assigned ID. |
at_create_change_request_link |
Pro | Write | [Autotask] Create a new link between a change request and another entity. Returns the created link record with its assigned ID. |
at_delete_change_order_charge |
Pro | Write | [Autotask] Delete a change order charge by its numeric ID. This permanently removes the charge from the change order. |
at_delete_change_request_link |
Pro | Write | [Autotask] Delete a change request link by its numeric ID. This permanently removes the link between the change request and the target entity. |
at_list_change_order_charges |
Free | Read-only | [Autotask] Query change order charges with optional filters. Returns paginated charge records associated with change orders including amount, billing code, and description. |
at_list_change_request_links |
Free | Read-only | [Autotask] Query change request links with optional filters. Returns links between change requests and other entities such as tickets or configuration items. |
at_list_sla_results |
Free | Read-only | [Autotask] Query service level agreement results with optional filters. Returns SLA compliance data including target metrics, actual metrics, and pass/fail status for tickets. |
at_update_change_order_charge |
Pro | Write | [Autotask] Update an existing change order charge via PATCH. Provide a JSON object with the id field and fields to update. Returns the updated charge record. |
at_create_change_order_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with charge data. Must include changeOrderID, billingCodeID, and other required fields. |
at_create_change_request_link parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with link data. Must include changeRequestTicketID and the target entity reference. |
at_delete_change_order_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask change order charge ID to delete. |
at_delete_change_request_link parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask change request link ID to delete. |
at_list_change_order_charges parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_change_request_links parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_sla_results parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_change_order_charge parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with the id field and fields to update. |
Document Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_document_category |
Pro | Write | [Autotask] Create a new document category. Returns the created category with its assigned ID. |
at_create_document_checklist_item |
Pro | Write | [Autotask] Create a new checklist item within a document. Returns the created checklist item with its assigned ID. |
at_create_document_note |
Pro | Write | [Autotask] Create a new note on a document. Returns the created note with its assigned ID. |
at_create_document_tag_association |
Pro | Write | [Autotask] Create a new tag association on a document. Returns the created association with its assigned ID. |
at_create_document_ticket_association |
Pro | Write | [Autotask] Create a new association between a document and a ticket. Returns the created association with its assigned ID. |
at_delete_document_category |
Pro | Write | [Autotask] Delete a document category by its numeric ID. This permanently removes the category. |
at_delete_document_ticket_association |
Pro | Write | [Autotask] Delete an association between a document and a ticket by its numeric ID. Removes the link but does not delete the document or ticket. |
at_get_document_plain_text |
Free | Read-only | [Autotask] Query the plain text content of documents. Returns the extracted text content from documents, useful for searching and indexing. |
at_list_checklist_libraries |
Free | Read-only | [Autotask] Query checklist libraries with optional filters. Returns available checklist templates that can be applied to documents. |
at_list_document_attachments |
Free | Read-only | [Autotask] Query file attachments associated with documents. Returns attachment metadata including file name, size, and content type. |
at_list_document_categories |
Free | Read-only | [Autotask] Query document categories with optional filters. Returns available categories used to organize and classify documents. |
at_list_document_checklist_items |
Free | Read-only | [Autotask] Query checklist items within documents. Returns checklist item details including text, completion status, and sort order. |
at_list_document_ci_associations |
Free | Read-only | [Autotask] Query associations between documents and configuration items. Returns link records showing which documents are attached to which CIs. |
at_list_document_notes |
Free | Read-only | [Autotask] Query notes attached to documents with optional filters. Returns note content, author, and timestamps. |
at_list_document_tag_associations |
Free | Read-only | [Autotask] Query tag associations on documents. Returns which tags are applied to which documents. |
at_list_document_ticket_associations |
Free | Read-only | [Autotask] Query associations between documents and tickets. Returns link records showing which documents are attached to which tickets. |
at_create_document_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with category data. Must include name field. |
at_create_document_checklist_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with checklist item data. Must include documentID and itemName fields. |
at_create_document_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with note data. Must include documentID and noteText fields. |
at_create_document_tag_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with tag association data. Must include documentID and tagID fields. |
at_create_document_ticket_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with association data. Must include documentID and ticketID fields. |
at_delete_document_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask document category ID to delete. |
at_delete_document_ticket_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask document-ticket association ID to delete. |
at_get_document_plain_text parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_checklist_libraries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_checklist_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_ci_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_tag_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_document_ticket_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Knowledge Base Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_kb_article_note |
Pro | Write | [Autotask] Create a new note on a knowledge base article. Returns the created note with its assigned ID. |
at_create_kb_article_tag_association |
Pro | Write | [Autotask] Create a new tag association on a knowledge base article. Returns the created association with its assigned ID. |
at_create_kb_article_ticket_association |
Pro | Write | [Autotask] Create a new association between a knowledge base article and a ticket. Returns the created association with its assigned ID. |
at_create_kb_category |
Pro | Write | [Autotask] Create a new knowledge base category. Returns the created category with its assigned ID. |
at_delete_kb_article_tag_association |
Pro | Write | [Autotask] Delete a tag association from a knowledge base article by its numeric ID. |
at_delete_kb_article_ticket_association |
Pro | Write | [Autotask] Delete an association between a knowledge base article and a ticket by its numeric ID. |
at_delete_kb_category |
Pro | Write | [Autotask] Delete a knowledge base category by its numeric ID. This permanently removes the category. |
at_get_kb_article_plain_text |
Free | Read-only | [Autotask] Query the plain text content of knowledge base articles. Returns extracted text content useful for searching and indexing. |
at_list_kb_article_attachments |
Free | Read-only | [Autotask] Query file attachments associated with knowledge base articles. Returns attachment metadata including file name, size, and content type. |
at_list_kb_article_document_associations |
Free | Read-only | [Autotask] Query associations between knowledge base articles and documents. Returns link records showing which articles are related to which documents. |
at_list_kb_article_notes |
Free | Read-only | [Autotask] Query notes attached to knowledge base articles with optional filters. Returns note content, author, and timestamps. |
at_list_kb_article_tag_associations |
Free | Read-only | [Autotask] Query tag associations on knowledge base articles. Returns which tags are applied to which articles. |
at_list_kb_article_ticket_associations |
Free | Read-only | [Autotask] Query associations between knowledge base articles and tickets. Returns link records showing which articles are related to which tickets. |
at_list_kb_categories |
Free | Read-only | [Autotask] Query knowledge base categories with optional filters. Returns available categories used to organize KB articles. |
at_create_kb_article_note parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with note data. Must include knowledgeBaseArticleID and noteText fields. |
at_create_kb_article_tag_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with tag association data. Must include knowledgeBaseArticleID and tagID fields. |
at_create_kb_article_ticket_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with association data. Must include knowledgeBaseArticleID and ticketID fields. |
at_create_kb_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
dataJson |
string | yes | JSON object with category data. Must include name field. |
at_delete_kb_article_tag_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask article-tag association ID to delete. |
at_delete_kb_article_ticket_association parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask article-ticket association ID to delete. |
at_delete_kb_category parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
id |
integer | yes | The numeric Autotask knowledge base category ID to delete. |
at_get_kb_article_plain_text parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_article_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_article_document_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_article_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_article_tag_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_article_ticket_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_kb_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | Raw Autotask filter JSON array for advanced queries. |
maxRecords |
integer | no | 500 | Maximum number of results to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Contract Extended
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_contract_exclusion_set |
Pro | Write | [Autotask] Create a new contract exclusion set. Returns the created exclusion set with its assigned ID. Used to define which roles or work types are excluded from billing on a contract. |
at_create_contract_service_adjustment |
Pro | Write | [Autotask] Create a new service adjustment on a contract. Returns the created adjustment with its assigned ID. |
at_create_contract_ticket_purchase |
Pro | Write | [Autotask] Create a new ticket purchase on a contract. Returns the created purchase with its assigned ID. |
at_delete_contract_exclusion_set |
Pro | Write | [Autotask] Delete a contract exclusion set by ID. Returns a confirmation response. This permanently removes the exclusion set. |
at_list_billing_item_approval_levels |
Free | Read-only | [Autotask] List billing item approval levels. Returns approval level details including level, approver, and status. |
at_list_contract_block_hour_factors |
Free | Read-only | [Autotask] List block hour factors for contracts. Returns factor details including role, factor value, and contract association. Useful for understanding hour multipliers on block-hour contracts. |
at_list_contract_excluded_roles |
Free | Read-only | [Autotask] List roles excluded from a contract exclusion set. Returns details about which roles are excluded from billing under the contract. |
at_list_contract_excluded_work_types |
Free | Read-only | [Autotask] List work types excluded from a contract exclusion set. Returns details about which work types are excluded from billing under the contract. |
at_list_contract_exclusion_sets |
Free | Read-only | [Autotask] List contract exclusion sets with optional filters. Returns exclusion set details including name, description, and linked contract. Useful for understanding which services or work types are excluded from a contract. |
at_list_contract_role_costs |
Free | Read-only | [Autotask] List role cost overrides for contracts. Returns cost details including role, cost rate, and contract association. Useful for profitability analysis on managed services contracts. |
at_list_contract_service_adjustments |
Free | Read-only | [Autotask] List service adjustments on contracts. Returns adjustment details including service, adjustment amount, and effective dates. |
at_list_contract_service_bundle_units |
Free | Read-only | [Autotask] List service bundle units on contracts. Returns bundle unit details including bundle, quantity, and period. |
at_list_contract_service_units |
Free | Read-only | [Autotask] List service units on contracts. Returns unit details including service, quantity, and period. |
at_list_contract_ticket_purchases |
Free | Read-only | [Autotask] List ticket purchases on contracts. Returns purchase details including quantity, amount, and effective dates. |
at_list_subscription_periods |
Free | Read-only | [Autotask] List subscription periods with optional filters. Returns period details including start/end dates, amount, and status. |
at_update_contract_exclusion_set |
Pro | Write | [Autotask] Update an existing contract exclusion set. Returns the updated exclusion set. The JSON must include the id field. |
at_create_contract_exclusion_set parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the exclusion set to create. Example: {"contractID":12345,"name":"Standard Exclusions"}. |
at_create_contract_service_adjustment parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the service adjustment to create. |
at_create_contract_ticket_purchase parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the ticket purchase to create. |
at_delete_contract_exclusion_set parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
exclusionSetId |
integer | yes | The Autotask exclusion set ID to delete. |
at_list_billing_item_approval_levels parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_block_hour_factors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_excluded_roles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_excluded_work_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_exclusion_sets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_role_costs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_service_adjustments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_service_bundle_units parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_service_units parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_contract_ticket_purchases parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_subscription_periods parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_contract_exclusion_set parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
exclusionSetId |
integer | yes | The Autotask exclusion set ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Example: {"name":"Updated Exclusions"}. |
Invoice Extended
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_company_invoice_settings |
Free | Read-only | [Autotask] Retrieve invoice settings for a specific company. Returns invoice configuration including template, payment terms, and delivery preferences. |
at_get_invoice_html |
Free | Read-only | [Autotask] Retrieve the rendered HTML markup for an invoice. Returns the invoice content formatted as HTML. |
at_get_invoice_pdf |
Free | Read-only | [Autotask] Retrieve the PDF content for an invoice. Returns the invoice as a PDF document (may be base64-encoded). |
at_get_invoice_xml |
Free | Read-only | [Autotask] Retrieve the rendered XML markup for an invoice. Returns the invoice content formatted as XML. |
at_list_additional_invoice_field_values |
Free | Read-only | [Autotask] List additional invoice field values with optional filters. Returns custom field values associated with invoices. |
at_list_invoice_templates |
Free | Read-only | [Autotask] List available invoice templates. Returns template details including name and format. |
at_list_quote_items |
Free | Read-only | [Autotask] List quote line items with optional filters. Returns item details including product, quantity, unit price, and total. |
at_list_quote_locations |
Free | Read-only | [Autotask] List quote locations with optional filters. Returns location details associated with quotes. |
at_list_quote_templates |
Free | Read-only | [Autotask] List available quote templates. Returns template details including name and format. |
at_update_billing_item |
Pro | Write | [Autotask] Update an existing billing item via PATCH. Returns the updated billing item. |
at_update_company_invoice_settings |
Pro | Write | [Autotask] Update invoice settings for a specific company via PUT. Returns the updated settings. |
at_update_invoice |
Pro | Write | [Autotask] Update an existing invoice via PUT. Provide the invoice ID and a JSON object of fields to update. Returns the updated invoice. |
at_get_company_invoice_settings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. |
at_get_invoice_html parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId |
integer | yes | The Autotask invoice ID. |
at_get_invoice_pdf parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId |
integer | yes | The Autotask invoice ID. |
at_get_invoice_xml parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
invoiceId |
integer | yes | The Autotask invoice ID. |
at_list_additional_invoice_field_values parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_invoice_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_quote_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_quote_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_quote_templates parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_billing_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
billingItemId |
integer | yes | The Autotask billing item ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. Field names must match Autotask API field names. |
at_update_company_invoice_settings parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
companyId |
integer | yes | The Autotask company ID. | |
fieldsJson |
string | yes | JSON object with settings to update. Example: {"paymentTermID":2,"invoiceTemplateID":5}. |
at_update_invoice parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. Field names must match Autotask API field names. | |
invoiceId |
integer | yes | The Autotask invoice ID to update. |
Inventory
| Tool | Plan | Access | Description |
|---|---|---|---|
at_add_inventory_stock |
Pro | Write | [Autotask] Add stock to an inventory product. Posts to the StockedItemsAdd child endpoint. |
at_create_inventory_location |
Pro | Write | [Autotask] Create a new inventory location. Returns the created location with its assigned ID. |
at_create_purchase_order_item |
Pro | Write | [Autotask] Create a new line item on a purchase order. Returns the created item with its assigned ID. |
at_get_inventory_item |
Free | Read-only | [Autotask] Retrieve full details for a single inventory item by ID. |
at_list_inventory_items |
Free | Read-only | [Autotask] List inventory items with optional filters. Returns item details including product, location, quantity, and serial number. |
at_list_inventory_locations |
Free | Read-only | [Autotask] List inventory locations (warehouses, stock rooms). |
at_list_inventory_products |
Free | Read-only | [Autotask] List inventory products with optional filters. |
at_list_inventory_serial_numbers |
Free | Read-only | [Autotask] List inventory item serial numbers with optional filters. |
at_list_inventory_stocked_items |
Free | Read-only | [Autotask] List stocked items in inventory. |
at_list_inventory_transfers |
Free | Read-only | [Autotask] List inventory transfers with optional filters. |
at_list_product_notes |
Free | Read-only | [Autotask] List notes associated with products. Returns note details including title, description, and creation date. |
at_list_product_tiers |
Free | Read-only | [Autotask] List product pricing tiers. Returns tier details including quantity ranges and unit prices. |
at_list_product_vendors |
Free | Read-only | [Autotask] List product-vendor associations. Returns vendor details for each product. |
at_list_purchase_approvals |
Free | Read-only | [Autotask] List purchase approvals with optional filters. |
at_list_purchase_order_items |
Free | Read-only | [Autotask] List purchase order line items with optional filters. |
at_remove_inventory_stock |
Pro | Write | [Autotask] Remove stock from an inventory product. Posts to the StockedItemsRemove child endpoint. |
at_transfer_inventory_stock |
Pro | Write | [Autotask] Transfer stock between inventory locations. Posts to the StockedItemsTransfer child endpoint. |
at_update_purchase_order_item |
Pro | Write | [Autotask] Update an existing purchase order line item. Returns the updated item. |
at_add_inventory_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with stock details. | |
productId |
integer | yes | The Autotask inventory product ID to add stock to. |
at_create_inventory_location parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the location to create. |
at_create_purchase_order_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the PO item to create. |
at_get_inventory_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
inventoryItemId |
integer | yes | The Autotask inventory item ID. |
at_list_inventory_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_inventory_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_inventory_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_inventory_serial_numbers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_inventory_stocked_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_inventory_transfers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_product_notes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_product_tiers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_product_vendors parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_purchase_approvals parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_purchase_order_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_remove_inventory_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with removal details. | |
productId |
integer | yes | The Autotask inventory product ID to remove stock from. |
at_transfer_inventory_stock parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with transfer details. | |
productId |
integer | yes | The Autotask inventory product ID to transfer stock for. |
at_update_purchase_order_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. | |
itemId |
integer | yes | The Autotask purchase order item ID to update. |
Tags
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_tag |
Pro | Write | [Autotask] Create a new tag. Returns the created tag with its assigned ID. |
at_create_tag_alias |
Pro | Write | [Autotask] Create a new tag alias. Aliases provide alternative names for existing tags. |
at_create_tag_group |
Pro | Write | [Autotask] Create a new tag group. Returns the created group with its assigned ID. |
at_delete_tag |
Pro | Write | [Autotask] Delete a tag by ID. This permanently removes the tag and any entity associations. |
at_get_tag |
Free | Read-only | [Autotask] Retrieve full details for a single tag by ID. |
at_list_tag_aliases |
Free | Read-only | [Autotask] List tag aliases with optional filters. Tag aliases allow alternative names for tags. |
at_list_tag_groups |
Free | Read-only | [Autotask] List tag groups with optional filters. Tag groups organize related tags. |
at_list_tags |
Free | Read-only | [Autotask] List tags with optional filters. Tags are used to categorize and organize entities across Autotask. |
at_update_tag |
Pro | Write | [Autotask] Update an existing tag. Returns the updated tag. |
at_update_tag_group |
Pro | Write | [Autotask] Update an existing tag group. Returns the updated group. |
at_create_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the tag to create. |
at_create_tag_alias parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the tag alias to create. |
at_create_tag_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the tag group to create. |
at_delete_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
tagId |
integer | yes | The Autotask tag ID to delete. |
at_get_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
tagId |
integer | yes | The Autotask tag ID. |
at_list_tag_aliases parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_tag_groups parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_tags parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_tag parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. | |
tagId |
integer | yes | The Autotask tag ID to update. |
at_update_tag_group parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. | |
tagGroupId |
integer | yes | The Autotask tag group ID to update. |
Opportunity/Sales Sub-Resources
| Tool | Plan | Access | Description |
|---|---|---|---|
at_list_opportunity_attachments |
Free | Read-only | [Autotask] List attachments associated with opportunities. |
at_list_opportunity_categories |
Free | Read-only | [Autotask] List opportunity categories. Returns category details including name and description. |
at_list_opportunity_sales_orders |
Free | Read-only | [Autotask] List sales orders associated with a specific opportunity. |
at_list_sales_order_attachments |
Free | Read-only | [Autotask] List attachments associated with sales orders. |
at_list_opportunity_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_opportunity_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_opportunity_sales_orders parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
opportunityId |
integer | yes | The Autotask opportunity ID to list sales orders for. |
at_list_sales_order_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Org Structure
| Tool | Plan | Access | Description |
|---|---|---|---|
at_get_internal_location_business_hours |
Free | Read-only | [Autotask] Retrieve business hours for internal locations. Returns schedule including days and time ranges. |
at_get_role |
Free | Read-only | [Autotask] Retrieve full details for a single role by ID. |
at_list_action_types |
Free | Read-only | [Autotask] List action types with optional filters. Action types categorize activities and time entries. |
at_list_classification_icons |
Free | Read-only | [Autotask] List classification icons with optional filters. Classification icons visually categorize companies and contacts. |
at_list_holiday_sets |
Free | Read-only | [Autotask] List holiday sets with optional filters. Holiday sets define groups of holidays used for scheduling and SLA calculations. |
at_list_holidays |
Free | Read-only | [Autotask] List holidays with optional filters. Useful for reviewing scheduled holidays that affect SLA and business hour calculations. |
at_list_internal_locations |
Free | Read-only | [Autotask] List internal (office) locations with optional filters. Internal locations represent your company offices. |
at_list_org_level_associations |
Free | Read-only | [Autotask] List organizational level associations. Returns associations linking resources or entities to organizational levels. |
at_list_organizational_level2s |
Free | Read-only | [Autotask] List second-level organizational levels. These are subdivisions within top-level organizational levels. |
at_list_organizational_levels |
Free | Read-only | [Autotask] List top-level organizational levels (Level 1). Organizational levels define your company hierarchy. |
at_list_roles |
Free | Read-only | [Autotask] List roles with optional filters. Roles define billing rates and are used for time entry and contract rate assignments. |
at_list_skills |
Free | Read-only | [Autotask] List skills with optional filters. Skills are assigned to resources for competency tracking. |
at_get_internal_location_business_hours parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_get_role parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
roleId |
integer | yes | The Autotask role ID. |
at_list_action_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_classification_icons parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_holiday_sets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_holidays parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_internal_locations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_org_level_associations parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_organizational_level2s parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_organizational_levels parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_roles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_skills parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Financial Config
| Tool | Plan | Access | Description |
|---|---|---|---|
at_list_countries |
Free | Read-only | [Autotask] List countries configured in Autotask. Returns country details including name, ISO code, and active status. |
at_list_currencies |
Free | Read-only | [Autotask] List currencies configured in Autotask. Returns currency details including code, name, and exchange rate. |
at_list_domain_registrars |
Free | Read-only | [Autotask] List domain registrars configured in Autotask. Useful for domain management tracking. |
at_list_payment_terms |
Free | Read-only | [Autotask] List payment terms configured in Autotask. Payment terms define invoice due date calculations (e.g., Net 30). |
at_list_price_list_products |
Free | Read-only | [Autotask] List price list entries for products. Returns product pricing details. |
at_list_price_list_roles |
Free | Read-only | [Autotask] List price list entries for roles. Returns role pricing details including hourly rate. |
at_list_price_list_services |
Free | Read-only | [Autotask] List price list entries for services. Returns service pricing details. |
at_list_shipping_types |
Free | Read-only | [Autotask] List shipping types configured in Autotask. Used when creating purchase orders and sales orders. |
at_list_tax_categories |
Free | Read-only | [Autotask] List tax categories configured in Autotask. Tax categories group products and services for tax calculation. |
at_list_tax_regions |
Free | Read-only | [Autotask] List tax regions configured in Autotask. Tax regions define geographic areas with specific tax rules. |
at_list_taxes |
Free | Read-only | [Autotask] List individual tax entries with optional filters. Returns tax details including name, rate, and region. |
at_list_work_type_modifiers |
Free | Read-only | [Autotask] List work type modifiers with optional filters. Work type modifiers adjust billing rates (e.g., overtime). |
at_list_countries parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_currencies parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_domain_registrars parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_payment_terms parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_price_list_products parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_price_list_roles parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_price_list_services parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_shipping_types parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_tax_categories parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_tax_regions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_taxes parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_work_type_modifiers parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
Admin
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_udf_definition |
Pro | Write | [Autotask] Create a new user-defined field definition. Returns the created UDF with its assigned ID. |
at_list_deleted_task_activity_logs |
Free | Read-only | [Autotask] List deleted task activity log entries with optional filters. Useful for project audit trails. |
at_list_deleted_ticket_activity_logs |
Free | Read-only | [Autotask] List deleted ticket activity log entries with optional filters. Useful for audit trails. |
at_list_deleted_ticket_logs |
Free | Read-only | [Autotask] List deleted ticket log entries with optional filters. Useful for audit trails and compliance. |
at_list_integration_vendor_insights |
Free | Read-only | [Autotask] List integration vendor insights with optional filters. Returns insight data from third-party integrations. |
at_list_integration_vendor_widgets |
Free | Read-only | [Autotask] List integration vendor widgets with optional filters. Returns widget configuration data from integrations. |
at_list_notification_history |
Free | Read-only | [Autotask] List notification history with optional filters. Useful for auditing email and alert delivery. |
at_list_udf_definitions |
Free | Read-only | [Autotask] List user-defined field (UDF) definitions with optional filters. Returns UDF details including name, data type, and entity type. |
at_list_udf_list_items |
Free | Read-only | [Autotask] List picklist items for user-defined fields. Returns item details including value, label, and sort order. |
at_update_udf_definition |
Pro | Write | [Autotask] Update an existing user-defined field definition. Returns the updated UDF. |
at_create_udf_definition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the UDF definition to create. |
at_list_deleted_task_activity_logs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_deleted_ticket_activity_logs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_deleted_ticket_logs parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_integration_vendor_insights parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_integration_vendor_widgets parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_notification_history parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_udf_definitions parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_udf_list_items parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_udf_definition parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object with fields to update. | |
udfId |
integer | yes | The Autotask UDF definition ID to update. |
Expense Extended
| Tool | Plan | Access | Description |
|---|---|---|---|
at_create_expense_item |
Pro | Write | [Autotask] Create a new expense item. Returns the created expense item with its assigned ID. |
at_list_expense_item_attachments |
Free | Read-only | [Autotask] List attachments associated with expense items. Useful for reviewing receipts on line items. |
at_list_expense_report_attachments |
Free | Read-only | [Autotask] List attachments associated with expense reports. Useful for reviewing receipts. |
at_update_expense_item |
Pro | Write | [Autotask] Update an existing expense item. Returns the updated expense item. |
at_create_expense_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
fieldsJson |
string | yes | JSON object for the expense item to create. |
at_list_expense_item_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_list_expense_report_attachments parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
filterJson |
string | no | null | JSON array of filter objects. Omit for no filtering. |
maxRecords |
integer | no | 500 | Maximum number of records to return (default 500, max 500). |
nextPageUrl |
string | no | null | Pagination cursor. To fetch the next page, pass the pageDetails.nextPageUrl value from the previous response verbatim (unmodified). Omit for the first page. When supplied, also repeat the same filter/search arguments you used on the first request; the page size is fixed by the cursor (maxRecords is ignored). |
at_update_expense_item parameters
| Param | Type | Required | Default | Description |
|---|---|---|---|---|
expenseItemId |
integer | yes | The Autotask expense item ID to update. | |
fieldsJson |
string | yes | JSON object with fields to update. |